summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-variables.xml
Commit message (Collapse)AuthorAgeFilesLines
...
* ref-manual: Removed redundant link to PACKAGES.Scott Rifenbark2018-05-241-3/+3
| | | | | | | (From yocto-docs rev: d9482b43c1166ef2fd663c903a15222c66faf979) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to the distutils class.Scott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: 5a097baecff0e0cabf1749abcc3697210ab63b47) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to DEPENDSScott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: ddd59a0ae4eda76c9e9c284ce9db4428a925e610) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to OVERRIDES variable.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: b336d7f504bb931d9b2743ee86ff104080692bec) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PACKAGECONFIG_CONFARGS variable description.Scott Rifenbark2018-05-241-8/+2
| | | | | | | | | Several redundant links and wordings in this description. (From yocto-docs rev: bb9dd8ab6ef9cad387cdddada4f2be093551e38a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to DEPENDS variable.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 6ecf6a692d759c783355581e227ff861e9492115) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed broken link.Scott Rifenbark2018-05-241-2/+2
| | | | | | | | | | A migration item had taken the original section for the target of the link out. I had not changed it. (From yocto-docs rev: 10cfaee50455bf10450540f1b381d33f9babf985) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed capitalization in section title linkScott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 945038155d9941dc94001325416221f77726015d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added kernel-dev title to linksScott Rifenbark2018-05-241-2/+4
| | | | | | | | | | Two instances where links were going into the kernel-dev manual but the manual title was not being used in the text. Added it. (From yocto-docs rev: 1922f8c79d1667db1fc9b5fe57030302469ca09c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added title to kernel-dev manual as part of a section link.Scott Rifenbark2018-05-241-1/+2
| | | | | | | (From yocto-docs rev: 5c0cb69ff1a565e037686f344269fe7238ce442e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to INITRAMFS_IMAGEScott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: 62d835e0841cc19e644e79af22088880ff3eaac7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to Source DirectoryScott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: 9fb10f4f0ca5bed4804d77a1c224672866ee2b87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed link manual title for BitBake User ManualScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: cad80681e72e7e22c3867961aeefe7f260c20f86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed manual title as part of a cross-reference.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | The link was to a chapter in the existing manual. I do not include the manual title when that is the case. (From yocto-docs rev: 1b7c65b4a2dde3f5d069cb5edc75728492639870) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed broken link to TARGET_VENDORScott Rifenbark2018-05-241-1/+1
| | | | | | | | | Link was going to TARGET_PREFIX. (From yocto-docs rev: 424e8ea3168ab2e910919e6f70fc0b16332ca4f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant FILESEXTRAPATHS link.Scott Rifenbark2018-05-241-3/+1
| | | | | | | (From yocto-docs rev: 74199d4a3d5fe5a9836e363522b052614a542e26) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed title for BitBake User Manual reference.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 73249f903fcb68201937f05216bedd4fc25fb060) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Corrected link title in DISTRO_FEATURES_BACKFILLScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 93c730199bb66fa6909bd0c0a2e75b5cca9534af) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed link to WORKDIR in the D variable description.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: edf989858c37dcdf19ec99dceb959061bc89be97) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant links in COMBINED_FEATURES var.Scott Rifenbark2018-05-241-7/+0
| | | | | | | (From yocto-docs rev: 7328ac66feebed290add2b122e12c2ea567f6bdf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated example string for BUILDHISTORY_COMMIT_AUTHOR.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | I replaced the "&lt;" and "&gt;" constructs with the tags <replaceable> and </replaceable>. This is the preferred formatting for user-supplied values. (From yocto-docs rev: 1fc32486483c545671ffb2142b553da75dbe54fe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Provided more relevant link for Python documentationScott Rifenbark2018-05-241-2/+2
| | | | | | | | | | | | | | In the BBMASK variable, a link to Python documentation was going to a specific 2.6 release. That release was probably the most recent when the BBMASK variable was initially documented. Python has many releases now (e.g. 3.6.5). I re-worded the description to be more generic and sent the user to the general Python release area. They can pick a release from that URL. (From yocto-docs rev: 154aedf79625f37997bec18dba933c514072708e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link in BB_DISKMONS_DIR variableScott Rifenbark2018-05-241-4/+3
| | | | | | | | | | | Removed the first link to the BB_DISKMON_WARNINTERVAL variable. The variable was linked later in the text. No need to link the output version of the variable... clunky looking. (From yocto-docs rev: ec6cfc85ba2f1e2fc763b6b7c918a21cec00e203) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated APPEPND variable.Scott Rifenbark2018-05-241-3/+4
| | | | | | | | | | Changed wording so I could reference the proper name of the LABELS variable. (From yocto-docs rev: 05e5f287bde8219d1f8125d71fd48a36a422009a) 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-24/+24
| | | | | | | | | | | | | | | | | 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: Fixed links to old concepts-manualScott Rifenbark2018-05-241-42/+45
| | | | | | | | | | | | | 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: Updated "OpenEmbedded-Core" terms.Scott Rifenbark2018-05-241-4/+4
| | | | | | | | | | 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-241-5/+5
| | | | | | | | | | | | 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>
* 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>
* 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>
* 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 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>
* documentation: Moved the detailed build section to concepts-manual.Scott Rifenbark2018-02-141-23/+20
| | | | | | | | | | | | | | 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>
* documentation: Updated links into new concepts-manualScott Rifenbark2018-02-141-2/+2
| | | | | | | | | | | | 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-141-28/+30
| | | | | | | | | | | | | | | | | | | | 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>
* documentation: Created new "Getting Started" manual.Scott Rifenbark2018-02-141-25/+25
| | | | | | | | | | | | | | | | | | | | Creation involved removing the overview-manual and replacing it with the getting-started manual. All links to the string "&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with "&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed files used to create the manual with prefixes suited for the new manual name, which is "Getting Started With Yocto Project". The style sheet for the new manual needed updating to display the new .PNG image for the title page. The mega-manual file had to be updated to include the files. The mega-manual.sed file had to be updated to include the new manual and not use the overview manual. (From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Moved "Speeding Build" to dev-manualScott Rifenbark2018-02-141-4/+4
| | | | | | | | | | | | | Fixes [YOCTO #12370] The section on "Speeding Up a Build" that was in the ref-manual needed to be in the dev-manual as it is a "how-to" section. Moved it. (From yocto-docs rev: 44d2889a4f3fb5dfabb1ea4df68a1b8bbf9347c8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved build history info to dev-manualScott Rifenbark2018-02-141-2/+2
| | | | | | | | | | | | | Fixes [YOCTO #12370] The section in the ref-manual on build history has been moved to the dev-manual. It is more of a "how-to" piece of information than a reference. (From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Consolidated debug info into dev-manualScott Rifenbark2018-02-141-4/+5
| | | | | | | | | | | | | Fixes [YOCTO #12370] Moved the debug information from the ref-manual to the dev-manual where other debug information exists. We now have a single area (section) that deals with various debugging techniques and tips. (From yocto-docs rev: 95394197fc04981bf7571e581ff8a0fd9c76223f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Variable Definition Edits for documentation.confKristi Rifenbark2018-02-141-50/+49
| | | | | | | | | | | Fixes [YOCTO #5600] Grammar scrub of variable definitions in documentation.conf (From yocto-docs rev: 199fdc55aae4f34d95988ee2e43f3524fe82714a) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Variable Descriptions for documentation.confKristi Rifenbark2018-02-141-20/+23
| | | | | | | | | | | Fixes [YOCTO #5600] Grammar scrub on all variable description for documentation.conf (From yocto-docs rev: 3054b1e4649d232f08f1065bad96b90eed57d517) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, ref-manual: Moved "Licenses" to overview-manualScott Rifenbark2018-02-141-6/+6
| | | | | | | | | | | | | | Fixes [YOCTO #12370] The "Licenses" section in the technical details chapter of the ref-manual was concepts and needed moved to the new overview-manual. Some links were broke during the move and they were fixed in the BSP and dev-manual. (From yocto-docs rev: 34c013f055736dcde2fe12daea1aaf2beaee97c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>