summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-structure.xml
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* ref-manual: Added the meta/conf/machine-sdk directoryScott Rifenbark2014-04-011-0/+15
| | | | | | | | | | | This directory was missing from the chapter that presents the Source Directory structure. I have added a brief explanation of it based on Paul Eggleton's information. (From yocto-docs rev: 5c3d392c64f386a3a29922629387c199db2b7ad1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Removed meta-hob layer from docs.Scott Rifenbark2014-04-011-12/+0
| | | | | | | | | | Hob no longer uses this layer so I removed the two instances in the YP set where it appeared. (From yocto-docs rev: 37e3f261bd61a96a2929a525f9896c39658d26f8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added top-level meta-selftest directoryScott Rifenbark2014-04-011-0/+16
| | | | | | | | | | Placed a short description of this top-level directory in the chapter. (From yocto-docs rev: 49f8cf264d10e37933502067c522f1c2e3ffe751) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the "Source Directory Structure" chapter.Scott Rifenbark2014-03-301-5/+53
| | | | | | | | | | Added the buildhistory directory. Added the deploy/sdk directory. Beefed up the tmp and build directory descriptions. (From yocto-docs rev: 3ac9435a48b6da730e640b204ba3f41daebc39e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed a typo.Robert P. J. Day2013-12-031-1/+1
| | | | | | | (From yocto-docs rev: 2370b51819585023da79d63b2c6704ce68e5c2ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Tweaks to the structure chapter.Robert P. J. Day2013-12-031-33/+26
| | | | | | | | | | | | Significant tweaks: * removal of (confusing) leading slashes from YP filenames * deletion of reference to non-existent "build/tmp/pkgdata/" (From yocto-docs rev: c105ae9c6741fbe195addf52d313925bab50ba40) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed the pseudodone section in the build structureScott Rifenbark2013-12-031-9/+0
| | | | | | | | | | This folder disappeared and I was not told about it. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: d2526d773d282cf81e81f60745a47fbdc9625254) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the description for oe-init-build-env-memresScott Rifenbark2013-12-031-12/+13
| | | | | | | | | | | Added more wording to clearly state what is going on when you run this script. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 2b23966d80b2787f7eddcbf6c635220d58d7a494) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated bitbake/ section to remove wrapper scriptScott Rifenbark2013-12-031-68/+72
| | | | | | | | | | | Robert P. J. Day noted that the bitbake command no longer uses a wrapper as the section indicated. I have removed this reference. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: a523d4d4fc57edabfa4aa7d20e154cdc43d35fca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added information for OEROOT and build environmentScott Rifenbark2013-09-121-20/+96
| | | | | | | | | | | | | | | | | | | Fixes [YOCTO #4980] Added a new glossary entry for OEROOT. Added significant information to the local.conf and bblayers.conf reference sections to describe how the root build directory is derived. Also, some unrelated formatting to the DL_DIR variable description was mixed in here because I forgot to commit that separatey and it lives in the same variables.xml file. (From yocto-docs rev: c397a31f5b0d3f6257657119a4e81b4fbdc3800c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added the memory-resident BitBake featureScott Rifenbark2013-09-121-8/+99
| | | | | | | | | | | | | | | | | | | | | | | | The main changes are captured in a new section devoted to the oe-init-build-env-memres script within the ref-structure.xml file and in the variables.xml file in a BBSERVER variable entry in the glossary. All other changes were necessary to integrate the new functionality into areas where running the setup script are discussed. Before this feature, there was a single setup script (oe-init-build-env). Consequently, wordings and such were designed exclusively for this single method. With the introduction of a second possible method to initialize the build environment, tweaks to many sections were needed. Beside the wording tweaks, appropriate cross-referencing was also needed. All these changes cover the integration of the new feature. Reported-by: Richard Purdie <richard.purdie@linuxfoundation.org> (From yocto-docs rev: c55c9a53c9b4cd1e06e6e81e32d56f9bbf5fe98c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual, Makefile: Updates to expanded dev sectionScott Rifenbark2013-08-131-2/+3
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #2808] Applied review comments to the "Images" and SDK sections that are part of the "A Closer Look at the Yocto Project Development Environment" section. Comments from Paul. They resulted in a single figure being removed and split into two new figures - one for the image part and one for the sdk part. Some terminology issues were cleaned up in the main sections as well as the documented variables sections. Makefile changes involved adding the two new figures and removing the old combined one. (From yocto-docs rev: a32908fa68b9786e295097c16f70a5a9c3cc4c1e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, mega-manual: New section for images/SDKScott Rifenbark2013-08-131-1/+8
| | | | | | | | | | | | | Fixes [YOCTO #2808] Added a new section for the closer look at how BitBake creates images and the SDK installer files. This included the section itself, a new .PNG figure that had to be added to the figures directory of both the ref-manual and the mega-manual. Finally, the Makefile needed to be edited so that the tarballs for the ref-manual and mega-manual also included the new figure. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Corrected typo.Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: 980a2884895a39c04baea87da6ed1145a830192f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new "meta/recipes-lsb4/" entry.Scott Rifenbark2013-04-041-0/+9
| | | | | | | (From yocto-docs rev: 71b18c971839125f8d6a1d04c3c1290559c4f923) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added "meta/lib/" directory and moved it.Scott Rifenbark2013-04-041-0/+20
| | | | | | | | | | Placed the "meta/lib/" and "meta/files/" descriptions beneath "meta/conf/*" to match the actual repo. (From yocto-docs rev: 74b9cb2b42db7f6acd5a19a1856ede98ff29e775) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Grammar fix in "meta/recipes-support/".Scott Rifenbark2013-04-041-2/+3
| | | | | | | (From yocto-docs rev: df3a86f206157a340fef166050f8b0ca18c7c440) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Reword in "meta/conf/distro/".Scott Rifenbark2013-04-041-1/+2
| | | | | | | (From yocto-docs rev: 6653c450ba042f9768bd59ee37c98a28d72dd750) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Fixed syntax in "meta/conf/machine/".Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: bd84a06b55806d1939837cfcd7f6159fe70594ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Cleared up ambiguity in "meta/conf".Scott Rifenbark2013-04-041-1/+2
| | | | | | | (From yocto-docs rev: ce6da6f20bd721641b569c3dd57850e9ec6538cf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a link to "meta/classes/".Scott Rifenbark2013-04-041-0/+5
| | | | | | | (From yocto-docs rev: 1de11d1812f09106214e76226b424b15e7e9d4f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added a link to "The Metadata - meta/" section.Scott Rifenbark2013-04-041-1/+3
| | | | | | | (From yocto-docs rev: cfc264ce537eb8db93aeeecc25c1b52b975bdea8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "build/tmp/work/".Scott Rifenbark2013-04-041-5/+5
| | | | | | | (From yocto-docs rev: 6b3e453abb3b960b4d5c921cc359bea5143cb676) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "/build/tmp/deploy/images/".Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: 16c994231d1b201568881d3e0cb54956b90947f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added link to "build/tmp/deploy/licenses/".Scott Rifenbark2013-04-041-0/+3
| | | | | | | (From yocto-docs rev: fb76845242cb664f7f851eeb1044a222a85b3289) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "buid/tmp/deploy/".Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: 83a33a41717c13473c4743028807f907f11a748e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "build/tmp/cache".Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: 1a453c9a2fe0cf36bed8ad11f6cfc3943e703e47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "build/tmp".Scott Rifenbark2013-04-041-2/+2
| | | | | | | (From yocto-docs rev: 4972b97b456e88ef352c6a07534c44b12b80d398) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "build/sstate-chache/".Scott Rifenbark2013-04-041-3/+4
| | | | | | | | | Small correction to "build/downloads" as well. (From yocto-docs rev: ae8cf055ba14c1223b0834d9acd662e3707dfc58) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "bulid/downloads/".Scott Rifenbark2013-04-041-2/+3
| | | | | | | (From yocto-docs rev: 83528239bc84f503e0d3a9f50160d9f2a8b669af) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "build/conf/sanity_info".Scott Rifenbark2013-04-041-1/+2
| | | | | | | (From yocto-docs rev: dae309671ac4a5dd49747da0d4db40a148e3339a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "build/conf/bblayers.conf".Scott Rifenbark2013-04-041-1/+3
| | | | | | | (From yocto-docs rev: d31627e11b5298baf517d062eb6c9635d7f68763) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "build/conf/local.conf".Scott Rifenbark2013-04-041-1/+1
| | | | | | | (From yocto-docs rev: 3b2ad515a99605e3e614ea1f72e0266e801e2211) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added an intro to the build directory section.Scott Rifenbark2013-04-041-0/+7
| | | | | | | (From yocto-docs rev: a4e4fe233a3a32eebca824deb971c454cfec05ac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Changed wording for consistency.Scott Rifenbark2013-04-041-2/+1
| | | | | | | (From yocto-docs rev: 8f8d8d3dea2ce20c547432a85140519a3a2876d7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added an intro statement to "Top-Level Components".Scott Rifenbark2013-04-041-1/+6
| | | | | | | (From yocto-docs rev: ce21e049bca0752d75ac01ced59dc6bb8179d03f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "oe-init-build-env".Scott Rifenbark2013-04-041-9/+10
| | | | | | | (From yocto-docs rev: a15772bc73fe346ae96304f3d1d116958fee0c49) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "scripts/".Scott Rifenbark2013-04-041-2/+3
| | | | | | | (From yocto-docs rev: ae3f23952a91e4d3d68cd758ec127593e8e297ee) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits and fixes to "meta-hob/".Scott Rifenbark2013-04-041-4/+9
| | | | | | | | | Broken link to Hob webpage fixed. (From yocto-docs rev: 70f238f10641c20ab78314fe2bbb768560f31ea6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "meta/" section.Scott Rifenbark2013-04-041-2/+2
| | | | | | | (From yocto-docs rev: f9dd1debc8d9f0240957b5ad7c60a4fa42a7d469) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "build/" section.Scott Rifenbark2013-04-041-2/+4
| | | | | | | (From yocto-docs rev: c0f6e737d69f69cf2966670273306bbfe742c13f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Minor edits to "bitbake/" section.Scott Rifenbark2013-04-041-3/+5
| | | | | | | (From yocto-docs rev: 9d697cde9a1c5367e4529465b7c5a1443657b31b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Rename of poky-ref-manual folder to ref-manual.Scott Rifenbark2013-01-071-0/+709
Changing the folder that holds the YP Reference Manual to be "ref-manual". This will help with confustion over the manual's intended purpose. (From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1) 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-11-12 04:52:13 +0000