summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
Commit message (Collapse)AuthorAgeFilesLines
* ref-manual: Fixed mis-matched title in link to ptest.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: d203312ede89d5c7467f8ac8117522c4fc1fd7b5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to the BAD_RECOMMENDATIONS variable.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 27ce95176fcceb95065eee19fecc2a71d88a0984) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to IMAGE_FEATURES variable.Scott Rifenbark2018-05-241-4/+2
| | | | | | | (From yocto-docs rev: 0ca8dc6aa8e06405e9483398788f4e221408fed7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed a link to a naked manual referenceScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | | | | The terms.xml chapter had a link to the toaster-manual where the string to the manual was not matching the string used in the mega-manual.sed file. Consequently, the link was not being processed correctly. This type of link should not be a link in the mega-manual because the target is to the manual in general. Fixed the string of the toaster-manual to match what is being used in the mega-manual. (From yocto-docs rev: 44042847db10b15f8694199162ad96dea44d21bc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated buildtools example scriptScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: f9d46c43a2f5961fb9bda6758f8c2cdeef100281) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated example buildtools .sh file.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 36fecfc69f60c99a58c86fc3f1890382fb013887) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, poky.ent: Removed old ENTITY to kernel-manualScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Found a link to the old kernel-manual in the reference manual. This manual is not used. I changed the link to use the proper ENTITY value and also removed the old one from poky.ent. (From yocto-docs rev: f1377989ab4a85827f5aaab9b19c4fb3c10567ca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed a link.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 79e8ae28a3da4c135227ba44e707a1adde61a24f) 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-2411-64/+64
| | | | | | | | | | | | | | | | | 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>
* dev-manual, ref-manual: Fixed two broken links.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 1ce02bf1c81629d9e008c05b48c4cddad264bafc) 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-243-4/+4
| | | | | | | | | | | 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-246-93/+96
| | | | | | | | | | | | | 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: Removed references to the concepts-manualScott Rifenbark2018-05-242-16/+5
| | | | | | | | | | | Removed all the references to the top-level of the old concepts-manual. These references are references that do not have a "#" target. They just reference the manual in general. (From yocto-docs rev: 5b33f3c119807532aa6feb2d010c9c9f780a26d8) 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/+1
| | | | | | | | | | 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>
* documentation: Fixed "Getting Started" manual linksScott Rifenbark2018-05-244-8/+8
| | | | | | | | | | | | | | There was inconsistent use when referencing the getting-started manual. The manual's name does not include the word "Manual". So, I cleaned this up across the manual set and also in the mega-manual.sed file, which was incorrectly processing the links to that manual that do not target a specific section. (From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Fixed various links to the dev-manualScott Rifenbark2018-05-242-2/+2
| | | | | | | | | | | | Found a few links that were not using the correct wording when referencing a section to the dev-manual. Also, fixed one link that was assuming a section outside the dev-manual when the link was to a section inside the dev-manual. (From yocto-docs rev: 7a577b135e1a01d6a9924ba89733e46d029c6cca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated "OpenEmbedded-Core" terms.Scott Rifenbark2018-05-243-8/+8
| | | | | | | | | | Throughout the manual set, I made sure that "OpenEmbedded-Core" and "OE-Core" appear with the hyphens. (From yocto-docs rev: 1f570df3eccb74b9e2e60af94c0e0dd48e1489e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated LAYERSERIES_COMPAT description.Scott Rifenbark2018-05-242-6/+6
| | | | | | | | | | | | Using "OpenEmbedded-Core" rather than "OpenEmbedded Core" in the text. The term as also fixed to reflect this change. Also, use of the phrase "OpenEmbedded-Core project" or "OE-Core project" is not desirable. Changing project to version. (From yocto-docs rev: ec226fcd92847c96ea2e11d34513b597a35c9825) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated LAYERSERIES_COMPAT variable description.Scott Rifenbark2018-05-241-4/+7
| | | | | | | | | Minor re-wordings from review. (From yocto-docs rev: d4598e7e43a8bafa4ff6ddeec50febcedc41b411) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed two grammar errors.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 23a0edc13f2306008c0bbb154fb0861f15d4e6de) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Cleaned up section IDs between Neon and OxygenKristi Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Updated section IDs for the new Using Eclipse Neon Appendix and Chapter 5 Working Within Eclipse (Oxygen). Changed one link found in reference manual. (From yocto-docs rev: d767007cf4151127063d1992a4e11e90437ae2da) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Purged the YP Quick Start references from YP setScott Rifenbark2018-05-243-9/+15
| | | | | | | | | | | | | | | The original Yocto Project Quick Start is being retired for the YP 2.5 release (sumo). I have purged all the various references from the YP manual set and replaced them with references to the appropriate doc. The references were mainly into the YP dev-manual for setting up the host or for building an image. There were a few references into the new "Yocto Project Quick Build" document for overviewing manual-type references. (From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Deleted the "ref-bitbake.xml" chapterScott Rifenbark2018-05-241-479/+0
| | | | | | | | | This information was merged into the BitBake User Manual. (From yocto-docs rev: eb68d4429aed652e4ca10c1ab55d3a815d453d6f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the SIGGEN_EXCLUDE_SAFE_RECIPE_DEPS variableJoshua Watt2018-05-241-2/+19
| | | | | | | | | | Describes the new wildcard syntax (From yocto-docs rev: e91db865686e7b1b9b21cb9aea892b0ed8884438) Signed-off-by: Joshua Watt <jpewhacker@gmail.com> Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Updated Manual NotesScott Rifenbark2018-05-241-13/+25
| | | | | | | | | | | | | I did some re-wording to account for when the user does a web search for a manual and the search returns an ancient version of the manual. Many times the user is oblivious of this fact and is trying to use a version of the docs that don't come close to matching the version of the YP. (From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added variable description for SPL_BINARYScott Rifenbark2018-05-241-0/+42
| | | | | | | (From yocto-docs rev: 00e579123540006c364f7751a37e29c74acf361b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the IMAGE_BOOT_FILES varaible.Scott Rifenbark2018-05-241-9/+16
| | | | | | | | | | | | | Added a final paragraph that provides some cross-referencing to the sections that describe how to use Wic and to the Wic reference chapter. Also, shortened the DOC info line. (From yocto-docs rev: 4ba5d0119caa3696187537f5b4cc9c64ca00e205) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated SERIAL_CONSOLE and SERIAL_CONSOLES variables.Scott Rifenbark2018-05-241-3/+5
| | | | | | | | | Added a link to the "getty" term. (From yocto-docs rev: d21fe1ea33353e15c135af7fc302ffe636310541) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated IMAGE_INSTALL variable description.Scott Rifenbark2018-05-241-6/+6
| | | | | | | | | Minor edits for clarification. (From yocto-docs rev: fdef057927b7b0dba64b9b7f952108fdb9c97f34) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated EXTRA_IMAGECMD variable.Scott Rifenbark2018-05-241-3/+3
| | | | | | | | | | Added minor edits to clarify that we are talking about an image type. (From yocto-docs rev: 14c906aa539d127c88d71d7fb3e628fc225cbd52) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new variable description LAYERSERIES_COMPATScott Rifenbark2018-05-241-0/+44
| | | | | | | | | | | Created a new variable description in the glossary. This variable is used in the layer.conf file and needed to be documented. (From yocto-docs rev: 5c514c0e90ca920bdf183b1f9449a06b906235ca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Added new appendix for NeonKristi Rifenbark2018-05-241-1/+1
| | | | | | | | | Fixed [YOCTO #12417] (From yocto-docs rev: 9f6b874740b98c5b3eed1c06dcf5fbe687279ca8) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added term "container layer"Scott Rifenbark2018-03-251-0/+14
| | | | | | | | | This is a layer that contains other layers (From yocto-docs rev: 0cd1881c18e8a63d5f2f078b03fe4e89fd9c75b5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PACKAGES_FEED_ARCHS variableScott Rifenbark2018-03-251-6/+15
| | | | | | | | | | | | | | | | Added the fact that this variable is really optional. If you don't use it then you are setting up a package feed URI that will include all supported arcchitectures for the package. Using it means you are setting up specific URIs for specific architectures. Added a "Tip" note box to show how you can use the variable to whitelist architectures. (From yocto-docs rev: 009f3551aa61aaf6459fd24105a2e06511b59da3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the IMAGE_INSTALL variable description.Scott Rifenbark2018-03-251-36/+50
| | | | | | | | | | I created a two-bullet "Caution" note to highlight the stuff a user needs to be aware of that can cause problems. (From yocto-docs rev: 553bc13e5fd350adb15400afe170e587965929db) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated devtool sectionsScott Rifenbark2018-03-251-53/+60
| | | | | | | | | | | | Updated the devtool add -h output. Updated the devtool --help output. Fixed wording for the "attic" file associated with the figure of the workspace area. (From yocto-docs rev: bc53d9a1236ba2545c112256e886729b08b507de) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the section on devtool upgradeScott Rifenbark2018-03-251-7/+34
| | | | | | | | | | | Provided a bit of rationale on why and when you use this command. Put in several links to help the reader get to related areas where command use is explained. (From yocto-docs rev: 7b30f29bfa15dd15f1388bb856e2047be55e7fb9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PREFERRED_PROVIDER variableScott Rifenbark2018-03-031-12/+25
| | | | | | | | | | Provided more details in the explanation and fixed a link to the section on using virtual providers. (From yocto-docs rev: ace74e24f001b83c9177266b0a6f15ce96dd04b0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated partition command optionsKristi Rifenbark2018-03-031-14/+68
| | | | | | | | | | | | | Fixed [YOCTO #11525] Created a note for more explanation for how the mount program understands the PARTUUID syntax used with --use-uuid. Added four missing options. (From yocto-docs rev: d8adf537d305dd55e841dd993c36ee60b5896adb) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated some terms in the "Terms" chapter.Scott Rifenbark2018-03-031-39/+97
| | | | | | | (From yocto-docs rev: c00be16a858ece1d3b02d554ec202088f78a2d1d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Removed fetchall and checkuriall tasksKristi Rifenbark2018-03-031-18/+0
| | | | | | | | | | | | | | | | Fixed [YOCTO #12547] ref-manual: Removed fetchall and checkuriall tasks. dev-manual: Replaced "bitbake -c fetchall target" command with 'bitbake -c target --runall="fetch"'. (From yocto-docs rev: 6d5cad8755e8817d50a9f88cb18115f43bb0b54a) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated phonetic pronounciation of Poky.Scott Rifenbark2018-03-031-1/+1
| | | | | | | | | It is Pock-ee with the emphasis on Pock. (From yocto-docs rev: fd0accf40a9324060562b75ba9d3b078daf458f6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added 16.04 as the LTS for UbuntuKristi Rifenbark2018-02-141-1/+1
| | | | | | | | | Fixed [YOCTO #12537] (From yocto-docs rev: 20a80210eeefddff91a6ea669a63c417144a529c) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed Ubuntu 14.04 from Supported Linux DistributionKristi Rifenbark2018-02-141-2/+2
| | | | | | | | | Fixes [YOCTO #12537] (From yocto-docs rev: 1bfa46614a93320c44ddc31fa8866e82c5349293) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Moved the detailed build section to concepts-manual.Scott Rifenbark2018-02-144-53/+50
| | | | | | | | | | | | | | The section that provides a closer look into the build system has moved from the getting-started manaul to the concepts-manual. I fixed all the links, provided some coded formatting of the entire section, and made general updates. The other manuals had links that needed fixed due to the move. (From yocto-docs rev: b83a5619f56ebd9879fdcadcf474859e68b26d58) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated "Build System" term to "Build Host"Scott Rifenbark2018-02-141-2/+2
| | | | | | | (From yocto-docs rev: 2f5b8678e3c4b791a8cdfe5e75da706b97fbc753) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated comprehensive list of manuals etc.Scott Rifenbark2018-02-141-11/+36
| | | | | | | | | | I added the concepts manual, the ref manual, and the mega- manual to the list. (From yocto-docs rev: 180387ac9ae74cd5b69c4cf6338b72daef4b9f37) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated links into new concepts-manualScott Rifenbark2018-02-142-7/+7
| | | | | | | | | | | | Creation of a new concepts manual and moving of chapters from the getting-started (overview-manual) caused many links and manual reference titles to break. I fixed these throughout the YP docs. (From yocto-docs rev: 30f2bc46be4a0faf5302eb8605bcb29f3bee6cf3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Purged overview manual referencesScott Rifenbark2018-02-1410-66/+71
| | | | | | | | | | | | | | | | | | | | When I converted the Yocto Project Overview Manual to the Getting Started With Yocto Project Manual, I updated the strings for references from "&YOCTO_DOCS_OVERVIEW_URL" TO "&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command that did not take into account the text the might follow the link by saying "see such-and-such section in the Yocto Project Overview Manual." So, I had to hand fix these. Additionally, since I have moved a deeper concepts chapter that was in the getting-started manual to a new Yocto Project Concepts chapter, many of those links changed had to really go to the new manual instead. Those were fixed. (From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Updated references to Bugzilla wiki pageKristi Rifenbark2018-02-141-0/+6
| | | | | | | | | Fixes [YOCTO #12475] (From yocto-docs rev: 460660fda7433959cff13897ece4a6c9f7ff8d09) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>