Commit Graph

3275 Commits

Author SHA1 Message Date
Scott Rifenbark 4a226369b7 dev-manual: Updates for checksums and wic
Accidentally put in a couple different things in this one commit.
Oh well.

1. New wording for how the user needs to figure out some checksums
   for a recipe.

2. Fixed up some note placement in the wic reference section.

(From yocto-docs rev: 6c13f49c265c99ddd6dcd4ec3c3c8e66b78824e0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Robert P. J. Day d283686dc3 dev-manual: Minor fixes.
(From yocto-docs rev: 71c9e378c86d03e5fb7f4e459e677ad8a9965f52)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark e7dae57a98 ref-manual: Added two new FAQ entries.
One has to do with the weird names the build system creates based
on DESTDIR and other variables.

The other has to do with -native recipes not buiding correctly.

(From yocto-docs rev: 32a444a258e3c7c87fdc015475f54e5b34628246)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark 152d307767 dev-manual: Updated manual overview to include new QEMU chapter
Fixes [YOCTO #641]

Added a new bullet to the list that overviews what the manual
covers.

(From yocto-docs rev: 54bdb50df3951346a2e926700681db55bd59a2e1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark fb4649297b dev-manual: Edits to the wic reference section.
Pulled a note about future support of commands and options from
the bootloader section and got it up in the higher level intro
section for that part of the manual.

(From yocto-docs rev: f8d677301abcd0d549ea9ad4cca79f43cb2db7f0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Robert P. J. Day f937e05b44 dev-manual: Miscellaneous fixes in the newbie chapter.
(From yocto-docs rev: 34d6bd814e813591631b336f6247c300381fd309)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark 3152e69383 dev-manual: Created new chapter on QEMU.
Fixes [YOCTO #641]

New chapter added that covers the YP instance of QEMU.

(From yocto-docs rev: 7ca17d02364af7e5924e23df6c138ab4dd2203d6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:26 +01:00
Scott Rifenbark 5f31e281ec dev-manual: Added support for new QEMU chapter.
(From yocto-docs rev: d8a852e244f1c0f4d5ef33f50844bb1cb479cb92)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark 25d7b0df2a dev-manual: Modified how to find checksums in the recipes
The section on wrting a new recipe suggested using a "build-fail"
method to get bitbake to return exact checksums for code.  It
was pointed out that this could be a middle-security risk and
that we should not do that but instead get the signatures from
the upstream website.  However, many times those sites don't
provide that information.  I re-worded the text to note the
ideal method (upstream checksums) and then resorted to the
"build-fail" method as a "way" to also get them when the upstream
location does not have them.

(From yocto-docs rev: b06699de2f512b01600bf952a8ee928c2a4c358a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark 3be4af9cf3 dev-manual: Applied review edits to the 'wic' section.
I made some small edits to the section based on Tom Zanussi's
review.

(From yocto-docs rev: 560ea7b0eb131e59b190a34cadbe77729e76d61c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark 73abcb0b16 dev-manual: Fixed up the list of other references.
There was a bogus link in there to the Build Appliance page.
I also noted many links that use the <ulink> tag that crossed
multiple lines.  That is not good.  I cleaned all that up.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: a39cea47cae29d7efb8e12495e8eefb484d464c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Scott Rifenbark 231fde5b16 dev-manual: Replaced "--" with &dash;&dash; throughout.
(From yocto-docs rev: 79fb4973909ff3a2ba5da8cad8c3d7bdb4206003)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi 7ef076cd9e dev-manual: Miscellaneous wic edits.
This is a set of fixes for miscellaneous dev-manual updates noticed
while transcribing wic help for the dev manual.

(From yocto-docs rev: fd2205e2778e2cef86561025fd904f303d64586a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi e0aa8f04e9 dev-manual: Miscellaneous updates from the wic help text.
(From yocto-docs rev: 99b04623aa47d07970f91e2bdf648f25ab54c59b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi b8a836c0c9 dev-manual: Added --fsoptions to wic
--fsoptions support was recently added to wic, so document it.

(From yocto-docs rev: 91efb698eea438083474c1e905dbaad3fffdbd81)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi 537e965cc7 dev-manual: squashfs support added to wic section.
squashfs support was recently added to wic, so document it.

(From yocto-docs rev: 22ca1141953b4fae92e15126da296d3d95e80c25)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:25 +01:00
Tom Zanussi 2a11e9d294 dev-manual: Created new "Plugins" section in the wic section.
Add a new section discussing plugins, taken directly from the
corresponding wic help section.

(From yocto-docs rev: c1b4c378a496413f2dde8ad2f043a537cba24b6e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark 1a825210d8 dev-manual: Updates to the creating partitioned images section.
Fixes [YOCTO #6511]

Added a new example to this section that shows how to package
up binaries so that you can add them to an image.

(From yocto-docs rev: e52acc444c8f142d0469d7274fb936b5242306ec)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Robert P. J. Day 4560e2fc92 dev-manual: Added note and fixed a grammar spot.
(From yocto-docs rev: 934dbe2faff2a553bf281d55edcd6b8de9c31c06)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Robert P. J. Day b1a9074744 dev-manual: Patch to fix some links and references.
Add in a few links to member orgs, and update the BitBake link.

(From yocto-docs rev: 481c89e9b8e219358db8bfdfff0b5b0150247c07)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark 6ebbf038ab dev-manual: Updated example "foo" recipe name used in examples.
The recipe should be named "foo_1.3.0.bb" instead of
"foo_1.3.0-r0.bb".

(From yocto-docs rev: c34c3ea05d550fc85ab04036856704a7c04fd64c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-08-02 10:00:24 +01:00
Scott Rifenbark 686037ce16 ref-manual: Updated note in the "CentOS Packages" section.
We want to encourage installation of the buildtools tarball for
getting the most up-to-date packages on this build host.

(From yocto-docs rev: 5298737a5ad579ea5097221d2ef5a0f388ebff6c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-25 09:18:17 +01:00
Scott Rifenbark 5ba68f32a8 dev-manual: Added the section on "Creating Partitioned Images"
This is the section on 'wic'.  I have dropped in the same exact
section from the 1.5.3 (dora branch) release as a starting point
for Tom Zanussi to scrub and update for the master branch.

(From yocto-docs rev: e189992bff4249664ba959b1c440541e0b84e03d)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23 10:02:13 +01:00
Scott Rifenbark b72dc514a5 ref-manual: Provided canonical GP license names.
Fixes [YOCTO #6499]

Fixed a couple example INCOMPATIBLE_LICENSE examples so that
they now use the canonical licensing names GPL-3.0 LGPL-3.0 AGPL-3.0.

(From yocto-docs rev: d2d6be323d1a5ed9da88b7924954f9733a78da84)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23 10:02:13 +01:00
Robert P. J. Day 2dec5d573d ref-manual: Replace a couple old references to "task-*"
Replaced with packagegroup names, the newer form.

(From yocto-docs rev: 5492b0669acc9ce8a8ee1a00dfdc7e9f2b98a5c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23 10:02:13 +01:00
Robert P. J. Day d77c4cb9f5 kernel-dev: Fixed a wording typo.
(From yocto-docs rev: 204f48ae38d1504bcc560a5c611d09ac90f42c46)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-23 10:02:13 +01:00
Robert P. J. Day ba3f9900ce kernel-dev: Fixed typo
(From yocto-docs rev: 3d7c0c814de076680ef7fdb42193f39b9947ae48)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Robert P. J. Day ca4e42ad28 kernel-dev: Fixed link to BitBake command:
Reported-by: Bill Traynor <btraynor@gmail.com>
(From yocto-docs rev: 4bce72419c01e0c77969a56eb194ad7179b7ad80)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Scott Rifenbark 6aeed29a51 ref-manual: Updated some glossary variables:
* INITSCRIPT_PARAMS - noted the default
 * INITRD_IMAGE - added a reference into the image-live class.

(From yocto-docs rev: 152cb93ca591c46a1344f2f09e0f85f14519ddf3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Scott Rifenbark ed3cd02d4c dev-manual: Removed not to the PTEST_ENABLED variable.
The note did not need to be there.

(From yocto-docs rev: 5ff94a1a412447c1ed1cda64e985b52545ccd9e7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Scott Rifenbark 93ad63c102 ref-manual: renamed "do_package_write" to "do_package_write_*"
I found an occurrence where we were refering to the removed
task do_package_write.  I changed it to "do_package_write_*"

(From yocto-docs rev: 4e989f2df1cf74c81ba9d02088addb79012762a7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Scott Rifenbark 8e280b4a08 yocto-project-qs: Updated the note on working with proxies.
Reported-by: Douglas Boom <douglas.boom>
(From yocto-docs rev: ef88ce82409dd1d8627657f1d0a6ab2425461071)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:53 +01:00
Scott Rifenbark ab3e880f15 ref-manual: Fixed grammar problem in FILES variable description.
(From yocto-docs rev: faf5bc08e3f015dfb610ebdb73a0747793451033)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:52 +01:00
Scott Rifenbark 1b7c45eaec ref-manual: Modified licensing verbiage for GPLv3
Fixes [YOCTO #6499]

Updated three areas to include similarly licenced components
regarding the use of non-GPLv3 licensing.

(From yocto-docs rev: 88c0720e4070be58fbde17bc04db2b53c3307bf8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:52 +01:00
Scott Rifenbark 4767787613 ref-manuala: Updates to support links to BB manual
Discovered that the sed file was processing the bitbake-user-manual
just like the others, which was wrong. the BB manual is not included
in the mega-manual so the links there need to be left alone. The fix
included specially creating substitution lines to handle all the YP
docs while excluding the BB manual.

(From yocto-docs rev: f2c99c6a66c3f67ab226f317dfae195294ddafea)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:52 +01:00
Scott Rifenbark 1fc9548dc1 ref-manual, yocto-project-qs: Fixed some references to BitBake Manual.
Fixed a reference that was not linking to the manual but
was instead referencing the Source Directory structure.

(From yocto-docs rev: aae3fb868e95ef2dbd548a5f9d1ea61a013190cd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>

Conflicts:

	documentation/ref-manual/ref-variables.xml

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-21 19:06:52 +01:00
Maxin B. John c8391d0a7a ref-manual, yocto-project-qs: Fixed required Git to 1.7.8+
(From yocto-docs rev: ca86bbd8c4d9be44cbc11f579d0720aaf30cbc6c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:12 +01:00
Scott Rifenbark d321a503bc template: Added new line at end of file so vi does not throw error.
(From yocto-docs rev: 2b8cd1b912ea4a1725b9060be712828b6c3d2a36)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:12 +01:00
Scott Rifenbark 5bdb231ad8 templates: Added new line to avoid vi save warning.
(From yocto-docs rev: dd24fa4e254a9ee4f76c78e2cc525a752195bbdb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:11 +01:00
Scott Rifenbark 8c2648286a ref-manual: Added USE_VT variable description.
(From yocto-docs rev: c56cea783f87932de7ba6c02a1256f1303298f48)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:11 +01:00
Scott Rifenbark 9329d7c5ee ref-manual: Added SYSVINIT_ENABLED_GETTYS variable description.
(From yocto-docs rev: 25d3b63cbb845e95ea309e4247d19366df7400ba)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:11 +01:00
Scott Rifenbark cc8c7daa62 ref-manual: Added the INITRD_IMAGE variable description.
(From yocto-docs rev: cb74809cbbe6ce8696b31fd1b154bfcb2cb68a26)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:11 +01:00
Scott Rifenbark 8d0d487a12 ref-manual, bsp-guide: Added cross-references for two variables.
Added several cross-link references for the LICENSE_FLAGS and
LICENSE_FLAGS_WHITELIST variables.  Note that the cross-references
previously put in for LICENSE_FLAGS were slightly wrong as they
were using the <ulink> tag instead of the <link> tag.

(From yocto-docs rev: dc2769c63d24d3650c993cfd48bcb4540ad36ca2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:11 +01:00
Scott Rifenbark 980ad4ed0c ref-manual: Added the LICENSE_FLAGS_WHITELIST glossary description.
(From yocto-docs rev: 3fc3583d24b43bfd2a8cda0c6d2b1468e7a16c36)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:11 +01:00
Scott Rifenbark 68bd063fb9 ref-manual, bsp-guide: Added several cross-references to LICENSE_FLAGS.
Needed to add several links to the newly described
LICENSE_FLAGS variable in the glossary.  Three links added to the
ref-manual and a single link added to the BSP Guide.

(From yocto-docs rev: 2ca6e556c299814d6ef847ed059a4f0a2d48adb3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:11 +01:00
Scott Rifenbark a53950ad2c ref-manual: Added the LICENSE_FLAGS variable description.
(From yocto-docs rev: dfe4bb2268a2b79571ea03d44684de31ed25cc66)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:11 +01:00
Scott Rifenbark 08d68e5bc8 ref-manual, dev-manual: Updates to support PTEST_ENABLED.
In the ref-manual, I added a new variable description for the
PTEST_ENABLED variable.

In the dev-manual, I added a note to the "Adding ptest to Your
Build" section to mention that the OpenEmbedded system uses
PTEST_ENABLED to enable or disable building ptests and that
the user does not set this variable directly.

(From yocto-docs rev: 52d6608caaa25378b873e41e1ddd05356ff8629a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:10 +01:00
Scott Rifenbark 2284771b52 ref-manual: Edits to INITSCRIPT_PARAMS variable.
Added a bit about values being passed through the
update-rc.d command and then a reference to the command's
page.

(From yocto-docs rev: e007414608ed801e440b701d6c43dca955a11611)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:10 +01:00
Scott Rifenbark 11bf70bba1 dev-manual: Fixed a couple typos in the Template section.
(From yocto-docs rev: 9285eee037022ed29a0bdc2c9ecc628c63b47e2b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:10 +01:00
Scott Rifenbark c74284d5d9 ref-manual: Some minor fixes to the QA Checks chapter.
* For "Architecture did not match" and "Bit size did not
  match", added the missing QA check name marker [arch]

* Under the already-stripped entry, added a final sentence
  (to the paragraph before the note box)

(From yocto-docs rev: 7c3bda03a4424d1e083403266c570b34fcab9bbf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03 13:57:10 +01:00