summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: Provided proper link titleScott Rifenbark2019-07-181-1/+2
| | | | | | | | | | | | In the "Enabling GObject Introspection Support" section, a link existed to the "Known Issues" section further down in the chapter. The target of the link was missing and appeared as the placeholder "xxx". I put in the proper link. (From yocto-docs rev: 8d0d1b2104f08e888075bc0ae0bed4f0ec2f4ea6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed grammar issue.Scott Rifenbark2019-06-181-1/+1
| | | | | | | | | | Fixed in "Selecting an Initialization Manager" section. Extraneous word needed removed. (From yocto-docs rev: ab97d36299a7a648bc3f3325175d8ab633ad2d1a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Working with Packages" listScott Rifenbark2019-06-181-2/+5
| | | | | | | | | | | I added the "Creating node package manager (NPM) packages section link to the list. Also, made some edits to make the capitalization consistent in the list items. (From yocto-docs rev: d3e345cd3f44e9588c5fe8f0560e1859df0ff496) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added new section for creating NPM packagesScott Rifenbark2019-06-182-0/+289
| | | | | | | | | | | | | Fixes [YOCTO #10098] This is a new section in the development tasks manual that describes how to create Node Package Manager (NPM) packages. I put the section in the "Working with Packages" section. (From yocto-docs rev: d7acd9f27418d414854d25bb27842407edfe7dda) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added check-upgrade-status blurb to upgrading recipesScott Rifenbark2019-06-071-1/+17
| | | | | | | | | | | | The section "Upgrading Recipes" covers several ways of upgrading a recipe. I added some stuff in the introductory area that mentions the fact a user might want to check the upgrade status of a recipe first. (From yocto-docs rev: bd2fd8d0a91b64455c282ebf4974e40874274f46) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: removed "distrodata" classScott Rifenbark2019-06-071-6/+0
| | | | | | | | | | | Ousted these since it was noted in the migration section that the class had been removed. Modified all references to the removed class as needed. (From yocto-docs rev: 7000acc76da6b7ee850b799347ab9083663c7e6a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added cross-link to "Fetchers" section in BB manual.Scott Rifenbark2019-05-121-1/+2
| | | | | | | | | | | | | Fixes [YOCTO #10098] Inside the "Fetching Code" section we mention fetchers but have no links for more information to the "Fetchers" section in the BibBake User Manual. I have added a link. (From yocto-docs rev: 5224bb7b7a3c0f081b066a45865fd326aa068fc9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Cleaned up "plug-in"/"plugin" terminology.Scott Rifenbark2019-05-071-38/+38
| | | | | | | | | | | | | | The YP manual set was using the plugin term inconsistently. It was appearing as "plugin" as well as "plug-in". The plugins in the project are all named without a hyphen. The term itself is either/or according to Google. I have changed all references to plugin so that they do not use a hyphen. (From yocto-docs rev: 715bb58e2347c5e37a49da7d9e3e230503672337) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared for 2.8 releaseScott Rifenbark2019-05-071-1/+6
| | | | | | | | | | | poky.ent - variables all set up for 2.8 mega-manual.sed - "2.7" replaced with "2.8" <folder>.xml - manual revision history tables updated. (From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added reasoning blurb to "Viewing Variables" section.Scott Rifenbark2019-05-071-0/+10
| | | | | | | | | | | | I put a new introductory paragraph in the "Viewing Variables" section that alludes to why you might want to see variables. Also, I linked to the section "Modifying Variable Values" in the BB manual. (From yocto-docs rev: 6e18524ba62d2ff1231184467b0dd24dab33cfe6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual; brief-yoctoprojectqs: Updated checkout branch exampleScott Rifenbark2019-05-071-0/+1
| | | | | | | | | | Added the "yocto-2.6.2" tag to the example output since that will be part of the overal list when 2.7 releases. (From yocto-docs rev: 4863284811ad459cb0193528d5686a1ec008bb3e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed all references to Eclipse.Scott Rifenbark2019-05-072-28/+3
| | | | | | | | | I also fixed all linking as needed. (From yocto-docs rev: c8d10a924a3a4ae76e8fc26ebcba52ea04f2f267) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Removed customization.xsl files for EclipseScott Rifenbark2019-05-071-35/+0
| | | | | | | | | | | The help files for YP manuals used in the Eclipse application are no longer supported. I removed the individual *-customization.xsl files for the individual YP manuals. (From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: Updated clone and checkout example.Scott Rifenbark2019-02-251-10/+15
| | | | | | | | | | Needed to have a predictive number of tags and branches in the example commands that assume a released 2.7 version. (From yocto-docs rev: b9f302cf819dbe759b560f4586edaedfae13e3d9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Grammar fix.Scott Rifenbark2019-02-121-1/+1
| | | | | | | (From yocto-docs rev: 49e54aee94bc0972142efd1ba72eb1d9431c86c9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added some clarification for nographic qemu option.Scott Rifenbark2019-01-161-0/+3
| | | | | | | (From yocto-docs rev: ff3d2ed0878d511f48007f5df468ae04e95109eb) 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>
* brief-yoctoprojectqs, dev-manual: Update tag checkout examplesScott Rifenbark2019-01-161-5/+4
| | | | | | | | | | | | Turns out I had some hard-coded stuff in these examples. Furthermore, I did not have good enough detail in the brief-yoctoprojectqs manual. I added more detail on how to get that sato example going. (From yocto-docs rev: 3dd6217be5e6f73ba3927431105096aec1445e10) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Preparing for 2.7 release.Scott Rifenbark2018-12-151-1/+6
| | | | | | | | | | | Updated poky.ent to have variables for 2.7. Updated mega-manual.sed file to use "2.7" string. Updated all <manual>.xml Manual History Tables to use "TBD" (From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b) 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-11-221-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: e6c3b0acd77569e0422cf86e7dc56433e76bdf20) 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: 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>