Commit Graph

18 Commits

Author SHA1 Message Date
Scott Rifenbark ec27a7873b ref-manual: Read-through edits to "Closer Look" chapter.
Minor fixes throughout.

(From yocto-docs rev: d44ae0da21d84acbe1556824e228c7ab0af1ba2c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-30 10:18:38 +01:00
Scott Rifenbark 32890f29af adt-manual, ref-manual: Cross-toolchain details added. New class also.
In the adt-manual in the "Optionally Building a Toolchain Installer"
setion, I added some basic advantage information for building a
toolchain installer using bitbake image -c populate_sdk.

In the ref-manual, I added cross-referencing to this basic information
in several strategic areas: "SDK Generation", the populate_sdk class
reference section, the populate_sdk_* class reference section, and the
"Cross-Development Toolchain Generation" sections.

Finally, I also put in documentation for a new class called
autotools-brokensep.

(From yocto-docs rev: cde7dd2fbd7bdc0d71dc678ee7a5422459654287)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:44 +00:00
Scott Rifenbark 7a5cd2123a ref-manual, mega-manual: Added manifest file information
Fixes [YOCTO #5410]

I updated the figure that shows what do_rootfs does to create
the image.  The new addition is the creation of the .manifest file
that lists out package information in the image.  Supporting text
was also added in the section.

The updated figure was needed in both the ref-manual and
mega-manual figures folders.

Also, part of the fix included a new variable description for the
IMAGE_MANIFEST variable.

(From yocto-docs rev: 770448e0e8ce2e2c517ced5e71f5a916fefe5cf2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-03-25 12:29:44 +00:00
Scott Rifenbark 3e54f28497 ref-manual: Added link to SDKPATH variable.
Fixes [YOCTO #5755]

Put a link in the SDK section of the "Closer Look" chapter. The
link goes back to the SDKPATH variable.

(From yocto-docs rev: 7420da33bfa89625b5bbf592416c7f07780f8285)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-02-11 12:01:32 +00:00
Scott Rifenbark 936cc69a89 ref-manual: Cleaned up some instances of the term "working directory"
This term should always reference a users current working directory
and not be confused with the OpenEmbedded build system's "work
directory (WORKDIR).  I found several instances where the term
"working directory" was not used correctly and fixed them.

Reported-by: Robert P. J. Day <rpjday@crashcourse.ca>
(From yocto-docs rev: 300c78c1d54b2a4fbb8ecca03faa7c8c67bdc54f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:15 +00:00
Robert P. J. Day 2a8596d06a ref-manual: Grammar and typo edits to "Closer Look" section.
Patch applied from Robert P. J. Day that basically amounted to
a good review of this section.  Robert caught several typos and
small writing issues throughout the section.

(From yocto-docs rev: e44bb5897dbcc7e96bfbc730f6abe87cc2df2f3f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-12-03 12:53:02 +00:00
Scott Rifenbark 155961db71 ref-manual: Updated the "Images" section.
changed the wording for where the DEPLOY_DIR_IMAGE directory
points to per Paul Eggleton's suggestion.

(From yocto-docs rev: eaa48e4dc54bf07431d389de6064329f2173ea68)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-10-01 22:52:53 +01:00
Scott Rifenbark 6084246825 ref-manual, yocto-project-qs: Explanations for Git tarballs
Fixes [YOCTO #5035]

By default, the DL_DIR does not get files from Git repositories
that are suitable for mirroring.  There is a work-around by
using the BB_GENERATE_MIRROR_TARBALLS variable, which, when
set, causes the build system to generate tarballs for the
Git repositories and place them in the DL_DIR.

To address this, I added a new variable description for the
BB_GENERATE_MIRROR_TARBALLS varible, updated the DL_DIR
variable to indicate that "out-of-the-box" the YP puts suitable
mirror files into the DL_DIR for everthing except Git
repositories.

Some other sections were updated where discussion revolved around
pulling down source files.  The QS had a spot where the
BB_GENERATE_MIRROR_TARBALLS variable was actually used in an
example.  And, the expanded discussion on the BitBake process
had a couple spots that deserved a mention.

(From yocto-docs rev: 1539ff13222449ba60bfaaaac4fe1e8a795b0039)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:48 +01:00
Scott Rifenbark 2effece91b ref-manual, mega-manual: Updates to the SDK Generation section
Fixes [YOCTO #2808]

I updated the figure to not call out the SDK environment setup
script as it is part of the .sh file.  The figure was placed
in the "figures" directory of the ref-manual and the
mega-manual.

Also, I removed the duplicated variable descriptions and referenced
these descriptions in the "Application Development SDK" section,
which is further down in the manual.  The descriptions have more
to do with where output is placed.

(From yocto-docs rev: 256bb1447b571299b57c657bf030d5b4f033fb5f)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:48 +01:00
Scott Rifenbark 26354c2715 ref-manual, mega-manual: Updates to "Image Generation"
Fixes [YOCTO #2808]

Updated the figure and placed it in the folders area for both
the ref-manual and mega-manual.  I had to add the
DEPLOY_DIR_IMAGE variable and create a new machine-specific
directory below deploy.  The text had to be adjusted to reflect
this change as well.

Also, created a new variable entry for DEPLOY_DIR_IMAGE for
the glossary of the ref-manual.

(From yocto-docs rev: 50a68810f854b32fa5dba477eafa8fd1eebbd7a4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:48 +01:00
Scott Rifenbark 9cef06f693 ref-manual: Update to the image generation section.
Fixes [YOCTO #2808]

Applied some Eggleton review edits to the image generation section.
Minor tweaks and a cross-reference to the read-only root
filesystem section in the dev-manual.

(From yocto-docs rev: e41a08872e398d10c452bb5e1f1e6af41a525ab2)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:47 +01:00
Scott Rifenbark 35bd82a78f ref-manual: New section on SDK generation
Fixes [YOCTO #2808]

New section on the deeper look at SDK generation.  This is a first
draft.

(From yocto-docs rev: 54438f1a9dac847d2d03ca1cb9a2b00de9369dbe)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:47 +01:00
Scott Rifenbark 80c66fd7ce ref-manual, mega-manual: Updates to the Image Generation section
Fixes [YOCTO #2808]

Applied review comments to the section from Paul Eggleton.  I
updated the figure and the text areas.

(From yocto-docs rev: a89b126861e8ee2f43a89afb0a16e56659270fee)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:46 +01:00
Scott Rifenbark 25bea918aa ref-manual: Edits to the "Image Generation" section
Fixes [YOCTO #2808]

Did a self-edit here to try and straighten out how I am mapping
the variables to the actual figure.

(From yocto-docs rev: 82e94d8a8221bbf2eb5feb19a6642907b4ff490b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:44 +01:00
Scott Rifenbark b577e74096 ref-manual: First draft of the "Image Generation" section
Fixes [YOCTO #2808]

Added the first draft of the expanded explanation for generating
an image.

(From yocto-docs rev: 72e4db25d89cad62e1cd9ee1d638af374ec1bfc0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:44 +01:00
Scott Rifenbark 673b28f6db ref-manual, mega-manual: Updated figure for source fetching
Fixes [YOCTO #2808]

The Build Directory should be inside the BB blue box here and
not outside of it.  Adjusted the figure, which resides in
the figures directory of both the ref-manual and the
mega-manual.  Also had to widen the image footprint to make
it readable.

(From yocto-docs rev: b4ff9292cf629894fda6ad4a29fbdaad85f43cd0)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-22 12:20:44 +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 cc265bf535 ref-manual: Created new "Closer Look" chapter
Fixes [YOCTO #2808]

I extracted the section that takes a closer look at the YP
development process into its own chapter.  Feedback during the
review indicated that this information should not be buried as
it was in a section but rather pulled higher out for visibility.

So, The changes create a new chapter three that is dedicated to
this topic.

(From yocto-docs rev: 32c66976b6b84787d14d6174dab843862a0d184b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:09 +01:00