Commit Graph

42 Commits

Author SHA1 Message Date
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 43c10b90ad ref-manual, mega-manual, Makefile: New figure added for sdk
Fixes [YOCTO #2808]

Added a new figure to support the expanded section on SDK
generation.  Figure added to "figures" directory for both
the ref-manual and the mega-manual.  Updated Makefile to
include the figure in the TARBALL variable for both the
manuals.

(From yocto-docs rev: 41f78fddfd871fdd4c1c963b98093567d4b4d230)

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 34c46b33a0 ref-manual, mega-manual: Updated the image generation figure
Fixes [YOCTO #2808]

Had to update the figure.

(From yocto-docs rev: 9b9b168bee84d32da0838da7940cb1ae7d780bee)

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 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 72c73e67ca ref-manual, mega-manual: Revised the image generation figure
Fixes [YOCTO #2808]

Moved some variables around to make better sense of how I
think it works.

(From yocto-docs rev: 2f40edbb792d56808482fdc3a1bf3d3457673546)

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 da7a072aa0 dev-manual, ref-manual, Makefile: Added image generation figure
Fixes [YOCTO #2808]

Created the figure for the BitBake-resident image generation
discussion.  Figure added to the Makefile so it is included
in the TARBALLS for ref-manual and mega-manual.

(From yocto-docs rev: 607c88dcf060a804475b2f4b9cf22f2d8172a61d)

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 3c4f2a6118 ref-manual, mega-manual: Updated source input figure
Fixes [YOCTO #2808]

I tweaked the SCM box in the figure so that the connection to
real SCMs is better.  This was causing confusion.

(From yocto-docs rev: f4080315ab6b57068ab2fbb948c52f731d1ea5dd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:11 +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 2fe0213997 ref-manual, mega-manual: Updates to config and package splitting figs
Fixes [YOCTO #2808]

Found some errors in how I was labeling the various directories
created in the Build Directory upon image configuration.  I corrected
the labeling by editing these two figures.

(From yocto-docs rev: 4a08ad8bda0617e18b9998b794267f743e445eaa)

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 973fd9b7b1 ref-manual, mega-manual: Updated two figures
Fixes [YOCTO #2808]

Updated the images and SDK figures so the outside box would be
red as that is what it is in the general figure.

(From yocto-docs rev: 8f43a328c68bdb96e6b7cc1086400c8e3493d3b7)

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 fdc1ad2936 ref-manual, mega-manual: Edits to figures
Fixes [YOCTO #2808]

I made some small cosmetic corrections to two figures in the
expanded look at YP process chapter.

(From yocto-docs rev: 50950f7ae6ea87cde1a9228837aa15985c88b579)

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
Scott Rifenbark b359e9a981 ref-manual, mega-manual: Updates to process figures
Fixes [YOCTO #2808]

Updated several figures to get rid of shadows and gradients in the
colors.  This completes the work on getting the figures to all be
consistent.

(From yocto-docs rev: 9e59810ed4772cd75ffe1604b66afe16e9cf9c67)

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
Scott Rifenbark 78e209d346 ref-manual, mega-manual: Updated package-feeds diagram
Fixes [YOCTO #2808]

Modified the BitBake box to have a "spatula" form to be like
the BitBake box in the more general diagram.

(From yocto-docs rev: f42867929336c807977a584fba42613cbca44dfc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:08 +01:00
Scott Rifenbark 6a18edd8e2 ref-manual, mega-manual: Updated the analysis figure.
Fixes [YOCTO #2808]

Updated the analysis-for-package-splitting.png figure so that
the BitBake box has the "spatula" form used in the regular
overview picture.

(From yocto-docs rev: 4ef43f3a4f96b867ab0985aa70996abe4c2caf75)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:08 +01:00
Scott Rifenbark 661c27d2c7 ref-manual, mega-manual: Updated the configuration figure
Fixes [YOCTO #2808]

Updated the configuration-compile-autoreconf.png figure so that
the general shape of the BitBake box represents the "spatula"
form used in the general overview figure.

(From yocto-docs rev: b4c81b94a3ced5645a92076022abc4a3938be5b3)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:08 +01:00
Scott Rifenbark 8cb2038c70 ref-manual, mega-manual: Updated the patching figure
Fixes [YOCTO #	2808]

Updated the figure for patching so that it uses the "spatula"
type BitBake shape rather than a square box.

(From yocto-docs rev: 61c2bdc1a0d6f33d18f5fef1b0640213b899ec63)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:08 +01:00
Scott Rifenbark ddb29c561c ref-manual, mega-manual: Updated the source fetching figure
Fixes [YOCTO #2808]

Updated the figure to use the "spatula" type version of the
general BitBake box.  Also had to adjust the width a bit to
get the figure to display correctly.

(From yocto-docs rev: 3049e20eb215b00e61dabed9c124fa8ebc6c946b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:07 +01:00
Scott Rifenbark 27b499841a ref-manual, mega-manual: Updated ADK figure
I modified the sdg.png figure that shows detail for SDK
generation by creating a spatula-like shape for the general
BitBake box.

(From yocto-docs rev: 597d121e8286d51be73f87594d2f99354621c112)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-09-12 16:50:06 +01:00
Scott Rifenbark d63e6a925a ref-manual: Edits to figures
I updated several figures to implement some of Dave Stewart's
review feedback for the expanded section on the build process.

(From yocto-docs rev: abd78cd6eaad8173ef8f9b3376c323875e5c4542)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-30 18:14:13 +01:00
Scott Rifenbark 987f91e16c ref-manual, mega-manual: Edits for expanded packaging description
Fixes [YOCTO #2808]

Applied review comments to the package splitting section in the
section that digs deeper into the build process.  This involved
updating the figure that resides in both "figures" directories
of the ref-manual and the mega-manual. Also updated supporting
text throughout the section per Paul's comments.

(From yocto-docs rev: 34e3610d0c6912530f678e9f1fa4587aaaf9fc70)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-30 18:14:13 +01:00
Scott Rifenbark a50b9337c6 ref-manual, mega-manual: Updated figure for conf/compile details
Fixes [YOCTO #2808]

Updated the figure per Paul Eggleton's feedback to be clearer.
The figure resides in both the ref-manual and the mega-manual.

(From yocto-docs rev: 8a0f391c9404582b3b7f62d740d5c0488a6220be)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:31 +01:00
Scott Rifenbark 6457ad3f28 ref-manual, mega-manual: New section on package creation
Fixes [YOCTO #2808]

Added a new section to the expanded discussion on how builds
are done.  This section is on package creation.  A new figure
was added to both the ref-manual and mega-manual figures
directories.

(From yocto-docs rev: e31e5aeb7d93f3cfa4fc9c12e324f03a27b5f8ed)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:30 +01:00
Scott Rifenbark bf91da6c0a ref-manual, mega-manual: new section on config/compile for expanded build
Fixes [YOCTO #2808]

Added a new section on configuration and compilation for the
expanded discussion for the build process.  This involved a new
figure that had to be added to both the ref-manual and
mega-manual figures directories.

(From yocto-docs rev: 9ba90c79990b79226d6e95e4a01ddedeccb94b35)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:30 +01:00
Scott Rifenbark 8870546272 ref-manual, mega-manual: Updated figures
Fixes [YOCTO #2808]

Updated a couple figures to be consistent for how directories
and their contents are displayed.

(From yocto-docs rev: 5a3d08b2543c5ea1f76d65d67bf8a5615f6b5a0e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:30 +01:00
Scott Rifenbark 06c124b02d ref-manual: New section on patching for expanded build process
Fixes [YOCTO #2808]

Added a new sub-section to the BitBake section that takes a
closer look at the build process.  Part of the requirements
was a new figure that had to be added to both the ref-manual
and the mega-manual figures directories.

(From yocto-docs rev: c40476b079cf5765b8228502f0ef33072f8b2b85)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:29 +01:00
Scott Rifenbark a0eec0d86f ref-manual, Makefile: New section on BitBake for expanded build
Fixes [YOCTO #2808]

Created a new section called "BitBake" that will provide an
expanded discussion of the basic YP build process.  The
"BitBake" section has a new sub-section called "Source Fetching."

Part of the new section is a new figure named source-fetching.png.
The figure must reside in the "figures" directory in both the
ref-manual and the mega-manual.  It must also be listed for each
of these manuals in the TARBALL statement in the Makefile.

(From yocto-docs rev: 41eff3e755a98ff31cadccfb1cd7dfcf569b4d9e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-26 11:06:29 +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 96ce7dcedf ref-manual: New section on Package Feeds.
Fixes [YOCTO #2808]

New section for package feeds created.  Includes a new figure
also.

(From yocto-docs rev: 6d8b41114ebadcfb06f6064a13c4da5b47a9f73c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:43 +01:00
Scott Rifenbark 69b317f38a ref-manual: Edits to the "source" section of yp dev environment
Fixes [YOCTO #2808]

I updated the "Sources" section with review comments from
Paul.  The figure needed changed as well as some text changes.

(From yocto-docs rev: 0a44dbdebce50fb599b8dcb2f17adc76f9fb862c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:41 +01:00
Scott Rifenbark dc7f6e7d30 ref-manual: First draft of the "Sources" section added.
Fixes [YOCTO #2808]

The "Sources" section provides a more detailed look at where
BitBake gets source files from.  This change included the
first draft of the text and the first draft of the expanded
figure.

(From yocto-docs rev: 4e432a05666e67c6494486f392a05f629c6c148a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:41 +01:00
Scott Rifenbark f3b97fade2 ref-manual: Another round of edits from Paul implemented.
Fixes [YOCTO #2808]

Some small changes to the layer figure and the software
layer wording.

(From yocto-docs rev: 687652a4970910de8a4636999f63ad5c7e861069)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:40 +01:00
Scott Rifenbark cb66b6e1a2 ref-manual: Review comments added.
Fixes [YOCTO #2808]

Applied review comments from Paul Eggleton on the user configuration
and the layers section.  Changes applied to the figure for the
user configuration section as well.

(From yocto-docs rev: b05af4b740f0daf3d6c59acf71c362decba2a176)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:40 +01:00
Scott Rifenbark c7ac8851c8 ref-manual: Review comments for config and layer sections.
Fixes [YOCTO #2808]

I applied extensive review comments to the user configuration
and to the layer sections.  These revisions also included
updates to the two figures.

(From yocto-docs rev: 029692b07cb7dff605b81aa45de7c891a3a77db1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:40 +01:00
Scott Rifenbark 7c8831bf5c ref-manual: Added new overview figure.
Fixes [YOCTO #2808]

This figure is slightly different than our reference environment
figure used in the QS.  I did not want to simply duplicate it.
Here the only difference is boxing in the metadata layer input
to the left.

(From yocto-docs rev: d1c8c69dfb5ec4261b8e5d15de6d5088fde86024)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:40 +01:00
Scott Rifenbark 1adebc081d ref-manual: Added new section for layer input detail.
(From yocto-docs rev: ff952a9681df798cde34b50d1046233a47ca0ce5)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:39 +01:00
Scott Rifenbark 20b0437f50 ref-manual: New figure added for Layer section.
(From yocto-docs rev: 3a1101fb66e9fc4e708a601a0153d18b3c10e1f4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:39 +01:00
Scott Rifenbark 0345088d58 ref-manual: New user configuration figure added.
(From yocto-docs rev: ec8e9de1fb42b8d6aaecf35ad23b11788f02e442)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:38 +01:00
Scott Rifenbark 07c9405365 ref-manual: New section on cross-development toolchains added.
First draft of this new section.  It included a figure so the
figure had to be added to the "figures" folder of the
mega-manual.

New section introduces concepts behind the types of cross-toolchains
YP develops through user commands that build images and build the
relocatable SDK.

(From yocto-docs rev: b3c9a2e3f90892a2175110393a962fd152316ca6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-06-21 14:26:30 +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