summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-structure.xml
Commit message (Collapse)AuthorAgeFilesLines
* sphinx: remove DocBook filesNicolas Dechesne2020-10-061-1123/+0
| | | | | | | | | | The Yocto Project documentation was migrated to Sphinx. Let's remove the deprecated DocBook files. (From yocto-docs rev: 28fb0e63b2fbfd6426b00498bf2682bb53fdd862) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Add SPDX license headersakuster2020-06-281-0/+1
| | | | | | | | | [Yocto #13873] (From yocto-docs rev: b7d60325c7ca02d38516781ea80376e465c5fd04) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: various touchups, rewordings, corrections to Ch 5rpjday@crashcourse.ca2020-04-061-63/+63
| | | | | | | | | | | | | Minor tweaks to chapter 5 of reference manual, including: - grammar - adding slashes to directory names for consistency - collapse trivial paras into one (From yocto-docs rev: 96b75e723bff042183f70a858d09df4aad094578) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Updates to reflect that MACHINE defaults to qemux86-64Mark Asselstine2020-03-111-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | meta-yocto commit 69ddecdb1516 [local.conf.sample: change default MACHINE to qemux86-64] switched the default MACHINE from 'qemux86' to 'qemux86-64' but some documents which either explicitly mentioned the default, or where this was implicit didn't receive an equivalent update. Where it made sense we continue this change in default to the docs. In other places, such as the kernel-dev manual, we note the new default and instruct the user how to switch back to 'qemux86'. Eventually we should probably update the kernel-dev manual to use the default, but for now the intention was to limit the impact of these changes. Note that ext3 has also been replaced with ext4 for image generation, so while we are modifying runqemu lines to qemux86-64 we also make the change to reference ext4 such that the runqemu commands will function properly. (From yocto-docs rev: 8c1d8ab1170f47a2c2692beb903ab0b7c6835b7b) Signed-off-by: Mark Asselstine <mark.asselstine@windriver.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: The sanity_info file has moved from build/conf to build/cachePeter Kjellerstedt2020-03-111-1/+1
| | | | | | | (From yocto-docs rev: 813dd1a2ce48df08b92d821700380d5d231e6760) Signed-off-by: Peter Kjellerstedt <peter.kjellerstedt@axis.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed "Working With Yocto Project Source Files" titleScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | 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>
* ref-manual: Removed redundant link to WORKDIR variable.Scott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: 66ab70483fe1ab963b6e5e822797b144f787a139) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed redundant link to "Build Directory" termScott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: 37ddada28753fe89cd56b44b4f1e5896cf71cc23) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed link to "naked" bsp-guide referenceScott Rifenbark2018-05-241-2/+1
| | | | | | | | | | | | A "naked" reference to the bsp-guide was split across two lines in the *.xml file. This splitting causes the link to not be processed correctly by the mega-manual.sed script. I joined the two lines to fix the link. (From yocto-docs rev: e31b4d2210b5c246f3e822fbe8950a625e08ca98) 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-3/+3
| | | | | | | | | | | | | | | | | 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-5/+5
| | | | | | | | | | | | | 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-3/+3
| | | | | | | | | | 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>
* documentation: Moved the detailed build section to concepts-manual.Scott Rifenbark2018-02-141-5/+5
| | | | | | | | | | | | | | 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: Purged overview manual referencesScott Rifenbark2018-02-141-2/+2
| | | | | | | | | | | | | | | | | | | | 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-3/+3
| | | | | | | | | | | | | | | | | | | | 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>
* 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>
* documentation: Created new YP Overview ManualScott Rifenbark2018-02-141-5/+6
| | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #12370] Added a new chapter to the newly created Yocto Project Overview Manual. This chapter originated from the YP Reference Manual and was the old chapter 3, which talked a lot about various concepts. This information is better suited for the new overview manual. The change involved moving the entire chapter and renaming it. This move of the content affected many, many external references and links into the old area. Consequently, I had to recast all these links from the different manual. Changes also included fixing the mega-manual.xml file so that it would include the new overview manual as part of it. Many figures had to be relocated as part of the move as well. This meant deleting them from the ref-manual/figures folder and putting them into the overview-manual/figures folder. (From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated links to the sdk-manualScott Rifenbark2017-10-301-1/+2
| | | | | | | | | | The title of the sdk-manual changed. Many links were updated to render to the correct book title. (From yocto-docs rev: 821e29c6c031ae2516fb0e79d0ec3936a5bd624c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Converted external links to internal and fixed dev-manual linksScott Rifenbark2017-10-301-18/+21
| | | | | | | | | | | The title of the dev-manual changed to the Yocto Project Development Tasks Manual. I added that to the links. Also fixed several external links that really should have been internal. (From yocto-docs rev: ff2d0010530d6969b2ffd64e6d23c79a18d7f368) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Purged "oe-init-build-env-memres" from docsScott Rifenbark2017-09-221-183/+11
| | | | | | | | | | | | | | Fixes [YOCTO #11968] Purged all occurrences of the "oe-init-build-env-memres" script from the YP documentation set. Occurrences in a lot of places. The BBSERVER variable was also impacted and had to have the definition updated. (From yocto-docs rev: 274b05108d1bc53df20c11ab2efa15363bce23da) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new variable COMPONENTS_DIR to glossaryKristi Rifenbark2017-09-021-1/+2
| | | | | | | | | | Added new description and created a link for an existing occurance of the variable. (From yocto-docs rev: 9ab6e6aed685c9419cb7df3df3ab029033d9ba0e) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed duplicate section id.Scott Rifenbark2017-09-021-1/+1
| | | | | | | (From yocto-docs rev: b5ef950136b2d2bb00fdd86f971f77cb744a8c82) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added tmp/sysroots-components taskKristi Rifenbark2017-09-021-0/+19
| | | | | | | (From yocto-docs rev: ae635dfc2f53e026b597c1d2ca93ecaa9416417c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated build/tmp/work/tunearch/recipename/versionKristi Rifenbark2017-09-021-10/+10
| | | | | | | | | | Replaced "recipe_work_directory" with "${WORKDIR}" throughout the section. (From yocto-docs rev: a961cf07cd18d06e0c6399a10dc40c0d4143c23f) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Re-write of dev-manual setup chapterScott Rifenbark2017-07-121-2/+3
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The chapter on setting up YP has been completely re-written to move towards a "how-to" manual. This involved touching every aspect of the chapter. All subsections now have procedures surrounding set up stuff. There are some development sections that still need fleshed out. Many, many links and references in other chapters were affected. These have been fixed. A couple style-sheet (*.css) files were also updated to support the "writernotes" style, which renders paragraph text in red. (From yocto-docs rev: c4c2a6cf575ce5c783b1cc84d9f7e961aebef49c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links for "metadata" term.Scott Rifenbark2017-06-221-2/+2
| | | | | | | | | | | | | Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke the links to the "Metadata" term. I fixed these. (From yocto-docs rev: 190da4b4d44952d141db26ca72b5bc1a52d77023) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links for "build-directory" term.Scott Rifenbark2017-06-221-6/+7
| | | | | | | | | | | | | Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke several links to the id "build-directory". I fixed these to reference into the ref-manual now. (From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Updates to support recipe-specific sysrootsScott Rifenbark2017-04-181-5/+113
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Changes covered several areas. Version 2.3 of the YP now supports recipe-specific sysroots and is not limited to machine-specific as was prior releases. Manual changes were as follows: dev-manual: "Sharing Files Between Recipes" - Wordings were changed to support the new functionality. ref-manual: do_prepare_recipe_sysroot task added to the list of tasks described in "Configuration and Compilation". ref-manual: Extensive re-write of the "staging.bbclass" section. ref-manual: Added a section to the build structure for build/tmp/work/tunearch/recipename/version/. This section breaks down the recipe-specific subdirectories used to create (stage) the sysroot. ref-manual: New section (entry) for the do_prepare_recipe_sysroot task in the task chapter. ref-manual: Added a variable glossary description for the SSTATE_SCAN_FILES variable. In addition to these changes, I sprinkled in a liberal amount of cross-referencing for the readers pleasure. (From yocto-docs rev: 3a8ca96861f4c5d3badb91d0cdc5a3df513d4e59) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated build/tmp/cache/ reference sectionScott Rifenbark2016-10-111-3/+15
| | | | | | | | | | | Fixes [YOCTO #10356] Expanded the general description of this directory. (From yocto-docs rev: df71fe472f9d5cb5f809706ec4218952a49d31d3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New section clarifying stamps, input checksums and sstate cacheScott Rifenbark2016-09-231-2/+10
| | | | | | | | | | | | | | Fixes [YOCTO #10172] I added a new section on how BitBake reruns tasks based on the stamps files. Also put in some cross-referencing links to that new section in the stamps entry for the structure chapter and in the STAMP variable in the glossary. (From yocto-docs rev: da8779d9eb85473cd6b0f74e9e1371e1d277890f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Converted "meta-yocto" to "meta-poky"Scott Rifenbark2016-04-181-10/+10
| | | | | | | | | Occurrences in many manuals and one figure. (From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, profile-manual, ref-manual: Updates to remove meta-toolchainScott Rifenbark2016-03-231-2/+0
| | | | | | | | | | | The term "meta-toolchain" is legacy now. I went through and removed its use except for where it appears still as output from the oe-init-build-env script. (From yocto-docs rev: 1cc134060459278997d57f1293f54091c5404d85) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, sdk-manual: Changed section heading.Scott Rifenbark2016-03-231-1/+1
| | | | | | | | | | | Changed the heading for "Optionally Building a Toolchain Installer" to "Building an SDK Installer". This changes the heading and many references to that heading. (From yocto-docs rev: 97d8cd34d0dd0993b1b1135bb75f2212bb46878a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Resolving a conflictScott Rifenbark2016-03-231-2/+2
| | | | | | | (From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: remove all references to HobBelen Barros Pena2016-03-231-2/+1
| | | | | | | | | | | | | | | | | | | Hob and the packageinfo class have now been removed from the code base. This patch removes all references to: * Hob * meta-hob * packageinfo and * BBLAYERS_NON_REMOVABLE from the documentation. So long, Hob, and thanks for all the fish. (From yocto-docs rev: 6a1ba2761d5c2ec1072616ce3d791787f1b1b2a7) Signed-off-by: Belen Barros Pena <belen.barros.pena@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updates to cull out qt4 stuff.Scott Rifenbark2016-01-151-8/+0
| | | | | | | | | | Several areas changed throughout the ref-manual to remove qt4 referencing. (From yocto-docs rev: 9ee721034ceb2bb7b7a9e64f6a6a7a2b3bfd1c82) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the section on oe-init-build-env-memresScott Rifenbark2015-04-151-14/+44
| | | | | | | | | | | | | | Fixes [YOCTO #7559] Added some explanation on the syntax. As it was, the positionally dependent nature of the script's parameters was not accounted for. This is now explained. Also, talked a bit about the bitbake-cookerdaemon.log file. (From yocto-docs rev: fcf52a15acea2d75df9c84550d7e73c988ffb4bb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed two spelling errors.Scott Rifenbark2015-04-151-2/+2
| | | | | | | (From yocto-docs rev: 2725c01a396a877cfa70471238d8195673ed53ff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Update to oe-init-build-env-memres description.Scott Rifenbark2015-04-101-2/+2
| | | | | | | | | | | | Fixes [YOCTO #7559] Removed the information stating that the port address 12345 is used. Really what happens is a random port address is used. (From yocto-docs rev: f469c2431b26593a762e348e9c5d0e84c582eab8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Downplayed the BBLAYERS_NON_REMOVABLE variable.Scott Rifenbark2015-04-011-3/+1
| | | | | | | | | | | | | | Applied some suggestions from Paul Eggleton to downplay the role of this variable. It is basically ignored now in all parts of the manual set except for the descriptions of the variable itself and the BBLAYERS variable. I added some text reinforcing the fact that BBLAYERS_NON_REMOVABLE is ignored by the build system and only matters if you are using Hob. (From yocto-docs rev: 98112751aaec6e25de48d9e3ee56592be3f53a07) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: First draft devtools.Scott Rifenbark2015-02-171-1/+1
| | | | | | | | | | | | | | | | | | | Completed draft of the new devtool material. This commit affects some linking and figures across the YP doc set. * Added the build-workspace-directory.png file to both the dev-manual and the mega-manual. * Updated the Makefile to include the new figure in the TARFILE for dev-manual and mega-manual. * Re-did the section organization to pull the quilt and finding source file out of the "Modifying Source Files" section. (From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual, adt-manual, yocto-project-qs: scrub eglibcScott Rifenbark2015-02-171-1/+1
| | | | | | | | | | | Scrubbed out the occurrences of eglibc and replaced them with glibc. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 868ceda79b1c738349e512e523c850b24f9232ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual, yocto-project-qs: Updates to parallelism variablesScott Rifenbark2015-02-171-6/+2
| | | | | | | | | | | | | | | | | | The way the old manual set had worded the use of the BB_NUMBER_THREADS, PARALLEL_MAKE, and BB_NUMBER_PARSE_THREADS had become depricated. It suggested a lot of user intervention to get these variables set to have the build system utilize optimal parallelism. The change a while back to the build system where the variables are set to the number of build host cores now makes the variables automatically be set to their best values. I have gone through the manual set and changed wordings appropriately to reflect this. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 3a27b1792c92a2f22173315e2732f672cdad2c78) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Scrubbed for variable (user) input.Scott Rifenbark2014-10-181-3/+3
| | | | | | | | | | | | | | | Throughout the manual I had been using angled bracket sets to denote user-supplied input. This is confusing and better shown by using the <replaceable></replaceable> tags. I scrubbed all the chapters and replaced as needed. Some other minor formatting changes were caught and fixed during the scrub as well. (From yocto-docs rev: 9a668574dd18828a750cfa2e8c28e1f089a19609) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, yocto-project-qs: Fixed some references to BitBake Manual.Scott Rifenbark2014-07-211-3/+2
| | | | | | | | | | | | | | | | Fixed a reference that was not linking to the manual but was instead referencing the Source Directory structure. (From yocto-docs rev: aae3fb868e95ef2dbd548a5f9d1ea61a013190cd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Conflicts: documentation/ref-manual/ref-variables.xml Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev, ref-manual: Updated task name usage.Scott Rifenbark2014-06-181-2/+3
| | | | | | | | | | | | There was inconsistency on how we refer to a task name throughout the YP manual set. The proper way is "do_<taskname>". Some occurrences did not include the "do_" prefix. These have been fixed. (From yocto-docs rev: b32821bb0d3e6de7bca68b25c662a023526a10c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, dev-manual: Updates for custom template configuration directory.Scott Rifenbark2014-06-181-4/+24
| | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #5895] I created a new section in the dev-manual titles "Creating a Custom Template Configuration Directory" that describes how the build system uses the template local.conf and bblayers.conf and conf-notes.txt files as a basis when creating the real deals in the build directory's conf folder. The context of this is so that the user can create their own directory with their own template files for repeated configurations and to create a custom conf-notes.txt file should they want the setup scripts to display some custom list of targets. I also modified the two script references in the ref-manual for oe-init-build-env and oe-init-build-env-memres. I needed to link to the "how-to" section and added a bit in there about how the scripts go about forming the conf files in the build directory. (From yocto-docs rev: c07fb7082fe08387bbc546b2a23620dedc7127b8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated reference sections for environment setup scripts.Scott Rifenbark2014-05-301-0/+70
| | | | | | | | | | | | | | | Fixes [YOCTO #5895] Both section for the environment setup scripts (oe-init-build-env and oe-init-build-env-memres) were updated to provide some usage information on the conf-notes.txt file. This file is where the default list of images appears that the scripts display upon completion. (From yocto-docs rev: 77bd0cd6eeb77036fb7e1584c469f98c2524b750) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added the build/tmp/work-shared directory.Scott Rifenbark2014-04-011-0/+14
| | | | | | | | | | | Added a brief explanation of this temporary directory to the chapter that presents the structure of the Source Directory. The explanation is based on Paul Eggleton's input. (From yocto-docs rev: 688c36aec57bb283d03ffb7e1d9448563cb1496c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added the build/tmp/sstate-control directoryScott Rifenbark2014-04-011-0/+16
| | | | | | | | | | | I added this directory to the chapter that presents the Source Directory structure. The explanation is based on Paul Eggleton's input. (From yocto-docs rev: 425df89935f2cd07ecbc3050d273100d57e3ab3d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-09 09:06:56 +0000