aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-structure.xml
AgeCommit message (Collapse)Author
2016-04-18documentation: Converted "meta-yocto" to "meta-poky"Scott Rifenbark
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>
2016-03-23dev-manual, profile-manual, ref-manual: Updates to remove meta-toolchainScott Rifenbark
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>
2016-03-23ref-manual, sdk-manual: Changed section heading.Scott Rifenbark
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>
2016-03-23ref-manual: Resolving a conflictScott Rifenbark
(From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23documentation: remove all references to HobBelen Barros Pena
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>
2016-01-15ref-manual: Updates to cull out qt4 stuff.Scott Rifenbark
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>
2015-04-15ref-manual: Updated the section on oe-init-build-env-memresScott Rifenbark
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>
2015-04-15ref-manual: Fixed two spelling errors.Scott Rifenbark
(From yocto-docs rev: 2725c01a396a877cfa70471238d8195673ed53ff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-10ref-manual: Update to oe-init-build-env-memres description.Scott Rifenbark
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>
2015-04-01ref-manual: Downplayed the BBLAYERS_NON_REMOVABLE variable.Scott Rifenbark
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>
2015-02-17documentation: First draft devtools.Scott Rifenbark
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>
2015-02-17ref-manual, dev-manual, adt-manual, yocto-project-qs: scrub eglibcScott Rifenbark
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>
2015-02-17dev-manual, ref-manual, yocto-project-qs: Updates to parallelism variablesScott Rifenbark
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>
2014-10-18ref-manual: Scrubbed for variable (user) input.Scott Rifenbark
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>
2014-07-21ref-manual, yocto-project-qs: Fixed some references to BitBake Manual.Scott Rifenbark
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>
2014-06-18dev-manual, kernel-dev, ref-manual: Updated task name usage.Scott Rifenbark
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>
2014-06-18ref-manual, dev-manual: Updates for custom template configuration directory.Scott Rifenbark
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>
2014-05-30ref-manual: Updated reference sections for environment setup scripts.Scott Rifenbark
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>
2014-04-01ref-manual: Added the build/tmp/work-shared directory.Scott Rifenbark
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>
2014-04-01ref-manual: Added the build/tmp/sstate-control directoryScott Rifenbark
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>
2014-04-01ref-manual: Added the meta/conf/machine-sdk directoryScott Rifenbark
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>
2014-04-01dev-manual, ref-manual: Removed meta-hob layer from docs.Scott Rifenbark
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>
2014-04-01ref-manual: Added top-level meta-selftest directoryScott Rifenbark
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>
2014-03-30ref-manual: Edits to the "Source Directory Structure" chapter.Scott Rifenbark
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>
2013-12-03ref-manual: Fixed a typo.Robert P. J. Day
(From yocto-docs rev: 2370b51819585023da79d63b2c6704ce68e5c2ca) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03ref-manual: Tweaks to the structure chapter.Robert P. J. Day
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>
2013-12-03ref-manual: Removed the pseudodone section in the build structureScott Rifenbark
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>
2013-12-03ref-manual: Updated the description for oe-init-build-env-memresScott Rifenbark
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>
2013-12-03ref-manual: Updated bitbake/ section to remove wrapper scriptScott Rifenbark
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>
2013-09-12ref-manual: Added information for OEROOT and build environmentScott Rifenbark
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>
2013-09-12documentation: Added the memory-resident BitBake featureScott Rifenbark
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>
2013-08-13ref-manual, mega-manual, Makefile: Updates to expanded dev sectionScott Rifenbark
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>
2013-08-13ref-manual, mega-manual: New section for images/SDKScott Rifenbark
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>
2013-04-04ref-manual: Corrected typo.Scott Rifenbark
(From yocto-docs rev: 980a2884895a39c04baea87da6ed1145a830192f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Added new "meta/recipes-lsb4/" entry.Scott Rifenbark
(From yocto-docs rev: 71b18c971839125f8d6a1d04c3c1290559c4f923) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Added "meta/lib/" directory and moved it.Scott Rifenbark
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>
2013-04-04ref-manual: Grammar fix in "meta/recipes-support/".Scott Rifenbark
(From yocto-docs rev: df3a86f206157a340fef166050f8b0ca18c7c440) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Reword in "meta/conf/distro/".Scott Rifenbark
(From yocto-docs rev: 6653c450ba042f9768bd59ee37c98a28d72dd750) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Fixed syntax in "meta/conf/machine/".Scott Rifenbark
(From yocto-docs rev: bd84a06b55806d1939837cfcd7f6159fe70594ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Cleared up ambiguity in "meta/conf".Scott Rifenbark
(From yocto-docs rev: ce6da6f20bd721641b569c3dd57850e9ec6538cf) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Added a link to "meta/classes/".Scott Rifenbark
(From yocto-docs rev: 1de11d1812f09106214e76226b424b15e7e9d4f0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Added a link to "The Metadata - meta/" section.Scott Rifenbark
(From yocto-docs rev: cfc264ce537eb8db93aeeecc25c1b52b975bdea8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Minor edits to "build/tmp/work/".Scott Rifenbark
(From yocto-docs rev: 6b3e453abb3b960b4d5c921cc359bea5143cb676) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Minor edits to "/build/tmp/deploy/images/".Scott Rifenbark
(From yocto-docs rev: 16c994231d1b201568881d3e0cb54956b90947f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Added link to "build/tmp/deploy/licenses/".Scott Rifenbark
(From yocto-docs rev: fb76845242cb664f7f851eeb1044a222a85b3289) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Minor edits to "buid/tmp/deploy/".Scott Rifenbark
(From yocto-docs rev: 83a33a41717c13473c4743028807f907f11a748e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Minor edits to "build/tmp/cache".Scott Rifenbark
(From yocto-docs rev: 1a453c9a2fe0cf36bed8ad11f6cfc3943e703e47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Minor edits to "build/tmp".Scott Rifenbark
(From yocto-docs rev: 4972b97b456e88ef352c6a07534c44b12b80d398) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04ref-manual: Minor edits to "build/sstate-chache/".Scott Rifenbark
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>
2013-04-04ref-manual: Minor edits to "bulid/downloads/".Scott Rifenbark
(From yocto-docs rev: 83528239bc84f503e0d3a9f50160d9f2a8b669af) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>