aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
AgeCommit message (Collapse)Author
2014-08-02dev-manual: Miscellaneous fixes in the newbie chapter.Robert P. J. Day
(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-02dev-manual: Created new chapter on QEMU.Scott Rifenbark
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-02dev-manual: Added support for new QEMU chapter.Scott Rifenbark
(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-02dev-manual: Modified how to find checksums in the recipesScott Rifenbark
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-02dev-manual: Applied review edits to the 'wic' section.Scott Rifenbark
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-02dev-manual: Fixed up the list of other references.Scott Rifenbark
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-02dev-manual: Replaced "--" with &dash;&dash; throughout.Scott Rifenbark
(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-02dev-manual: Miscellaneous wic edits.Tom Zanussi
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-02dev-manual: Miscellaneous updates from the wic help text.Tom Zanussi
(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-02dev-manual: Added --fsoptions to wicTom Zanussi
--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-02dev-manual: squashfs support added to wic section.Tom Zanussi
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-02dev-manual: Created new "Plugins" section in the wic section.Tom Zanussi
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-02dev-manual: Updates to the creating partitioned images section.Scott Rifenbark
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-02dev-manual: Added note and fixed a grammar spot.Robert P. J. Day
(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-02dev-manual: Patch to fix some links and references.Robert P. J. Day
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-02dev-manual: Updated example "foo" recipe name used in examples.Scott Rifenbark
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-07-23dev-manual: Added the section on "Creating Partitioned Images"Scott Rifenbark
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-21dev-manual: Removed not to the PTEST_ENABLED variable.Scott Rifenbark
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-03ref-manual, dev-manual: Updates to support PTEST_ENABLED.Scott Rifenbark
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-03dev-manual: Fixed a couple typos in the Template section.Scott Rifenbark
(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-03documentation: Added permalink display styles to CSS files.Scott Rifenbark
Fixes [YOCTO #5772] Updated each manual's CSS style sheet to contain a style for how the permalink symbol looks on its own and how it looks when a user hovers over it with the mouse. (From yocto-docs rev: c8d4afa0b83a40ac2de0c47c191a11b3e7d241e5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-07-03dev-manual: Fixed a mult-line <ulink> cross-referenceScott Rifenbark
These types of references cannot span multiple lines. If they do then mega-manual.sed will not process the link in the mega-manual.html file. (From yocto-docs rev: 8a06542c0f1fee503eda12052adddaaf9c94ca91) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual, yocto-project-qs: New section on working with source files.Scott Rifenbark
Fixes [YOCTO #5566] For the dev-manual, I created a new section called "Working with Source Files." In the section, I cover how to set up mirrors and also how to pre-fetch source using the bitbake -c fetchall <target> command. For the yocto-project-qs, I removed the mirror information in the "Super User" section, which became redundant with the new section now in the dev-manual. I also, removed the fetchall variation of the bitbake command. Both areas reference into the new section of the dev-manual now. (From yocto-docs rev: f314061e3e752d35ea85ed16a60f7f9292180921) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Edits to "Creating a Custom Template Configuration Directory"Scott Rifenbark
Fixes [YOCTO #5895] Some minor edits to the section. I found a grammar error and a mis-wording. (From yocto-docs rev: 86e85512279a1379d9b30825d6af3e508faa320a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual, kernel-dev: Provides some cross-reference to "clean" stuff.Scott Rifenbark
I scrubbed the manual set for appropriate places to reference into the do_clean* type tasks. Found and added several occurrences. (From yocto-docs rev: 01594823b1d556bc70e928af1838039cc15a816d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18documentation: Updated style sheets to remove unused .PNG files.Scott Rifenbark
Fixes [YOCTO #6430] The style sheets were carrying over old .PNG files that are not part of the manuals. I have removed the statements that were using them. (From yocto-docs rev: 6e4fa419b9367ab5e34b9aa8010a24980416dc7d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Small edit to locating the race failure.Scott Rifenbark
Failure occurs during make, not do_compile as I previously noted. (From yocto-docs rev: 467ea8aa43fac14e3092a30ae15d1ace7a6558ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Second draft of make race section.Scott Rifenbark
Fixes [YOCTO #6390] Edits to the "Debugging Parallel Make Races" section. Changes originating from trying the procedure. (From yocto-docs rev: 537f5bd8918450e30ea87465025f0069232cb229) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: First draft of new section on debugging race conditions.Scott Rifenbark
Fixes [YOCTO #6390] This is a section on parallel make race situations. The draft is the first cut at the section. (From yocto-docs rev: c225d7fe121270a6f82b9fbffa78c7e3914b113d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual, kernel-dev, ref-manual: Updated task name usage.Scott Rifenbark
There was inconsistency on how we refer to a task name throughout the YP manual set. The proper way is "do_<taskname>". Some occurrences did not include the "do_" prefix. These have been fixed. (From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Added XSL templates to support permalinks.Scott Rifenbark
Fixes [YOCTO #5772] (From yocto-docs rev: 54f7fab50c8ddf9b4ee233610b8fab5b9776e419) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Edit to "Package Archtiture" section.Scott Rifenbark
Added a bit more to the ending of the sentence to qualify its meaning. (From yocto-docs rev: 40b309a43d948d5800cfe908e72f6202c095a166) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Edits to "Writing a New Recipe"Scott Rifenbark
Received and implemented some feedback from Paul Eggleton on this section. These were unsolicited observations. Reported-by: Paul Eggleton <paul.eggleton@intel.com> (From yocto-docs rev: 48ecc543d9f614b5258ab2573f0406aa3c778647) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Edits to "Creating a Custom Template Configuration Directory"Scott Rifenbark
Fixes [YOCTO #5895] I applied some review comments from Paul to tighten up this section. (From yocto-docs rev: 9f17ad00e9e707fcd6f2419762b4281d64f4ed0f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Edits to the "Understanding Recipe Syntax" section.Scott Rifenbark
Added a new "Overrides" bullet item and fixed some minor issues pointed out by Paul Eggleton. (From yocto-docs rev: 44ff3d82985fa304c5641570fe72cf6a8ddabaa3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Updates to the "Understanding Recipe Syntax" section.Scott Rifenbark
Paul Eggleton sent me some feedback on this section. I implemented his suggestions. Changes were minor. One included a cross-link to the BitBake User Manual. (From yocto-docs rev: e9b5f252a1368b8c231dd659428a18eacf9757af) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18ref-manual, dev-manual: Updates for custom template configuration directory.Scott Rifenbark
Fixes [YOCTO #5895] I created a new section in the dev-manual titles "Creating a Custom Template Configuration Directory" that describes how the build system uses the template local.conf and bblayers.conf and conf-notes.txt files as a basis when creating the real deals in the build directory's conf folder. The context of this is so that the user can create their own directory with their own template files for repeated configurations and to create a custom conf-notes.txt file should they want the setup scripts to display some custom list of targets. I also modified the two script references in the ref-manual for oe-init-build-env and oe-init-build-env-memres. I needed to link to the "how-to" section and added a bit in there about how the scripts go about forming the conf files in the build directory. (From yocto-docs rev: c07fb7082fe08387bbc546b2a23620dedc7127b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Added reference to QA checks in the "Packaging" section.Scott Rifenbark
The "Writing a New Recipe" section has a subsection named "Packaging." We needed a cross-reference here to the QA checks performed for packaging. (From yocto-docs rev: 34952ee1b56a84e0ee0edd142c7c8c68b122a3e3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-06-18dev-manual: Edits to the "Making Images More Secure" section.Scott Rifenbark
Fixes [YOCTO #5482] I applied some review edits as directed by Paul Eggleton. The main feature was to merge the information on setting root and extra user's passwords. Also, permanently removed the reference to the wiki that showed the less optimal way of setting a root password. (From yocto-docs rev: fef0e17cd3835580abed175ef4a7baf22b9b7673) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30dev-manual: Updates to the "Making Images More Secure" section.Scott Rifenbark
Fixes [YOCTO #5482] Applied extensive review edist from Paul Eggleton throughout this section. (From yocto-docs rev: aa0bcd9199c83b43bad2390ff2292a8c2abe7455) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30ref-manual: Edits to the "Making Images More Secure" section.Scott Rifenbark
Fixes [YOCTO #5482] I added some key references to the section on considerations specific to the OpenEmbedded build system. In particular, I provided some cross-linking back to the extrausers.bbclass section to reference an example of adding a user account. I also split out the topics of adding an extra user and setting a password on the image in the bulleted list. (From yocto-docs rev: 19dcd70b9b5aba1bd5e7ce090d5449afcef726bf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-30dev-manual: Updated the "Making Images More Secure" section.Scott Rifenbark
Fixes [YOCTO #5482] I did some significant re-writing and re-organization of this section. It now includes a bit about securing an image in general, provides general considerations, considerations specific to the OpenEmbedded build system, pointers to some tools in meta-security layer, and some other items. (From yocto-docs rev: a900286992e781f451b3c180726965f5c7172bb9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13dev-manual: Added links to new do_* sections.Scott Rifenbark
With the creation of the new chapter that documents the 51 tasks defined by the OpenEmbedded build system, the dev-manual had many first-instance occurrences of do_* task names that could be cross-referenced to the new sections. I have added these links. (From yocto-docs rev: 78f91987b0ad9906571ec7888334301492361822) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13dev-manual: Edits to the "Understanding Recipe Syntax" section.Scott Rifenbark
(From yocto-docs rev: 97e5025ccff55efd077fdaf9b2d65eae5b59bc2b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13dev-manual: Edits to the "Understanding Recipe Syntax" section.Scott Rifenbark
(From yocto-docs rev: 9808ea79a1e219df794948bd42bc086ab4d56d9f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13dev-manual: Added new "Understanding Recipe Syntax" section.Scott Rifenbark
(From yocto-docs rev: d637ba317b22de50e25750e6031defcb707b36e5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13dev-manual: Added "Properly Versioning Pre-Release Recipes" section.Scott Rifenbark
Fixes [YOCTO #6243] This section addresses situations when working with recipe file names of recipes that have not been released (e.g. recipe-name_1.0.3.rc1). When the recipe is released the system has difficulty recognizing the new recipe name as a later version. So the work-around is to use PV to set the recipe version in the recipe. The section describes this. (From yocto-docs rev: 612379f44e772cfc381e31171ae18af24a9e44fe) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-05-13documentation: Updated the manual revision history tables for 1.7Scott Rifenbark
(From yocto-docs rev: 9014fe95b9607a15c0e72ef1b6df14f250a3d241) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21dev-manual: Fixed some "systemd" capitalization issues.Scott Rifenbark
I was using this term inconsistently. I have cleaned it up so that no initial capital is used. (From yocto-docs rev: 7dea2c5ef067d81b8350cd54ba4082c35d7077b1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-04-21documentation: Updated all the manual revision history tables.Scott Rifenbark
Set the release date to April 2014. (From yocto-docs rev: 2592bc968edeea941a92e6bdd321dd872745b78c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>