summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* Documentation: Prepare for 2.6.1 release.Scott Rifenbark2018-12-271-1/+6
| | | | | | | | | | | | | | | | Updated the following: * poky.ent to use new variables values for 2.6.1 * mega-manual.sed to use "2.6.1" string for links * *.xml manual files to have a new entry in the manual history tables. Using the variable for the most recent entry. Hard-coded "November 2018" for the previous release, which was "2.6". (From yocto-docs rev: bada424e14169d1ae378c0481970e55ce8f5df51) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added note stating no WSL supportScott Rifenbark2018-12-271-0/+6
| | | | | | | | | | The Windows Subsystem for Linux is not supported. Added a note in the section on setting up the build host. (From yocto-docs rev: e806ea6ae534608e84540ac59f972914017ccce9) 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-12-271-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: 722b1b9c5bee1d43c45d943624854a53adc07939) 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-12-271-7/+6
| | | | | | | | | Script has been removed. (From yocto-docs rev: e1db4da1f7de8b9aa6e1ffffe71cdcf4929e5821) 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-12-271-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: 84e2c149fa823ab6e12be17b049c9bae1c1dd904) 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: Updates to "Cloning the poky Repository"Scott Rifenbark2018-09-111-10/+16
| | | | | | | | | | Some re-wordings and also ran through the examples to produce updated output. (From yocto-docs rev: 306baeb24d2c6b45d09f44e8c8d5f55b9aef1b8d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to "Cloning and Checking Out Branches"Scott Rifenbark2018-08-281-10/+6
| | | | | | | | | Provided clearer text. (From yocto-docs rev: 16b793389b359ee08b632d77c1d0abad4796543a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to "Accessing Nightly Builds"Scott Rifenbark2018-08-281-4/+12
| | | | | | | | | | Re-wrote section to provide more accurate step-by-step instructions. (From yocto-docs rev: dd1b5918d32b6272100fb59562de37f9a191e7ab) 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: Updates to "Locating Yocto Project Source Files"Scott Rifenbark2018-08-281-12/+21
| | | | | | | | | | Some edits for clarity and fixes to the procedures regarding the DOWNLOADS page. (From yocto-docs rev: 98ee61f7797c9352a1eff060b98a3e2e74a1da6f) 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-282-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: Updated the section on CROPSScott Rifenbark2018-08-151-33/+68
| | | | | | | | | Final edits to this section. The procedure is more complete now. (From yocto-docs rev: 5dcc32917c360e32475851b2b580d3d8bc988d7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated link to "CROPS" to be to the GitHub area.Scott Rifenbark2018-08-151-1/+1
| | | | | | | | | The original link was to a deprecated site. (From yocto-docs rev: 067094d10a8d02d0873deb87508377e896e4f3c7) 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>
* dev-manual: Edits to section on setting up CROPSScott Rifenbark2018-08-151-5/+5
| | | | | | | | | | Performed some edits to bring things in line for the "build host" terminology. (From yocto-docs rev: 4fedbdac437691b8a0f8d56931fcaad461c7463a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed section title for required packages.Scott Rifenbark2018-08-151-1/+1
| | | | | | | | | | | The title needs to use the terminology "Build Host" to be consistent with the manual set. I updated the title and the many links into that section. (From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to "Setting Up a Native Linux Host"Scott Rifenbark2018-08-151-3/+3
| | | | | | | | | | I made some terminology changes to be consistent with the "build host" term. (From yocto-docs rev: 8e00f6453cbc470c7572f2c18e23e44ce18a7336) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Adjusted "build host" wording.Scott Rifenbark2018-08-151-8/+8
| | | | | | | | | | Fixed the "Preparing the Build Host" section to consistently use the terminolgy "build host". (From yocto-docs rev: 6199dde0611b4f077dfb2ad1ebdcc1414c4a081a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added "recommended" for choosing native linux build host.Scott Rifenbark2018-08-151-2/+2
| | | | | | | (From yocto-docs rev: cddc649590fc6cea74a0b78a584e00e22088541c) 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-152-2/+2
| | | | | | | | | 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: Fixed typo in id anchor for a section heading.Scott Rifenbark2018-08-151-1/+1
| | | | | | | (From yocto-docs rev: 05e6520843fda764f3090c7d681f8fdad5f80311) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated team development environment section.Scott Rifenbark2018-08-151-99/+113
| | | | | | | | | | Found several areas that needed improvement. Made these modifications. (From yocto-docs rev: e2125363d39b9a54a371fc737cc9b55d66c9be59) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to intro chapter.Scott Rifenbark2018-08-151-2/+2
| | | | | | | (From yocto-docs rev: a991415c8645a3ad31bf2dd20f932d7f3b4ebe18) 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>
* documentation: Set up the 2.6 version of the docsScott Rifenbark2018-05-241-0/+5
| | | | | | | | | | | 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>
* dev-manual: Removed "newbie" chapter.Scott Rifenbark2018-05-243-629/+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-242-163/+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-242-140/+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: 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-241-3/+3
| | | | | | | | | | 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-242-2/+2
| | | | | | | | | | | 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-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>
* documentation: Removed release date ENTITYScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | 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>
* dev-manual: New section in QEMU for workaround under KVMMartin Kelly2018-05-241-0/+34
| | | | | | | | | | | | | | As suggested in a recent mail thread by Martin Jansa, there are cases in which QEMU under KVM will crash because of CPU feature incompatibilities between compiled binaries and the host CPU under which qemu is run. Although this is hard to fully escape, we should document the issue to help people work around it. I have taked Martin's suggested patch and did some rewording for the new section. (From yocto-docs rev: 6c625fcf631a82529bc58ec8fb0c18dbe13188d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added ENTITY variable to track a release date and yearScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>