summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* sdk-manual: Updated devtool add workflow section.Scott Rifenbark2018-05-243-132/+121
| | | | | | | | | | | | | Had to update the figure to use "Upstream Source" labels and fix a wrong "devtool edit-recipe" command. That new figure went into both figures folders for the sdk-manual and mega-manual areas. Provideds some cleaner wording. (From yocto-docs rev: 6225d04dd0551a840d929b752225064a222962bc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Edits to section on running the sdk installation scriptScott Rifenbark2018-05-241-6/+15
| | | | | | | | | | | | | I changed the way we handle the list of exported variables resulting from running the *.sh installation script. Rather than list them all out (they were getting to be quite numerous), I am referencing a few as examples and recommending the user look at the actual *.sh file if they would like to examine the entire list. (From yocto-docs rev: ce2c1491f4f0991cad5f8d4a220a102adb024624) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Set up the 2.6 version of the docsScott Rifenbark2018-05-2411-36/+81
| | | | | | | | | | | poky.ent - Edited for new variables. <manual>.xml - Manual revision tables updated mega-manual.sed - swapped out 2.5 for 2.6 (From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to "Running the Extensible SDK Environment Setup Script"Scott Rifenbark2018-05-241-19/+29
| | | | | | | | | | | | Some Minor edits to this section. Also, a scrub of the list of variables exported when running the install script. The list is out of date and is missing many variables. I noted these in comments for now and will add them in later. (From yocto-docs rev: 739a2ca42ee798625492ddb51a32ad09f80aa960) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updated the "Installing the Extensible SDK" section.Scott Rifenbark2018-05-241-27/+36
| | | | | | | | | | | | | | | The text had not been updated to include the many architectures now supported in the Index of Releases toolchain directories. I added the list of architectures. Renamed the section to a more appropriate section heading. Verified the example and put in the latest output. (From yocto-docs rev: a567f5101d230ef1fa4428e9c6905e9e23bd5855) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Minor edits to the intro chapter.Scott Rifenbark2018-05-241-27/+40
| | | | | | | (From yocto-docs rev: 706b4adfd925d247da2ce7405f12ce1e05666a9e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Fixed MACHINE_EXTRA_RRECOMMENDS syntax in conf file exampleScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | | | Fixes [YOCTO #12628] The syntax for MACHINE_EXTRA_RRECOMMENDS was off in the machine.conf example. I have removed that leading space, which should not have been there. This matches the actual file in poky now. (From yocto-docs rev: 11e38c4c2b23f9a8ae9a0655a07af1a5682c24b8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed "newbie" chapter.Scott Rifenbark2018-05-244-631/+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-243-165/+160
| | | | | | | | | | | 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>
* ref-manual: Finalized edits on the 2.5 Migration sectionKristi Rifenbark2018-05-241-108/+88
| | | | | | | (From yocto-docs rev: 54259a4d4d69be73e7c614baa2a8d87faa2e3ea5) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.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-245-143/+168
| | | | | | | | | | | | | 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: Pulled cloning sections up into a parent section.Scott Rifenbark2018-05-241-26/+30
| | | | | | | (From yocto-docs rev: 68ef556831f687e25e3f4df068db4ea86bffb3b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated intro paragraph to exclude removed sectionsScott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 886ec9153314acbdcfa510806b441ba02c0bdd2d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed "Working With Yocto Project Source Files" titleScott Rifenbark2018-05-245-8/+8
| | | | | | | | | | Changed to "Locating Yocto Project Source Files". I am moving the sections on cloning repositories out from under this section. (From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c) 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-246-7/+7
| | | | | | | | | | | 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>
* dev-manual: Moved section on setting up a team YP environmentScott Rifenbark2018-05-242-372/+374
| | | | | | | | | | | This section was in the chapter on the open source development environment. It is better suited to be in a newly named chapter "Setting Up to Use the Yocto Project". I have moved it. (From yocto-docs rev: 028f8f7a1b93a023a99ffadb01b0da699b4081c2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated intro chapterScott Rifenbark2018-05-241-19/+16
| | | | | | | | | | The chapter was not the best given the new nature of the manual. I added better introductory wording. (From yocto-docs rev: cb4695575c0105e0cd5e50c2132e98553babe147) 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-244-601/+599
| | | | | | | | | | | | 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-242-135/+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>
* ref-manual: Chanaged a link to Wayland topic.Scott Rifenbark2018-05-241-2/+2
| | | | | | | | | | | The Wayland and Weston topic moved from the overview-manual to the dev-manual. The lone link to this topic was in the ref-images chapter. I updated the link. (From yocto-docs rev: 6c335f8d3618e3285f91fe20aea33a1c1f1c0ddf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Formatting pass of 2.5 Migration sectionKristi Rifenbark2018-05-241-136/+190
| | | | | | | (From yocto-docs rev: 50308cc7f04d3fc54c06766f85e15e76a99f0b4b) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved sstate debug tips sectionsScott Rifenbark2018-05-242-107/+120
| | | | | | | | | | | | 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>
* overview-manual: Updated "Invalidating Shared State" sectionScott Rifenbark2018-05-241-2/+2
| | | | | | | | | Removed "OpenEmbedded" in the string "OpenEmbedded build system." (From yocto-docs rev: d44b370b0fb993c32c9dfe3515188fa9e7ff2437) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Shared State" section.Scott Rifenbark2018-05-241-29/+41
| | | | | | | | | | | Added the line with "stamp-extra-info" flag to the example from the deploy.bbclass. This line was missing or it had been added since the original writing of this section. (From yocto-docs rev: 50f5482c2132235962d4ab48d0d7263628df1728) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Cross-Development Toolchain Generation"Scott Rifenbark2018-05-241-8/+12
| | | | | | | | | I made some small edits to this section. (From yocto-docs rev: a2cc355c1bdfbf10f86f8d4994cc81dfb12d8f87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed release date ENTITYScott Rifenbark2018-05-249-9/+9
| | | | | | | | | | | Now that 2.5 has released, I replaced the ENTITY variable used for the moving month and year with the actual release month and year (i.e. May 2018). (From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added 2.5 Migration SectionKristi Rifenbark2018-05-241-0/+417
| | | | | | | (From yocto-docs rev: 5d6c1b69e5559eced5142f46421302f61c95404c) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SDK_OUTPUT variableScott Rifenbark2018-05-241-2/+5
| | | | | | | | | Added more realistic information on how this variable is set. (From yocto-docs rev: 47e6cb7d00eeb8001c4a53c13600feb5ef4d4660) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated SDK_HOST_MANIFEST variable.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | Grammar fix. (From yocto-docs rev: aa5a60c8e3bf3f243678169b323e7ea5df7a6c19) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Minor edits to the SDK generation section.Scott Rifenbark2018-05-241-60/+74
| | | | | | | | | | Added the descriptions for the SDK_HOST_MANIFEST and SDK_TARGET_MANIFEST variables. (From yocto-docs rev: 212d6c5b3290016431604e67dfb27a1408ac0463) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated the sdk figureScott Rifenbark2018-05-242-0/+0
| | | | | | | | | | Added the manifest files to the figure and the associated variables. Also added the test files. (From yocto-docs rev: cfba55462d1c37ef2ff6454890da64a40f9c3607) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Minor wording changes to the "Images" section.Scott Rifenbark2018-05-241-5/+4
| | | | | | | (From yocto-docs rev: a3e825e6086ec7674641658cc956020e3e1cd9dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated the Images figureScott Rifenbark2018-05-242-0/+0
| | | | | | | | | I needed to add some italic formatting for variable type strings. (From yocto-docs rev: afc6d2d10081f9e9d940075c03b3e704b37cf13b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updates to the "Images" section.Scott Rifenbark2018-05-241-18/+18
| | | | | | | | | Some minor rewrites. (From yocto-docs rev: 71cbc1c389389ffac9e59faacdc56d3ea05facd7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updates to "Setscene Tasks and Shared State"Scott Rifenbark2018-05-241-25/+22
| | | | | | | | | | Updated with a few minor wording changes. Tried to get a little more active from some of the passive wording. (From yocto-docs rev: 7dcd8117e3ea40d4b3c1ee5c3b1ea3c2bd29893a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PACKAGE_CLASSES variable note.Scott Rifenbark2018-05-241-3/+4
| | | | | | | | The note about the TAR backend not working was changed to soften the warning. It has "limited functionality" rather than "broken". Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated text for Image and SDK generation.Scott Rifenbark2018-05-241-33/+37
| | | | | | | | | General improvements to both sections. (From yocto-docs rev: 977fdeaf1258613c3dfc41d78c8125fdba9b2a24) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated image generation imageScott Rifenbark2018-05-242-0/+0
| | | | | | | | | | The figure for image generation of the BitBake process needed some enhancing. (From yocto-docs rev: fc978663a7962d1515d4f47abe8ae522b9e24ce1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated SDK generation imageScott Rifenbark2018-05-242-0/+0
| | | | | | | | | The image needed a little bit of clean up. (From yocto-docs rev: d4fb680be194b7f9b192e06f0081a09504649633) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated the "Package Splitting" section.Scott Rifenbark2018-05-241-14/+52
| | | | | | | | | | Rewrite included the "do_populate_sysroot" task and a bunch of STAGING_DIR_* variables. (From yocto-docs rev: 53484d4982a41f83ac9355aada46526b5d05f64a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated package splitting figureScott Rifenbark2018-05-242-0/+0
| | | | | | | | | | | More changes to the "analysis-for-package-splitting.png" figure. I needed to work in "do_populate_sysroot" task and several STAGING_DIR_* variables. (From yocto-docs rev: fcb88024a7dfff1b6cca49770f67bf4c1f548362) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Changed title for configure/compile section.Scott Rifenbark2018-05-241-16/+15
| | | | | | | | | | The stage of the BitBake workflow is really "Configuration, Compilation, and Staging". I updated the title to be such. (From yocto-docs rev: 4aab6d001119aa8c52e09ef0f6f66694719add29) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the STAGING_DIR variable description.Scott Rifenbark2018-05-241-12/+12
| | | | | | | | | | | This variable plays a much smaller role since recipe-specific sysroots were implemented. I have rewritten the description to say that STAGING_DIR helps construct the recipe-sysroots directory. (From yocto-docs rev: c1ad18abe67111738efc18725c4f7706b55738cb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated the config/compile figureScott Rifenbark2018-05-242-0/+0
| | | | | | | | | | The figure had the wrong hierarchy for the "image", "recipe-sysroot", and "recipe-sysroot-native" folders. Moved out a level. (From yocto-docs rev: e1f45b666b1cd589cee9c9ae6dba01467b991ef9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>