Commit Graph

132 Commits

Author SHA1 Message Date
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 5ebb6d8e24 mega-manual: Added five new figures to the figures folder
New figures for the expanded build section.

(From yocto-docs rev: d22d4978a4c0a95744651f97afa0b5c148f0d873)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-08-13 13:18:44 +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 d70e93caf4 mega-manual: Removed support for old kernel-manual.
No longer including the Yocto Project Kernel Architecture
and Use Manual.  I removed the lines that included this
manual as part of the mega-manual.

(From yocto-docs rev: 69fa3cc4a07fc471fc869a81ff2545d62b63286e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:03 +00:00
Scott Rifenbark 34f0fc3728 mega-manual: Added support to build profile-manual.
(From yocto-docs rev: fe59bccc799daf03d4dc8ccbbb842529dc41d3ea)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:04 +00:00
Scott Rifenbark 0c43dbbe4f mega-manual: Added the profile-manual figures
The figures from the profile-manual/figures folder must be
added to the mega-manual/figures folder in order for the
mega-manual to make correctly.

(From yocto-docs rev: f64459330b472dbade936f9d964b4792fb6364bc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:03 +00:00
Scott Rifenbark 7c5dfcbfb6 mega-manual: Updated the top-level XML file.
1. Changed "poky-ref-manual" to "ref-manual"
2. Inserted new lines to support "kernel-dev" manual.

(From yocto-docs rev: a134992633572c0b006ae73d47512be89d13ba8e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:08 +00:00
Scott Rifenbark 7d46d48558 mega-manual: Added the title figure for the new kernel-dev book.
(From yocto-docs rev: 7f1fc6b50be882bd73f394f1ebe5f6dc0e3b0c28)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-16 15:59:07 +00:00
Scott Rifenbark 30c0c9e358 mega-manual: Fixed to include ref-manual.
this still had the "poky-ref-manual" string in it. It needed the
"ref-manual" string.

(From yocto-docs rev: f771aaa09bf439e506dc5d8573a34283a1a905fb)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-07 14:43:27 +00:00
Scott Rifenbark dab49aa644 documentation: poky-ref-manual, mega-manual, Makefile - new variables
Added variable descriptions for BB_DISKMON_DIRS and
BB_DISKMON_WARNINTERVAL.  These went in the reference
manual in the glossary section.  First draft for both
descriptions.

Also, updated the Makefile to include two new figures used
in the Build History section.  The figures needed to be added
to the TARFILE variable so that the .PNG files are included
when publishing both the poky-ref-manual and the mega-manual.

Added two figures to the figures directories of the poky-ref-manual
and the mega-manual.  These figures are part of the new Build
History section.  Anytime you add a figure to any manual you
also have to store it in the figures directory of the mega-manual.

(From yocto-docs rev: bbf68ed28ba8660af34d4cae146fb172ca4e681e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-12-03 13:52:55 +00:00
Scott Rifenbark 7090cbe2c9 documentation: dev-manual - removed the wip.png figure
this figure used to be at the end of the development manual.
I have removed it from both figures directories and taken
it out of the TARFILE list in the Makefile.

(From yocto-docs rev: ad8fcfc4bddb6bcee0e1a4ece78cd87ab0d51b6c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-22 09:49:08 +01:00
Scott Rifenbark 3108942c6d documentation: dev-manual, mega-manual - removed figure
Removed the "kernel-example-repos-generic.png" file as it describes
the bare clone method for kernel modification.  We are removing
that from this manual.

(From yocto-docs rev: c25c4f662c2f8a83fd9b09583646be9dbe01424c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-10 15:18:13 +01:00
Scott Rifenbark 68431a807e documentation: mega-manual - copied in new kernel flow diagram.
Moved the simpler version of the kernel workflow diagram to the
figures folder.

(From yocto-docs rev: c856fe320a0e70701f14312439fec6ccb707f9bd)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-10 15:18:13 +01:00
Scott Rifenbark 8461d4ad85 documentation: dev-manual - Removed figures no longer needed.
The figure that shows the bare clone and the copy of the bare
clone are no longer needed.  The description for the kernel
workflow has been reduced to discussing only modification of
the temporary source files.  We are no longer talking about
creating a bare clone and copying it as a way to modify the
kernel in this manual.  That topic will be described elsewhere.

(From yocto-docs rev: f6a25e5e3763ea7a1f8a81ce377e3b520143b852)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-10 15:18:12 +01:00
Scott Rifenbark 6d5e8360ca documentation: dev-manual - Created generic figures
Each time the kernel revision is bumped (e.g. 3.2 to 3.4)
Some of the figures would be out of date.  The reason is they
had pathnames that included the release of the kernel.
For previous YP releases I was adding logic to the Makefile
to be sure to catch the right files dependent on the branch
from which the documents were being built.  This scheme is
not scalable so I decided to make the figures generic by
adding a note within the figures explaining the place-holder
"<x.x>" as part of a pathname.  Thus, three new figures were
added to the folders directories of the dev-manual and the
mega-manual.  Correspondingly, the 'denzil' version of the
figures were deleted.

I modified the Makefile so that if the BRANCH is not edison
or denzil then the generic figure set is used. I have to retain
the logic for both edison and denzil to cover the case where
a user clones or sets up an edison or denzil repo and then
builds out the manuals. Basically, it had to be backwards
compatible for releases prior to danny.

(From yocto-docs rev: 8283eed4b0b9ec164b87db99c35231f8731ac443)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-07 13:15:36 +01:00
Scott Rifenbark 4364f11ae3 documentation: Makefile, dev-manual - Updated kernel example repo figure
Danny, the "kernel-example-repo-<release>.png" file changed to
"kernel-example-repo-danny.png".  To correctly make the dev-manual
and the mega-manual some things needed to change:

1. New figure created and added to both the dev-manual and the
   mega-manuals figures directory.

2. The "kernel-example-repo-denzil.png" files from the dev-manual
   and mega-manual figures directory was removed.

3. The Makefile was adjusted so a new BRANCH=danny area now exists
   to set TARFILES for both dev-manual and mega-manual.

(From yocto-docs rev: 8b2ff6b657a1486559799e219baaec9fde2e5c6c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-10-07 13:15:35 +01:00
Scott Rifenbark bb86a22ba6 yocto-docs/.gitignore: Final fix to ignore mega-manual.
I think I got it right this time... sheesh.  Had the wrong
file suffix in there for the .tgz file.

(From yocto-docs rev: d5931252ede475846dcb61fc0e0f03eb7fe4015e)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2012-09-04 12:55:03 +01:00
Scott Rifenbark d9b2ceeea3 documentation/mega-manual: New mega-manual directory
This new directory contains the files for the mega-manual HTML
document.  Mega-manual is a compilation of all the existing YP
manuals and guides.  It is a single HTML file that simply lists
each individual HTML document for the existing YP manuals and
guides.  The figures directory contains all the figures (duplicated)
from the individual manuals and guides.

(From yocto-docs rev: 5620c20ea4c7c69c96601b7480471e6166fd9409)

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