summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual-common-tasks.xml
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: Clean up for "Replicating Build Offline"Scott Rifenbark2019-03-191-15/+27
| | | | | | | | | | Some final corrections for the section on how to replicate a build offline. (From yocto-docs rev: 3b4ffa131684f824b7bc6c37ddfd02bb9b17b08c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added note about AUTOREV for replicating buildScott Rifenbark2019-03-191-3/+56
| | | | | | | | | Feedback from Paul. (From yocto-docs rev: ea118a9d6fa671de10b9aa8413c7d29951593ec3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to "Replicating Your Build Offline"Scott Rifenbark2019-03-191-10/+28
| | | | | | | | | | | I updated the section with some feedback from Richard. This version is much clearer and brings the concepts out a lot better. (From yocto-docs rev: 9790482b9937308bee6aa00a892f50d026187342) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added section on offline "snapshot" build.Scott Rifenbark2019-03-191-1/+89
| | | | | | | | | | | | | This is a new section in the tasks chapter of the dev-manual titled "Replicating a Build Offline". It is in response to multiple hits in the yocto@yoctoproject.org list asking how to do something like this. (From yocto-docs rev: 61b091be49517548e639808f6b6de4bf07e2a300) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Remove True option to getVar callsAndré Draszik2019-01-161-6/+6
| | | | | | | | | | | | | | | | | | | | | getVar() has been defaulting to expanding by default for a long time (2016), thus remove the True option from getVar() examples with a regex search and replace. Search & replace made using the following command: sed -e 's|\(d\.getVar \?\)( \?\([^,()]*\), \?True)|\1(\2)|g' \ -i $(git grep -E 'getVar ?\( ?([^,()]*), ?True\)' \ | cut -d':' -f1 \ | sort -u) Note that there are are several other examples of getVar() usage which already don't explicitly add the True option, this patch just align some stray remainders. (From yocto-docs rev: 9824280085c4164c614c5ef2bc1e69ffac1732dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Post-Installation Scripts" section.Scott Rifenbark2018-11-221-23/+15
| | | | | | | | | | Added a better, more up-to-date description of the way to defer a post-installation script past the boot. (From yocto-docs rev: 1bcec14eed720fd05e81fbe7ecaa2f95174c0fbf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed occurrence of mkefidisk.sh script.Scott Rifenbark2018-11-221-7/+6
| | | | | | | | | Script has been removed. (From yocto-docs rev: c23de8eb2648f98864579e857a1de0b2ed74532a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Removed TEST_IMAGE for TESTIMAGE_AUTO.Scott Rifenbark2018-11-221-4/+3
| | | | | | | | | | The TEST_IMAGE variable went away and was replaced with the TESTIMAGE_AUTO variable. Fixed all related/affected areas. (From yocto-docs rev: 660da40b4fcdc05666e1877037fa63eb1dfe7227) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed poor writingScott Rifenbark2018-10-041-2/+2
| | | | | | | | | | | The bullet item describing what the LAYERSERIES_COMPAT variable was written poorly (ending in a preposition). I fixed the sentence to read more clearly. (From yocto-docs rev: 35d09727ab527df7d54ac1316c8e825f586ebc9a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed typo closing parenthisis.Scott Rifenbark2018-08-281-1/+1
| | | | | | | (From yocto-docs rev: d78dddd9c81c6c182a14ab5fb15b5c80caf2bf86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated general multiconfig syntax.Scott Rifenbark2018-08-281-4/+1
| | | | | | | | | | A task or package can only depend on a task... not a task or package. (From yocto-docs rev: 63f14e131ebf2bb8379a07f8958bf69a06af1124) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to section on multiconfig buildsScott Rifenbark2018-08-281-5/+15
| | | | | | | | | | | | | | | | * Added qualifying text indicating that you can build images or packages. In other words, the multiconfig does not necessarily have to be an image. It can be a package as well. * Added qualifying text describing that it is not a requirement to have separate TMPDIRs for each multiconfig. I used a build for two multiconfigs of "qemux86" for different DISTROs as a case. (From yocto-docs rev: 6e5ed0d1ab305c3382fea55fc1a2deaac0b7d518) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, Makefile: Created new section on multi-config build depsScott Rifenbark2018-08-281-85/+189
| | | | | | | | | | | | | | | | | | | | Rewrote the section on setting up and executing multi-config builds. Broke the section into two sub-sections. One is for the standard information that was there for setting up a multi-config build. A new section was for the cross-build dependencies in multi-config builds. Part of the re-write included creating a new figure that shows the configuration file hierarchy needed for these types of builds. So, new figure added to both the dev-manual and the mega-manual figures directories. Finally, the Makefile needed updated to account for the new figures. (From yocto-docs rev: dc158e97c216aa6e7fa3755164409d581f8569c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Changed section heading for multiconfig buildsScott Rifenbark2018-08-281-2/+2
| | | | | | | | | | | | Changed the section heading in the dev-manual for building images for multiple targets useing multiple configurations. This wording is more accurate. I updated the link from the BBMULTI_CONFIG variable description as well. (From yocto-docs rev: 3b2f95c3c54bed7ab8b4673ba7a254d31bea811b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Updated available names for TEST_TARGETPaulo Neves2018-08-151-11/+11
| | | | | | | | | | | | | | The documentation of available names for TEST_TARGET has been updated to match the convention of using the class names of controllers. This commit was modified some to make it work. Fixed some formatting errors and isolated and changed missed instances. (From yocto-docs rev: 1bec1dc38cdd1746ce6dd539f9c3e5665d12ab8e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed bad target ID for the dev-manual.Scott Rifenbark2018-08-151-1/+1
| | | | | | | | | This fix involved a few other manuals. (From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Documented NO_GENERIC_LICENSEKristi Rifenbark2018-06-281-0/+25
| | | | | | | | | | | FIXES [YOCTO #12734] Added a new variable description and created a new section in the dev-manual. (From yocto-docs rev: 854e641482171585c96ee5b9387b3e64146072b9) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed "newbie" chapter.Scott Rifenbark2018-05-241-0/+627
| | | | | | | | | | | | | This chapter only had the stuff about submitting a defect against YP and making a change to YP. I moved that information into the common tasks chapter as it is "how-to" information. Removal of this chapter alse required that the mega-manual.xml file be updated to not include the chapter. (From yocto-docs rev: 4421b1585c21a6f7862525ba972f7e765626066e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Speeding Up the Build" and renamed it.Scott Rifenbark2018-05-241-3/+158
| | | | | | | | | | | Renamed to "Speeding Up a Build" and moved out of the setting up chapter to the common tasks chapter. Fixed a couple links in the ref-manual. (From yocto-docs rev: c53fddd353230c8ef1abc21c7a2d2b1f492f034a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building Software from an External Source" section.Scott Rifenbark2018-05-241-75/+75
| | | | | | | | | | This section is now organized under the parent "Building" section in the common tasks chapter. (From yocto-docs rev: bc1bc9965cda547e45ff09a1c9e77be5e8c0a3d9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building Images for More than One Machine" section.Scott Rifenbark2018-05-241-198/+198
| | | | | | | | | | This section is now organized inside the parent "Building" section in the common tasks chapter. (From yocto-docs rev: 71be83e1ebfd2ad8606bddf852a4c06ab7d7c53d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building a Tiny System"Scott Rifenbark2018-05-241-427/+425
| | | | | | | | | | This section is now part of the building parent section. I have moved it there in the common tasks chapter. (From yocto-docs rev: a9fccb1bca8e18169d93416c7a6e17723bcf01c7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building an Initial RAM Filesystem (initramfs) Image"Scott Rifenbark2018-05-241-139/+105
| | | | | | | | | | This section now belongs under the parent "building" section in the common tasks chapter. (From yocto-docs rev: dad6029b9b45fd6ec564894ba101991fd8a2162e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved "Building Targets with Multiple Configurations"Scott Rifenbark2018-05-241-96/+95
| | | | | | | | | | This is a "building" topic. I moved it beneath the new parent "building" section. (From yocto-docs rev: 0426f0dd6871c8063476945b93743ffc5cfc0856) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved the "Simple Build" sectionScott Rifenbark2018-05-241-0/+165
| | | | | | | | | | | | | I had a section on building an image up in chapter that talks about getting set up to use YP. I moved the build section to a new parent section that will hold topics on building various things. I renamed the section to "Building a Simple Image". I had to fix several links in the sdk-manual, overview-manual, and dev-manual. (From yocto-docs rev: c119fc7c6148e7b08acad374fe2981842e9462a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed title to remove redundancyScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | The "Setting Up the Development Host to Use the Yocto Project" title changed to "Preparing the Build Host". Fixed links in a lot of other manual. (From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved licensing how-to stuff to dev-manualScott Rifenbark2018-05-241-202/+591
| | | | | | | | | | | | The section on licensing in the overview-manual was really "how-to" information. I moved this to a new section in the dev-manual for "working with licenses". I fixed some references in the ref-manual and in the bsp-guide as well. (From yocto-docs rev: f150a1ea2da900aae88fc5fa60f4115cc213ba2d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated "Enabling Runtime Tests on QEMU"Scott Rifenbark2018-05-241-0/+19
| | | | | | | | | | | | Fixes [YOCTO #12517] Added some qualifying information for how to generate a list of tap devices to enable runtime tests on QEMU. (From yocto-docs rev: 4359a355944f6cf4ec1e14ecbedc690ef37ff743) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved Wayland and WestonScott Rifenbark2018-05-241-0/+130
| | | | | | | | | | | The Wayland and Weston topic moved from the overview-manual to the dev-manual. The topic was really a "how-to" topic and not a concepts topic. (From yocto-docs rev: b0f20a67c99590c48d595f4e572339bb5b6b83b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved sstate debug tips sectionsScott Rifenbark2018-05-241-0/+92
| | | | | | | | | | | | Two sections at the end of the shared state concepts section in the overview-manual are really task sections. I took those and created a couple new sections in the dev-manual to house those topics. (From yocto-docs rev: 86382e7873d796f44554c8e04d3bd8091d350f51) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated "Enabling Your Layer" section.Scott Rifenbark2018-05-241-7/+9
| | | | | | | | | The bblayers.conf example files were out of date. Updated them. (From yocto-docs rev: fd5d75604a3ad66e56c421634f349dce3e38f609) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated wording for Manage Granular Level PackagingScott Rifenbark2018-05-241-1/+2
| | | | | | | | | | Changed wording to be clear about how PACKAGE_ARCH is being set when based on the Freescale MACHINE_SUBARCH variable. (From yocto-docs rev: 76c4ad514e44755f1d4dcec61bb0a74c1b77243e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated managing granular level packaging discussion.Scott Rifenbark2018-05-241-32/+43
| | | | | | | | | | | | | | In the section that talks about building an image for multiple machines, there was a bullet item on managing granular level packaging. It had an old example that used the "daisy" release that showed how to share packages and re-use binaries. I replaced the example with a discussion of Freescale's "fsl-dynamic-packagearch" class, which does this type of sharing. (From yocto-docs rev: ddc224d6d1fe172292dfd0a17f743a1e0a4cabe6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed Wic example paths to be consistent.Scott Rifenbark2018-05-241-3/+3
| | | | | | | (From yocto-docs rev: 402434dd15f3116307e690ecc09db875ecabded4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated Wic exampleScott Rifenbark2018-05-241-26/+24
| | | | | | | | | | | I updated the first example in the section telling how to build out a Wic image. I could not get the example to run so I used Stephano's output. (From yocto-docs rev: 6b4595215d6c24e3efb89288a7547f79ca3e59b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Cleaned up links to source reposScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | | I was using the "/cgit/cgit.cgi/" string as part of the link to the source repos, which uses the ENTITY "&YOCTO_GIT_URL;". That ENTITY is all that is necessary to get the link to work. I removed the other stuff. (From yocto-docs rev: f9a63c2cc824ef05230f614e933d178469890e97) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken linkScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 4abc25e1b0b93bb232291e0bb51ec89c5e1f66f9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken link to WORKDIR variable.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: c239bd40e92cedee6301c176ff96821ea270fc39) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Replaced SERIAL_CONSOLE with SERIAL_CONSOLESScott Rifenbark2018-05-241-1/+1
| | | | | | | | | The former is deprecated. (From yocto-docs rev: 1a1f89d91ceeb35f8cb5c2f9fc42fdb089ffc05c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken link to Carna Botnet's article.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 1d5e9bfea217051a457c30dcbd890366e9dd7611) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed target for a link.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 59697f22f79d07b800d4f3ce2eb2ea41c987802b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed non-functioning link to EXTERNAL_TOOLCHAINScott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: b0bd0c4d8070adf1439140230700b0de18f884ae) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Replaced "BSD" with "BSP" typo. Also small word change.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: d67856c849c5275a07ee1f87db839cd4d4d9a6f6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Terminology fix for "OpenEmbedded Layer Index"Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Found several instances of this being referred to as the "OpenEmbedded Metadata Index". Changed to "OpenEmbedded Layer Index". (From yocto-docs rev: 60fb601be324a350cd4d51b199915e6b72e2f9b0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed redundant link.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: bf64aad87e0248362e9cf9b693cd806ca32873fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed formatting issue.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 4cd711d1305f480068447bac8881212a5b999d34) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated everything for new overview-manualScott Rifenbark2018-05-241-14/+14
| | | | | | | | | | | | | | | | | This involved changing the root manual folder from "getting-started" to "overview-manual". Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was changed to "YOCTO_DOCS_OM_URL". Most manuals had several occurrences of these links. The makefile needed updating to process the new manual and not process the old "getting-started" manual. (From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed getting-started manual titlesScott Rifenbark2018-05-241-2/+2
| | | | | | | | | | | Throughout the documentation, the manual "Getting Started With Yocto Project" was used. The manual now is called "Yocto Project Overview and Concepts Manual". (From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links to old concepts-manualScott Rifenbark2018-05-241-19/+23
| | | | | | | | | | | | | The concepts-manual is going away for 2.5. I have fixed all the links across the YP documentation set that were cross-referencing into the concepts-manual so they now cross-reference into the getting-started manual, where that concepts chapter will live post 2.4x. (From yocto-docs rev: e9145e9e7fef882a13c982d34514a94f864b3c12) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links to concepts-manual.Scott Rifenbark2018-05-241-1/+2
| | | | | | | | | | Some inconsistencies in the links to the concepts-manual existed. I fixed these throughout the YP manual set. (From yocto-docs rev: ad7f840bb6f4a5248ef455b98ce9b35197e07e1a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>