aboutsummaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2013-02-14documentation/Makefile: logic to make all for yocto-project-qs and cleanupTimo Mueller
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-14documentation/yocto-project-qs/yocto-project-qs.xml: Convert fake-title ↵Timo Mueller
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-14documentation/Makefile: Support for making Eclipse HTML yocto project qs manualTimo Mueller
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-14documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl: ↵Timo Mueller
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-14documentation/yocto-project-qs: Added custom title pageTimo Mueller
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-14documentation: Move yocto-project-qs global parameters to customization fileTimo Mueller
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-14documentation/Makefile: logic to make all for poky-ref-manual and cleanupTimo Mueller
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-14documentation/poky-ref-manual/poky-ref-manual.xml: Added Title tagTimo Mueller
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-14documentation/Makefile: Support for making Eclipse HTML poky ref manualTimo Mueller
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-14documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl: new ↵Timo Mueller
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-14documentation: Move poky-ref-manual global parameters to customization fileTimo Mueller
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-14documentation/Makefile: logic to make all for kernel-manual and cleanupTimo Mueller
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-14documentation/kernel-manual/kernel-manual.xml: Added Title tagTimo Mueller
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-14documentation/Makefile: Support for making Eclipse HTML kernel manualTimo Mueller
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-14documentation/kernel-manual/kernel-manual-eclipse-customization.xsl: new fileTimo Mueller
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-14documentation: Move kernel-manual global parameters to customization fileTimo Mueller
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-14documentation/Makefile: logic to make all for bsp guide and cleanupTimo Mueller
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-14documentation/bsp-guide/bsp-guide.xml: Added Title tagTimo Mueller
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-14documentation/Makefile: Support for making Eclipse HTML bsp guideTimo Mueller
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-14documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new fileTimo Mueller
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-14documentation: Move bsp-guide global parameters to customization fileTimo Mueller
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-14documentation/Makefile: logic to make all for dev manual and cleanupTimo Mueller
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-14documentation/dev-manual/dev-manual.xml: Added Title tagTimo Mueller
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-14documentation/Makefile: Support for making Eclipse HTML dev manualTimo Mueller
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-14documentation/dev-manual/dev-manual-eclipse-customization.xsl: new fileTimo Mueller
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-14documentation: Move dev-manual global parameters to customization fileTimo Mueller
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-14documentation/Makefile: logic to make all for adt manual and cleanupTimo Mueller
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-14documentation/adt-manual/adt-manual.xml: Added Title tagTimo Mueller
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-14documentation/Makefile: Support for making Eclipse HTML adt manualTimo Mueller
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-14documentation/adt-manual/adt-manual-eclipse-customization.xsl: new fileTimo Mueller
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-14documentation: Move adt-manual global parameters to customization fileTimo Mueller
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-14documentation/template/titlepage.templates.xml: Remove title infoTimo Mueller
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-01-30dev-manual: Added text explaining "meta" is not required for layer nameScott Rifenbark
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-30ref-manual: Updated FILESPATH glossary entryScott Rifenbark
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-30dev-manual: Qualified the use of meta-intel in the BSP workflowScott Rifenbark
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-30dev-manual: clarify what source is being archivedKevin Strasser
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-30dev-manual: fix gpl source release exampleKevin Strasser
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-30dev-manual: use path independent bblayers.conf exampleKevin Strasser
(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-30ref-manual: Changed the default BB Signature HandlerScott Rifenbark
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-30mega-manual: Removed support for old kernel-manual.Scott Rifenbark
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-30Makefile: Removed bits that support kernel-manualScott Rifenbark
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-30kernel-dev: Added "-dirty String" section.Scott Rifenbark
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-30kernel-dev: Added "Inspecting Changes and Commits" sectionScott Rifenbark
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-30kernel-dev: Added "Maintenance" appendix.Scott Rifenbark
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-30ref-manual: Fixed broken link to "Build Directory" term.Scott Rifenbark
(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-30kernel-dev: Added "Kernel Architecture" section.Scott Rifenbark
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-30kernel-dev: Changed the FAQ to be an appendix.Scott Rifenbark
(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-30kernel-dev: Updates to support new concepts appendixScott Rifenbark
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-30kernel-dev: Added new appendix for kernel concepts.Scott Rifenbark
(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-30kernel-dev: Added an AR to the beginning for DarrenScott Rifenbark
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>