summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* documentation: Move poky-ref-manual global parameters to customization fileTimo Mueller2013-02-142-6/+6
| | | | | | | | 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>
* documentation/Makefile: logic to make all for kernel-manual and cleanupTimo Mueller2013-02-141-3/+4
| | | | | | | | | 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>
* documentation/kernel-manual/kernel-manual.xml: Added Title tagTimo Mueller2013-02-141-1/+3
| | | | | | | 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>
* documentation/Makefile: Support for making Eclipse HTML kernel manualTimo Mueller2013-02-141-1/+3
| | | | | | | | | | 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>
* documentation/kernel-manual/kernel-manual-eclipse-customization.xsl: new fileTimo Mueller2013-02-141-0/+26
| | | | | | | | | 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>
* documentation: Move kernel-manual global parameters to customization fileTimo Mueller2013-02-142-8/+6
| | | | | | | | 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>
* documentation/Makefile: logic to make all for bsp guide and cleanupTimo Mueller2013-02-141-3/+4
| | | | | | | | | 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>
* documentation/bsp-guide/bsp-guide.xml: Added Title tagTimo Mueller2013-02-141-1/+3
| | | | | | | 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>
* documentation/Makefile: Support for making Eclipse HTML bsp guideTimo Mueller2013-02-141-1/+3
| | | | | | | | | | 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>
* documentation/bsp-guide/bsp-guide-eclipse-customization.xsl: new fileTimo Mueller2013-02-141-0/+26
| | | | | | | | | 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>
* documentation: Move bsp-guide global parameters to customization fileTimo Mueller2013-02-142-5/+5
| | | | | | | | 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>
* documentation/Makefile: logic to make all for dev manual and cleanupTimo Mueller2013-02-141-3/+4
| | | | | | | | | 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>
* documentation/dev-manual/dev-manual.xml: Added Title tagTimo Mueller2013-02-141-1/+3
| | | | | | | 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>
* documentation/Makefile: Support for making Eclipse HTML dev manualTimo Mueller2013-02-141-4/+6
| | | | | | | | | | 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>
* documentation/dev-manual/dev-manual-eclipse-customization.xsl: new fileTimo Mueller2013-02-141-0/+26
| | | | | | | | | 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>
* documentation: Move dev-manual global parameters to customization fileTimo Mueller2013-02-142-7/+5
| | | | | | | | 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>
* documentation/Makefile: logic to make all for adt manual and cleanupTimo Mueller2013-02-141-3/+4
| | | | | | | | | 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>
* documentation/adt-manual/adt-manual.xml: Added Title tagTimo Mueller2013-02-141-1/+3
| | | | | | | 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>
* documentation/Makefile: Support for making Eclipse HTML adt manualTimo Mueller2013-02-141-0/+23
| | | | | | | | | | 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>
* documentation/adt-manual/adt-manual-eclipse-customization.xsl: new fileTimo Mueller2013-02-141-0/+26
| | | | | | | | | | | | 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>
* documentation: Move adt-manual global parameters to customization fileTimo Mueller2013-02-142-8/+6
| | | | | | | | | | | | | | | | | 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>
* documentation/template/titlepage.templates.xml: Remove title infoTimo Mueller2013-02-141-13/+0
| | | | | | | | | | 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>
* dev-manual: Added text explaining "meta" is not required for layer nameScott Rifenbark2013-01-301-7/+15
| | | | | | | | | | | 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>
* ref-manual: Updated FILESPATH glossary entryScott Rifenbark2013-01-301-4/+2
| | | | | | | | | | | | | 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>
* dev-manual: Qualified the use of meta-intel in the BSP workflowScott Rifenbark2013-01-301-5/+12
| | | | | | | | | | | | | | 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>
* dev-manual: clarify what source is being archivedKevin Strasser2013-01-301-3/+3
| | | | | | | | | | | 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>
* dev-manual: fix gpl source release exampleKevin Strasser2013-01-301-1/+1
| | | | | | | | | | 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>
* dev-manual: use path independent bblayers.conf exampleKevin Strasser2013-01-301-6/+6
| | | | | | | (From yocto-docs rev: 1189fddd801beaabdd8df6923f6a8d3491b1afb4) Signed-off-by: Kevin Strasser <kevin.strasser@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Changed the default BB Signature HandlerScott Rifenbark2013-01-301-2/+2
| | | | | | | | | | | | 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>
* mega-manual: Removed support for old kernel-manual.Scott Rifenbark2013-01-301-5/+0
| | | | | | | | | | | 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>
* Makefile: Removed bits that support kernel-manualScott Rifenbark2013-01-301-16/+2
| | | | | | | | | | | 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>
* kernel-dev: Added "-dirty String" section.Scott Rifenbark2013-01-301-0/+43
| | | | | | | | | | | | | 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>
* kernel-dev: Added "Inspecting Changes and Commits" sectionScott Rifenbark2013-01-301-0/+108
| | | | | | | | | | | | | 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>
* kernel-dev: Added "Maintenance" appendix.Scott Rifenbark2013-01-302-0/+220
| | | | | | | | | | | | | | | | | 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>
* ref-manual: Fixed broken link to "Build Directory" term.Scott Rifenbark2013-01-301-1/+2
| | | | | | | (From yocto-docs rev: 311edd13da00f6849094346aaa9509f27d60b2c4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added "Kernel Architecture" section.Scott Rifenbark2013-01-303-1/+166
| | | | | | | | | | | | | | | | 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>
* kernel-dev: Changed the FAQ to be an appendix.Scott Rifenbark2013-01-301-2/+2
| | | | | | | (From yocto-docs rev: 0439024c603fbc190741ea0cc807923bb41028a8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Updates to support new concepts appendixScott Rifenbark2013-01-301-0/+2
| | | | | | | | | | 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>
* kernel-dev: Added new appendix for kernel concepts.Scott Rifenbark2013-01-301-0/+89
| | | | | | | (From yocto-docs rev: e25465c6d177a27d3dee742ebc958ae30f968ffa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added an AR to the beginning for DarrenScott Rifenbark2013-01-301-0/+21
| | | | | | | | | | | | | 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>
* ref-manual: Added a general reference and link to kernel-devScott Rifenbark2013-01-271-1/+2
| | | | | | | | | | 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>
* dev-manual: Scrub for correct YP manual cross-references.Scott Rifenbark2013-01-273-13/+42
| | | | | | | | | | | | | | | | | | | 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>
* adt-manual: Added cross-references to profile-manual.Scott Rifenbark2013-01-271-3/+14
| | | | | | | | | | | | | 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>
* ref-manual: Added new KFEATURE_DESCRIPTION glossary entry.Scott Rifenbark2013-01-271-0/+16
| | | | | | | (From yocto-docs rev: 34060ca253a4434cd61c61fbefd0fe58ecd5fb36) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: General edits and links added.Scott Rifenbark2013-01-271-21/+27
| | | | | | | | | | | | 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>
* ref-manual: Added new variable KBRANCH_DEFAULT.Scott Rifenbark2013-01-271-0/+15
| | | | | | | (From yocto-docs rev: d97c04fd6e818e7b78971f8c459a9778fb4e69f4) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Links and edits to the Common Tasks chapter.Scott Rifenbark2013-01-271-11/+17
| | | | | | | (From yocto-docs rev: 46cd5eabe2343897eb9b4822064735bf335beb47) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: New KERNEL_PATH variable added to the glossary.Scott Rifenbark2013-01-271-1/+27
| | | | | | | | | | 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>
* ref-manual: New KERNEL_SRC variable added to glossary.Scott Rifenbark2013-01-271-0/+14
| | | | | | | (From yocto-docs rev: d8f7b32a9be1834f7835262f58c577b1f40a3edc) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Minor edits to the overview section.Scott Rifenbark2013-01-271-2/+2
| | | | | | | (From yocto-docs rev: 42c9b33d38150672d1ea177f98a86c71806caa3a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
OpenPOWER on IntegriCloud