Commit Graph

34 Commits

Author SHA1 Message Date
Scott Rifenbark 89ca97371d ref-manual: Added information for OEROOT and build environment
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-12 16:50:12 +01:00
Scott Rifenbark a266619317 documentation: Added the memory-resident BitBake feature
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-09-12 16:50:10 +01:00
Scott Rifenbark 93c76f4c65 ref-manual, mega-manual, Makefile: Updates to expanded dev section
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-13 13:18:47 +01:00
Scott Rifenbark 4b23d26063 ref-manual, mega-manual: New section for images/SDK
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-08-13 13:18:47 +01:00
Scott Rifenbark 64ce1b81da ref-manual: Corrected typo.
(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-04 14:12:57 +01:00
Scott Rifenbark 857a766fe0 ref-manual: Added new "meta/recipes-lsb4/" entry.
(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-04 14:12:57 +01:00
Scott Rifenbark 5a626d8941 ref-manual: Added "meta/lib/" directory and moved it.
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-04 14:12:56 +01:00
Scott Rifenbark ac048523e5 ref-manual: Grammar fix in "meta/recipes-support/".
(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-04 14:12:56 +01:00
Scott Rifenbark 2dc1756e0e ref-manual: Reword in "meta/conf/distro/".
(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-04 14:12:56 +01:00
Scott Rifenbark 8bd7304390 ref-manual: Fixed syntax in "meta/conf/machine/".
(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-04 14:12:55 +01:00
Scott Rifenbark 4fadd757cd ref-manual: Cleared up ambiguity in "meta/conf".
(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-04 14:12:55 +01:00
Scott Rifenbark 619e88f9c4 ref-manual: Added a link to "meta/classes/".
(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-04 14:12:55 +01:00
Scott Rifenbark f06259cbf4 ref-manual: Added a link to "The Metadata - meta/" section.
(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-04 14:12:55 +01:00
Scott Rifenbark 87166fdc0f ref-manual: Minor edits to "build/tmp/work/".
(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-04 14:12:55 +01:00
Scott Rifenbark 169d5acd53 ref-manual: Minor edits to "/build/tmp/deploy/images/".
(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-04 14:12:55 +01:00
Scott Rifenbark adfbcde7d3 ref-manual: Added link to "build/tmp/deploy/licenses/".
(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-04 14:12:55 +01:00
Scott Rifenbark 4546aa1ca3 ref-manual: Minor edits to "buid/tmp/deploy/".
(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-04 14:12:55 +01:00
Scott Rifenbark 6f594e96d4 ref-manual: Minor edits to "build/tmp/cache".
(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-04 14:12:55 +01:00
Scott Rifenbark 13e4ba8b30 ref-manual: Minor edits to "build/tmp".
(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-04 14:12:55 +01:00
Scott Rifenbark 7b74c75d35 ref-manual: Minor edits to "build/sstate-chache/".
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-04 14:12:55 +01:00
Scott Rifenbark f24c079c69 ref-manual: Minor edits to "bulid/downloads/".
(From yocto-docs rev: 83528239bc84f503e0d3a9f50160d9f2a8b669af)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark 355e35c2d6 ref-manual: Minor edits to "build/conf/sanity_info".
(From yocto-docs rev: dae309671ac4a5dd49747da0d4db40a148e3339a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark dd177d7e1f ref-manual: Minor edits to "build/conf/bblayers.conf".
(From yocto-docs rev: d31627e11b5298baf517d062eb6c9635d7f68763)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark 6ce2cb9024 ref-manual: Minor edits to "build/conf/local.conf".
(From yocto-docs rev: 3b2ad515a99605e3e614ea1f72e0266e801e2211)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark dd54445d16 ref-manual: Added an intro to the build directory section.
(From yocto-docs rev: a4e4fe233a3a32eebca824deb971c454cfec05ac)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark 47fb5904eb ref-manual: Changed wording for consistency.
(From yocto-docs rev: 8f8d8d3dea2ce20c547432a85140519a3a2876d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark e2e5cad805 ref-manual: Added an intro statement to "Top-Level Components".
(From yocto-docs rev: ce21e049bca0752d75ac01ced59dc6bb8179d03f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark d9b24ac5e7 ref-manual: Minor edits to "oe-init-build-env".
(From yocto-docs rev: a15772bc73fe346ae96304f3d1d116958fee0c49)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark e99437d8fb ref-manual: Minor edits to "scripts/".
(From yocto-docs rev: ae3f23952a91e4d3d68cd758ec127593e8e297ee)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:54 +01:00
Scott Rifenbark 8970eb2eae ref-manual: Minor edits and fixes to "meta-hob/".
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>
2013-04-04 14:12:54 +01:00
Scott Rifenbark cd1906f75e ref-manual: Minor edits to "meta/" section.
(From yocto-docs rev: f9dd1debc8d9f0240957b5ad7c60a4fa42a7d469)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:53 +01:00
Scott Rifenbark fe7dd1ca9b ref-manual: Minor edits to "build/" section.
(From yocto-docs rev: c0f6e737d69f69cf2966670273306bbfe742c13f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:53 +01:00
Scott Rifenbark dbcfb9eb15 ref-manual: Minor edits to "bitbake/" section.
(From yocto-docs rev: 9d697cde9a1c5367e4529465b7c5a1443657b31b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-04-04 14:12:53 +01:00
Scott Rifenbark ed0a240e16 documentation: Rename of poky-ref-manual folder to ref-manual.
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>
2013-01-07 14:43:25 +00:00