Commit Graph

15 Commits

Author SHA1 Message Date
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