Commit Graph

1694 Commits

Author SHA1 Message Date
Scott Rifenbark 093b0079ce dev-manual, ref-manual: Updates for BBPATH.
Two things fixed:

1. A couple examples for setting up a layer.conf file were
   using the meta-yocto configuration file as an example.
   Turns out this is a bad example because the BBPATH variable
   is appended to the LAYERDIR when setting BBPATH rather
   than the other way around.  That is because meta-yocto
   is a distro layer.  BSP layers, however, are not distro
   layers and are the norm here.  So I switched up the way
   BBPATH was set and actually called out meta-yocto-bsp
   config file as a template.

2. Added a link for the BBPATH variable in the
   FILESYSTEM_PERMS_TABLES variable description in the
   glossary.  Just happened to notice this so I fixed it

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:24:01 +00:00
Scott Rifenbark 718e3b4984 ref-manual, dev-manual: Updates to BBMASK variable.
Fixes YOCTO #3662

I added more information to the variable desription in the
glossary for BBMASK.  The information included a bit more
syntax information as well as some more complex examples.

I added more reference information to the "Excluding Recipes
From the Build" section to help better describe how the
BBMASK variable works.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:24:00 +00:00
Scott Rifenbark 6a926df682 ref-manual: Updates to the FILESEXTRAPATHS variable.
Fixed YOCTO #3662

Updates to the description so _prepend is used to add paths
to the front of the search order and use of the variable
without _prepend just adds paths to the end of the
FILESPATH order.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:24:00 +00:00
Scott Rifenbark 58f61cf79e ref-manual: new BB_DANGLINGAPPENDS_WARNONLY variable added to glossary.
Fixes YOCTO #3662

New entry added.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:24:00 +00:00
Timo Mueller 78f10655cd documentation: Add chunk.quietly option to eclipse processing
The chunk.quietly option disables the output of the docbook
chunker. Creation of a new html file is now longer printed to the
console. This provides a much cleaner output of the eclipse makefile
target.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:22:42 +00:00
Timo Mueller e29a40c98b documentation/tools/eclipse-help.sed: Fix whitespace
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:22:41 +00:00
Timo Mueller fcb3952ef6 documentation/Makefile: Fix copying of figures folder
When calling the eclipse target twice without calling clean in between
the figures folder was copied as a subfolder of the existing figures
folder. This patch fixes the copy command to correctly copy the
figures folder.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:22:41 +00:00
Timo Mueller 6c057d0841 documentation/Makefile: Clean up eclipse target and update help.
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:22:38 +00:00
Timo Mueller 239b469820 documentation/Makefile: Added conversion of links to other documentation parts.
The script tools/eclipse-help.sed is used to convert links that
point to other documentation parts. This avoids having to leave
the eclipse help center when clicking these links.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:29 +00:00
Timo Mueller a11f23b4bc documentation/tools/eclipse-help.sed: Processes external links for eclipse html files
The file is used when creating eclipse help html files. It processes
all html files and converts links so that the user can navigate
between different docuementation parts without leaving the eclipse
help center.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:29 +00:00
Timo Mueller 108ffcf310 documentation/Makefile: logic to make all for yocto-project-qs and cleanup
Eclipse help documents are now created when calling the 'make all'
target on the yocto-project-qs. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:29 +00:00
Timo Mueller 0f49fe1792 documentation/yocto-project-qs/yocto-project-qs.xml: Convert fake-title section into articleinfo
The fake title section is converted into a docbook
article.articleinfo. If used with a custom title page this will lead
to the excapt same output. But I will enable the creation of metadata
from this title information.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:28 +00:00
Timo Mueller 72639b4a58 documentation/Makefile: Support for making Eclipse HTML yocto project qs manual
This target will generate eclipse help for the yocto-project-qs using
the yocto-project-qs-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:28 +00:00
Timo Mueller ea2e921e39 documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl: new file
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:28 +00:00
Timo Mueller 941d5e268b documentation/yocto-project-qs: Added custom title page
The quick start guide is currently not using a title information to
set the title of the document (e.g. article.title or
article.articleinfo.title).
As other output formats may use the title information to create
metadata this information has to be added to the document. To preserve
current style of the document a custom title page has to be used. With
this for instance 'article.title' can be used instead of the
fake-title section currently used, leaving the style intact.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:28 +00:00
Timo Mueller bbe7cb4770 documentation: Move yocto-project-qs global parameters to customization file
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:27 +00:00
Timo Mueller f4bcee695c documentation/Makefile: logic to make all for poky-ref-manual and cleanup
Eclipse help documents are now created when calling the 'make all'
target on the poky-ref-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:21:24 +00:00
Timo Mueller ac3d99071d documentation/poky-ref-manual/poky-ref-manual.xml: Added Title tag
The title of the document used to create metadata for output formats
such as eclipse help.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:15:50 +00:00
Timo Mueller c6af0b969c documentation/Makefile: Support for making Eclipse HTML poky ref manual
This target will generate eclipse help for the poky-ref-manual using
the  poky-ref-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:15:08 +00:00
Timo Mueller 990fb57a65 documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl: new file
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:15:08 +00:00
Timo Mueller e3980c4938 documentation: Move poky-ref-manual global parameters to customization file
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 17:14:58 +00:00
Timo Mueller d90e93b21e documentation/Makefile: logic to make all for kernel-manual and cleanup
Eclipse help documents are now created when calling the 'make all'
target on the kernel-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 16:32:30 +00:00
Timo Mueller 367d699718 documentation/kernel-manual/kernel-manual.xml: Added Title tag
The title of the document used to create metadata for output formats
such as eclipse help.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 16:29:22 +00:00
Timo Mueller ea7905c1ff documentation/Makefile: Support for making Eclipse HTML kernel manual
This target will generate eclipse help for the kernel-manual using
the  kernel-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:36:36 +00:00
Timo Mueller deac1787bd documentation/kernel-manual/kernel-manual-eclipse-customization.xsl: new file
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:36:36 +00:00
Timo Mueller da8cdf63b4 documentation: Move kernel-manual global parameters to customization file
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:36:09 +00:00
Timo Mueller 8d54920dd0 documentation/Makefile: logic to make all for bsp guide and cleanup
Eclipse help documents are now created when calling the 'make all'
target on the bsp-guide. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:31:34 +00:00
Timo Mueller 6485078889 documentation/bsp-guide/bsp-guide.xml: Added Title tag
The title of the document used to create metadata for output formats
such as eclipse help.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:30:48 +00:00
Timo Mueller b73e6cb010 documentation/Makefile: Support for making Eclipse HTML bsp guide
This target will generate eclipse help for the bsp-guide using
the  bsp-guide-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:29:54 +00:00
Timo Mueller d37c418cf4 documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new file
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:29:53 +00:00
Timo Mueller 81d2bcfadd documentation: Move bsp-guide global parameters to customization file
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:29:53 +00:00
Timo Mueller 42b9f2cafe documentation/Makefile: logic to make all for dev manual and cleanup
Eclipse help documents are now created when calling the 'make all'
target on the dev-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:29:51 +00:00
Timo Mueller c94fd49bfc documentation/dev-manual/dev-manual.xml: Added Title tag
The title of the document used to create metadata for output formats
such as eclipse help.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:27:21 +00:00
Timo Mueller 964db71ad0 documentation/Makefile: Support for making Eclipse HTML dev manual
This target will generate eclipse help for the dev-manual using
the dev-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:26:05 +00:00
Timo Mueller e90dab9d22 documentation/dev-manual/dev-manual-eclipse-customization.xsl: new file
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:26:05 +00:00
Timo Mueller b3f1c60b7b documentation: Move dev-manual global parameters to customization file
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:26:04 +00:00
Timo Mueller 9ab3c018a2 documentation/Makefile: logic to make all for adt manual and cleanup
Eclipse help documents are now created when calling the 'make all'
target on the adt-manual. Resulting files are archived into
the tarball as well. When calling 'make clean' artefacts of
the eclipse documentation build are deleted.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:25:23 +00:00
Timo Mueller c2c3b53430 documentation/adt-manual/adt-manual.xml: Added Title tag
The title of the document used to create metadata for output formats
such as eclipse help.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:22:42 +00:00
Timo Mueller 733a44d048 documentation/Makefile: Support for making Eclipse HTML adt manual
This target will generate eclipse help for the adt-manual using
the adt-manual-eclipse-customization.xsl stylesheet.

The output will be generated to a separate directory which can be used
for integrating the documentation into eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:21:49 +00:00
Timo Mueller 2586bd854c documentation/adt-manual/adt-manual-eclipse-customization.xsl: new file
This stylesheet uses the eclipse stylesheets of docbook to create
eclipse help from this documentation. In addition to simple html
files these stylesheets will also create xml files which are
needed to integrate the documentation into eclipse (e.g. toc.xml).

Additional parameters are required so resolve links between different
documentation parts inside eclipse.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:21:48 +00:00
Timo Mueller 551a5eec9f documentation: Move adt-manual global parameters to customization file
Standard stylesheet parameters were moved to the docbook customization
file tying them to the docbook stylesheet used. Removing these
parameters simplifies the Makefile.

Furthermore supporting new output formats can now be achieved by
creating a new customization file containing its corresponding
parameters. Parameters that are used across different stylesheets with
different values will then be separated through different
customization files.

Global parameters can still be set through the XSLTOPTS variable since
this precedes the parameters in the customization file.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:21:48 +00:00
Timo Mueller ff553c4b2d documentation/template/titlepage.templates.xml: Remove title info
The title of a pdf document is part of the image used on the title
page. Thus the title defined (e.g. bookinfo.title) in a document
should never be used when creating title pages for pdf documents. As
other output formats may use the title information to create metadata
the title has been removed from the template.

Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-02-14 15:21:48 +00:00
Scott Rifenbark df70804654 dev-manual: Added text explaining "meta" is not required for layer name
Updated a couple spots in the manual to be clear on meta
not being a strict requirement for a layer name.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:05 +00:00
Scott Rifenbark eddb8174c8 ref-manual: Updated FILESPATH glossary entry
Fixes YOCTO #3661

The value for FILESPATH was incorrect.  I have replaced it with
the value found in base.bbclass.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:04 +00:00
Scott Rifenbark bdc130bb35 dev-manual: Qualified the use of meta-intel in the BSP workflow
Fixes YOCTO #3663

I added wordings to indicate that meta-intel is not required
to create a BSP layer.  But, the example presented uses
meta-intel.

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

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:04 +00:00
Kevin Strasser 90a183b9c5 dev-manual: clarify what source is being archived
Part of section 5.15.1 incorrectly implies that only copyleft
source will be archived to the specified directory, when in fact
copyleft filtering is disabled by default.

(From yocto-docs rev: 8eacef8acc398bc3d881d657d27c8827f05e3227)

Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:04 +00:00
Kevin Strasser e13a2ee08b dev-manual: fix gpl source release example
The example doesn't account for an extra level of directories
that organise the sources by machine type.

(From yocto-docs rev: 844e8b8f28ab765e59fdbee40e00c973b1b00d89)

Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:04 +00:00
Kevin Strasser 9a7bd85ea2 dev-manual: use path independent bblayers.conf example
(From yocto-docs rev: 1189fddd801beaabdd8df6923f6a8d3491b1afb4)

Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:04 +00:00
Scott Rifenbark 23737926d2 ref-manual: Changed the default BB Signature Handler
Fixes YOCTO #3684

Updated the section that declares what the default BB
Signature Handler is.

(From yocto-docs rev: e4c64add4a54e5583bf88fc71f00c90f7a1f6440)

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 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 eddb116f35 Makefile: Removed bits that support kernel-manual
I took out the logic that built the old YP Kernel Architecture
and Use Manual.  This manual can no longer be build.  It is
being retired.

(From yocto-docs rev: 8d5b179995e561deb94572150e904da5cd4dec19)

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 5174240361 kernel-dev: Added "-dirty String" section.
The "-dirty" String section from the old YP Kernel Architecture
and Use Manual was moved to section 2.3 of the manual.  It needs
to find the right area to be put in (AR for Darren).  I added the
AR text to the top of the section so it would not fall through
the cracks.

(From yocto-docs rev: eaa5b86643572a6c74028dc3330625a0bfbca50e)

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 46dcd9fd73 kernel-dev: Added "Inspecting Changes and Commits" section
A Section about seeing what has changed in a kernel tree
was moved from the old YP Kernel Architecture and Use Manual
to this new manual.  The section moved was "Change Inspection:
Changes/Commits".  In addition to moving the sections, I
shortened them up by removing verbose parts of the section.

(From yocto-docs rev: 2c620ea2bed0844b70b497dfa461c0b364312e39)

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 d36e4792e7 kernel-dev: Added "Maintenance" appendix.
New appendix required adding the kernel-dev-maint-appx.xml
file.  The contents are sections 3.2 and 3.3 from the old
YP Kernel Architecture and Use Manual, which is "Tree
Construction" and "Build Strategy."  According to Darren Hart,
this information should be retained for the few people on
the planet that might ever need it.  In addition to adding
the new file, I had to add the bits to the kernel-dev.xml
manual to support including the appendix when making the
manual.

(From yocto-docs rev: b25e40308080c59c6700e1dce8ebf6a9a2dafbcc)

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 805a36cd58 ref-manual: Fixed broken link to "Build Directory" term.
(From yocto-docs rev: 311edd13da00f6849094346aaa9509f27d60b2c4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark a24cb73f39 kernel-dev: Added "Kernel Architecture" section.
Moved the "Kernel Architecture" section from the YP Kernel
Architecture and Use Manual to this manual.  The section
included the kernel-architecture-overview.png figure.  So,
I added that PNG file to the "figures" folder.  Finally, I
had to also add the PNG file to the Makefile tarfile list
for kernel-dev.  Note that because the figure was part of
the old YP Kernel Architecture and Use Manual, I did not have
to add the figure to the mega-manual tarfile list.

(From yocto-docs rev: fbc5508ce162ea7915fd5dce74338b6a5bfd7ce1)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark 36b5f97e26 kernel-dev: Changed the FAQ to be an appendix.
(From yocto-docs rev: 0439024c603fbc190741ea0cc807923bb41028a8)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark 9ba5e61b7a kernel-dev: Updates to support new concepts appendix
Added bits to support building the new kernel concepts
appendix.

(From yocto-docs rev: 6d372bd12288142b09c729f877c1e894f11c7c27)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark d029e786b5 kernel-dev: Added new appendix for kernel concepts.
(From yocto-docs rev: e25465c6d177a27d3dee742ebc958ae30f968ffa)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:02 +00:00
Scott Rifenbark b80e983620 kernel-dev: Added an AR to the beginning for Darren
The concepts in three bulleted items in the old kernel manual
need to be present in this new manual.  I put in a bit of text
right at the beginning of the manual in the form of an AR for
Darren.  This will eventually be removed, but for now it is there
so that it won't slip through the cracks.

(From yocto-docs rev: 85b7300df30837f72d936f8ec1af0b2a4a9c1a88)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-30 14:10:01 +00:00
Scott Rifenbark b2869b6810 ref-manual: Added a general reference and link to kernel-dev
Put in a cross-link to the new YP Linux Kernel Development
Manual up in the introduction.

(From yocto-docs rev: ba00acb1a0db9494b0d0ff1335f2532b5e2a7994)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:06 +00:00
Scott Rifenbark 347e99427f dev-manual: Scrub for correct YP manual cross-references.
I went through and got rid of all references to the old
YP Kernel Architecture and Use Manual and replaced with
appropriate references to the new YP Linux Kernel
Development Manual.

I also laced in appropriate references into various sections
of the new YP Profiling and Tracing Manual.

Also, updated the list of resource manuals to reflect the
new manual set (addition of kernel-dev and profile-dev and
removal of kernel-manual).

(From yocto-docs rev: ef531ad65c9b749dad5e8e39b060bf1641e4fa38)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark 9713fdcebe adt-manual: Added cross-references to profile-manual.
I added some cross-references to the section that overviews
the user-space tools.  Three tools (perf, oprofile, and
systemtap) are in the list.  I added appropriate cross
references to the respective tool sections in the YP
Profiling and Tracing Manual.

(From yocto-docs rev: 9b1ee95fa9dd4110f5b4f9e7aeaba63c6ef8b148)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark 79d192fb2c ref-manual: Added new KFEATURE_DESCRIPTION glossary entry.
(From yocto-docs rev: 34060ca253a4434cd61c61fbefd0fe58ecd5fb36)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark 5053b65416 kernel-dev: General edits and links added.
Many links added to the glossary variables that were introduced
in the manual.

Also provided general edits as I found them.

(From yocto-docs rev: 1c004144669306e87ad783df766b5245e474f549)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark dd46994f45 ref-manual: Added new variable KBRANCH_DEFAULT.
(From yocto-docs rev: d97c04fd6e818e7b78971f8c459a9778fb4e69f4)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark eb576addf5 kernel-dev: Links and edits to the Common Tasks chapter.
(From yocto-docs rev: 46cd5eabe2343897eb9b4822064735bf335beb47)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark 64933666a6 ref-manual: New KERNEL_PATH variable added to the glossary.
Also put in a cross-reference in the existing KERNEL_SRC
variable.

(From yocto-docs rev: 705074a16490155cd64469af3b2ea12a0780281c)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark ce6ed21ee7 ref-manual: New KERNEL_SRC variable added to glossary.
(From yocto-docs rev: d8f7b32a9be1834f7835262f58c577b1f40a3edc)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark e6310f6310 kernel-dev: Minor edits to the overview section.
(From yocto-docs rev: 42c9b33d38150672d1ea177f98a86c71806caa3a)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark a24c555641 ref-manual: Set KARCH as the top "K" entry for the glossary.
(From yocto-docs rev: 1fceec975f9e6b40c64d55050e257c2239340d65)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:05 +00:00
Scott Rifenbark 8c58a9cca2 dev-manual: Edits to "Metadata" term.
In the "Terms" section, I enhanced the "Metadata" term to include
a bit about Metadata in the context of the kernel.  This type of
metadata is discussed at length in the YP Linux Kernel Development
Manual.

(From yocto-docs rev: c6f48bc4c33850eaa1dbf5867759a19d373766ce)

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 4f3fdc33af ref-manual: New variable descriptions for KTYPE and KARCH.
(From yocto-docs rev: 35b7baa5653cffbb5e1dd1759643135c08b15bf7)

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 f37037f26f ref-manual: Edits to a couple variables in the glossary
1. LINUX_VERSION_EXTENSION: Added a link on the
   LINUX_KERNEL_TYPE variable.

2. Added a new variable description for the
   LINUX_KERNEL_TYPE variable.

(From yocto-docs rev: f4ace3c64838044e2eb700af4b024a96ab1e2315)

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 afb26ddaad ref-manual: Edits to the LINUX_VERSION_EXTENSION variable.
Applied Darren Hart's review comments.  Namely, use the
example from the linux-yocto recipes and not the custom
recipe.

(From yocto-docs rev: 4a537a02bbf6fca4ff1a3beddd03d8115099cddd)

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 4648e34300 ref-manual: Edits to the LINUX_VERSION variable.
Added a bit about the variable being used to define PV for the
recipe.

Also, fixed a couple indentation problems with some nearby
variables.

(From yocto-docs rev: bec65049218c9c549fe8cd4d5c16e9d917e87866)

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 b4b1dc1dd6 profile-manual: Fixed the "Tying it Together" side-lights.
Took them out of the colored Note format and replaced with
a simple line box to set them apart.

(From yocto-docs rev: 5efb84d3860d87f64371b718967ab33f47a3a4db)

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 f3cb977699 profile-manual: Fixed typo in last section
Changed "Line" to "Live" in the section heading.

(From yocto-docs rev: 73ea1f5a01891aa51c872363a60d2e0eefdf2f64)

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 7e091de56b profile-manual: Fixed "short" figures to remove space.
(From yocto-docs rev: 5f4cfbef0689b5c84d8fa14c413f8a4c5a9521c3)

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 5cd5cb2b26 profile-manual: Added links for literall http:// strings.
(From yocto-docs rev: a30bc0c5e1c752ea3c6f73acd203e80a398d5368)

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 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 37b290f0a8 Makefile: Updated to support mega-manual build with profile-manual
Added the list of 32 profile-manual figures to the tarfile
variable for mega-manual.

(From yocto-docs rev: ffe0586990c7659c28001038d6ba55cd42f5ecd0)

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 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 842e3b83c2 profile-manual: Added blktrace section.
No re-writing at all.

(From yocto-docs rev: c18bd94ac0e6fc3a23139ec8d1ef7b04518746de)

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 e4746a55e4 profile-manual: Added LTTng section to usage chapter.
No re-writing at all.

(From yocto-docs rev: 6ed32ad5daa1f16c414da665a2fea498baefbe4a)

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 697b9ec4f7 profile-manual: Added Sysprof section to usage chapter.
No re-writing.

(From yocto-docs rev: e3fd833c4bf7cdc50138ac940af8a2b35c37c52b)

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 acb86de34e profile-manual: Added oprofile usage section.
No re-writing at all.

(From yocto-docs rev: f42230e3665903a7603212696949241244555f8b)

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 fcf615546f profile-manual: Systemtap section added.
No re-writing at all.

(From yocto-docs rev: 4ca472f8200f9d927a8d37c88c1ff75b017fcfc1)

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 44e838c612 profile-manual: Substituted real title image in.
(From yocto-docs rev: 7492d719e59fdc023da06554b7b65af63d76a6df)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 82928e228b profile-manual: Added ftrace section to the manual.
No re-writing, no clean up what-so-ever.  It is simply in the
DocBook form.

(From yocto-docs rev: 3d2c17c076b67c3e2ab094d0562038e422b63d44)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 41fe45977c profile-manual: Corrected bad literallayout statement.
(From yocto-docs rev: fc3aa3815bfdfac11e93167dda8e52457b42c4c6)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 803ccdb93a profile-manual: Added profile-title.png to stylesheet
(From yocto-docs rev: ad0222226cf4e29673e859cc95496c53875202cf)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 86478ff948 profile-manual: Updated indentation and sectioning
Had the sectioning off and it was preventing the manual from
making.  I also added more indentation as needed throughout
most of the manual up to the error.

(From yocto-docs rev: 5de3544593a63e96b349babc177970d8605e0098)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 487a76f7c7 profile-manual: Correctly named "figures" folder.
This adds in the figures under the correct spelling for the
"figures" folder.

(From yocto-docs rev: 83d7896623a9a88538dd1da45429f47777123338)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 1fbdf5035d profile-manual: Rename of figures folder.
Initially the 'figures' folder was mis-named as 'Figures'.
this is not in line with the other manuals.  I had to rename
the folder and thus delete all these files from the Git repo
since they had been committed.

(From yocto-docs rev: 4452e790e8ddb8c80a5f0c6faf4a1f86fd3fb8d7)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:56:02 +00:00
Scott Rifenbark 43f565aa4e poky.ent: Added new YOCTO_DOCS_PROF_URL variable.
(From yocto-docs rev: cc6082ee1fb33fa7a91c1a6e8aa92b568e1c8fee)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:55:58 +00:00
Scott Rifenbark 9bd5435f6f Makefile: Added support for the new profile-manual.
(From yocto-docs rev: 09183423d3049b954b0f0a5d882bf85218b5aff9)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:09 +00:00
Scott Rifenbark 33b7996446 profile-manual: Converted root XML file for profile-manual
Edits to change this file to work for the profile-manual.

(From yocto-docs rev: 60a52fb31f2d15709afa29e83aa5d50bf8d90c58)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:09 +00:00
Scott Rifenbark 7f64ad2423 profile-manual: Second half of perf raw text entered.
Finished entering the rest of the "perf" section.

(From yocto-docs rev: 3df34a299ef9656362bf5b851b575528c646c02b)

Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2013-01-27 13:54:09 +00:00
Scott Rifenbark 89dbdec992 profile-manual: Adding raw text.
Started to put in the usage chapter.  Adding text and
sectioning off by paragraph and formatting for literal
sections.

(From yocto-docs rev: c2d328d19023cd6fac6dcaeb8449e2203b5a17b7)

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