summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.xml
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: Updates to using IMAGE_FEATURES and EXTRA_IMAGE_FEATURESScott Rifenbark2015-02-171-2/+11
| | | | | | | | | | | | | | | The section "Customizing Images Using Custom IMAGE_FEATURES and EXTRA_IMAGE_FEATURES" needed a bit more clarification on the image features. The text pretty much passed off image features as all mapping into package groups, which is not true. Some, like "debug-tweaks for example, are more like general configurations. I updated the section accordingly. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 7dd55ff0bd6f7923e22695ed7323df5cfe17d1d4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Rewrite of the section on customizing images with packagegroupsScott Rifenbark2015-02-171-12/+27
| | | | | | | | | | | | This section was pointing to a poor example in meta. I substituted in a better example and rewrote the section to flow better around that example and the final fabricated one. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: c7f07a2993d5c1b8e0c8b7da0e9d4c28242a5e26) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Add ref to bitbake-layers "add-layer" and "remove-layer"Robert P. J. Day2015-02-171-0/+6
| | | | | | | (From yocto-docs rev: aafc8f1da396a1838ce541706a8162a1493382b3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added missing ending quotation to code snippet.Pascal Bach2015-02-171-1/+1
| | | | | | | (From yocto-docs rev: 7bf228dbf54e227a06dc69d701b9c83f9c6a2f3a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added link to ptest wiki page into Ptest section.Scott Rifenbark2014-12-091-5/+11
| | | | | | | (From yocto-docs rev: 2a9cd5948cd17ce9f7eb5381b27c25f97963578e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added more info to mulit-machine builds section.Scott Rifenbark2014-12-091-5/+17
| | | | | | | | | | | | | Fixes [YOCTO #5400] Per Martin Jansa, added some information in the bullet item that talks about the tools and the cases that can cause issues when tuning things by machine or architecture. (From yocto-docs rev: e8e47828df65abdc18bbd681c47719a7df77b00f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to the multi-machine builds section.Scott Rifenbark2014-12-091-12/+12
| | | | | | | | | | | | Fixes [YOCTO #5400] I applied some review edits to this section as suggested by Richard Purdie. (From yocto-docs rev: a1898cf65537e732e0e42605bb28d636077e7f56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: First draft of "multi-builds" section.Scott Rifenbark2014-12-091-0/+174
| | | | | | | | | | | Fixes [YOCTO #5400] This is the first draft of a new section on multi-machine builds. (From yocto-docs rev: a47fd17295d943bff482a0747f3b2e69831aa985) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken link to the allarch class.Scott Rifenbark2014-11-081-1/+1
| | | | | | | (From yocto-docs rev: 3ec771dffdaf7d42b98371516bbb33f915dfe572) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to "Performing Automated Runtime Testing"Scott Rifenbark2014-10-281-4/+103
| | | | | | | | | | | Updated the section to account for some new variables and several more ways to run tests against expanded targets. Also added power control section. (From yocto-docs rev: a0f08466c00ae51a99d790fa6c9dccef2e0f1518) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added reference to the meta-selinux layer.Scott Rifenbark2014-09-231-0/+3
| | | | | | | | | | | | Fixes [YOCTO #5482] Added a cross-reference to the meta-selinux layer in the section that describes how to make images more secure. (From yocto-docs rev: 0c96273ee857808046c5a76517c1eda4aa703c81) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added a note to the EXTERNALSRC example about the classScott Rifenbark2014-09-221-0/+6
| | | | | | | | | | | Added a short note after the example that shows how to set up the EXTERNALSRC variables stating that the externalsrc class needs to be either globally or locally inherited. (From yocto-docs rev: db935135c0b060e06f6a63530df995d286002598) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed typo in the make races section header.Scott Rifenbark2014-09-221-1/+1
| | | | | | | (From yocto-docs rev: 26ffb2e47f3caa8a0ab0f2a9cd83af8cdf893cfd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added a second EXTERNALSRC example.Scott Rifenbark2014-09-221-0/+10
| | | | | | | | | | Added a new example on how to set this from the recipe or the recipe's bbappend file. (From yocto-docs rev: bc0d9de3378f3462729301e74419b7dede17558b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated another EXTERNALSRC example.Scott Rifenbark2014-09-221-1/+1
| | | | | | | | | | Found another occurrance of where I needed to add a <replaceable> tag set in an example. (From yocto-docs rev: 586e5a590bb5382a28fde4670fdcd6cbb75f6c32) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated EXTERNALSRC example for user-input formatting.Scott Rifenbark2014-09-221-1/+1
| | | | | | | | | | I missed a <replaceable> tag set on the example. Adding it clears up confusion for how to use the variable. (From yocto-docs rev: 8bbf2a012e580d82aaf9c9a98ad5dab1aea64f7b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: General edits to "Common Tasks" chapter.Scott Rifenbark2014-09-221-152/+182
| | | | | | | | | | | | * Found and fixed several areas with issues. * Scrubbed for user-supplied input to make it use the <replaceable></replaceable> tags. (From yocto-docs rev: 0e1c7ad31921ee7d4ee0d7d4ece01303a25a5d60) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review edits for GDB without sourceScott Rifenbark2014-09-221-2/+12
| | | | | | | | | | | Fixes [YOCTO #6621] Applied a few review edits for this fix. (From yocto-docs rev: 99511bbcfa1de2f7bf691da1a002913f3a7f6034) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated section on launching remote GDB.Scott Rifenbark2014-08-121-2/+2
| | | | | | | | | | | | | Fixes [YOCTO #6620] I altered the path name of the .gdbinit file in the text to prepend ~/ to it to reinforce what file the user must modify. I also removed the /home/jzhang string in favor of ~ to make it more general. (From yocto-docs rev: ff09d3a5666c97598adf385f63dee4b30b0f1792) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Minor edits to the section to add binaries to an image.Scott Rifenbark2014-08-121-1/+5
| | | | | | | | | Review edits from Paul. (From yocto-docs rev: 088410d607418531d6ab8a40fdc9d77495b132c9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review edits to how to find checksum values.Scott Rifenbark2014-08-121-16/+17
| | | | | | | | | Edits from Paul to better word this section. (From yocto-docs rev: 51425ab506050ee5ba30d5c3c10639d5a1b8cc8e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Minor edits via patch to "common tasks" chapter.Robert P. J. Day2014-08-121-10/+14
| | | | | | | (From yocto-docs rev: b1516fb6e6d40e7668ca5a4d5804d1a09c7ed6f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Technical and text edits applied as patch.Robert P. J. Day2014-08-121-25/+33
| | | | | | | (From yocto-docs rev: 703cbe5c037334b3fbf08123b7cc501d36e1e8f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Edits to several examples and some typos.Robert P. J. Day2014-08-121-32/+36
| | | | | | | | | | These catches are from Robert P. J. Day and applied as a patch. (From yocto-docs rev: b805795e9bf68286aa5b79a94792e2fefd293b92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manaul: Small edits to various examples.Robert P. J. Day2014-08-121-4/+11
| | | | | | | (From yocto-docs rev: 6ef54d31664b097b8ceeb5da1b8c48cdc6f673a3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates for checksums and wicScott Rifenbark2014-08-021-18/+29
| | | | | | | | | | | | | | | 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>
* dev-manual: Edits to the wic reference section.Scott Rifenbark2014-08-021-15/+14
| | | | | | | | | | | 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>
* dev-manual: Modified how to find checksums in the recipesScott Rifenbark2014-08-021-1/+6
| | | | | | | | | | | | | | | | | 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>
* dev-manual: Applied review edits to the 'wic' section.Scott Rifenbark2014-08-021-8/+9
| | | | | | | | | | 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>
* dev-manual: Replaced "--" with &dash;&dash; throughout.Scott Rifenbark2014-08-021-51/+51
| | | | | | | (From yocto-docs rev: 79fb4973909ff3a2ba5da8cad8c3d7bdb4206003) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Miscellaneous wic edits.Tom Zanussi2014-08-021-35/+44
| | | | | | | | | | 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>
* dev-manual: Miscellaneous updates from the wic help text.Tom Zanussi2014-08-021-57/+95
| | | | | | | (From yocto-docs rev: 99b04623aa47d07970f91e2bdf648f25ab54c59b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added --fsoptions to wicTom Zanussi2014-08-021-0/+10
| | | | | | | | | --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>
* dev-manual: squashfs support added to wic section.Tom Zanussi2014-08-021-0/+2
| | | | | | | | | 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>
* dev-manual: Created new "Plugins" section in the wic section.Tom Zanussi2014-08-021-0/+153
| | | | | | | | | | 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>
* dev-manual: Updates to the creating partitioned images section.Scott Rifenbark2014-08-021-0/+91
| | | | | | | | | | | | 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>
* dev-manual: Updated example "foo" recipe name used in examples.Scott Rifenbark2014-08-021-1/+1
| | | | | | | | | | 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>
* dev-manual: Added the section on "Creating Partitioned Images"Scott Rifenbark2014-07-231-0/+726
| | | | | | | | | | | 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>
* dev-manual: Removed not to the PTEST_ENABLED variable.Scott Rifenbark2014-07-211-10/+0
| | | | | | | | | 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>
* ref-manual, dev-manual: Updates to support PTEST_ENABLED.Scott Rifenbark2014-07-031-0/+10
| | | | | | | | | | | | | | | 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>
* dev-manual: Fixed a couple typos in the Template section.Scott Rifenbark2014-07-031-2/+2
| | | | | | | (From yocto-docs rev: 9285eee037022ed29a0bdc2c9ecc628c63b47e2b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, yocto-project-qs: New section on working with source files.Scott Rifenbark2014-06-181-0/+97
| | | | | | | | | | | | | | | | | | | | 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>
* dev-manual: Edits to "Creating a Custom Template Configuration Directory"Scott Rifenbark2014-06-181-3/+3
| | | | | | | | | | | | 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>
* dev-manual, kernel-dev: Provides some cross-reference to "clean" stuff.Scott Rifenbark2014-06-181-8/+21
| | | | | | | | | | 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>
* dev-manual: Small edit to locating the race failure.Scott Rifenbark2014-06-181-3/+1
| | | | | | | | | | 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>
* dev-manual: Second draft of make race section.Scott Rifenbark2014-06-181-10/+45
| | | | | | | | | | | | 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>
* dev-manual: First draft of new section on debugging race conditions.Scott Rifenbark2014-06-181-0/+241
| | | | | | | | | | | | 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>
* dev-manual, kernel-dev, ref-manual: Updated task name usage.Scott Rifenbark2014-06-181-29/+50
| | | | | | | | | | | | 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>
* dev-manual: Edit to "Package Archtiture" section.Scott Rifenbark2014-06-181-2/+5
| | | | | | | | | | 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>
* dev-manual: Edits to "Writing a New Recipe"Scott Rifenbark2014-06-181-59/+127
| | | | | | | | | | | 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>