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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
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>
Timo Mueller
Scott Rifenbark
Kevin Strasser