summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
...
* dev-manual, ref-manual: Updates for BBPATH.Scott Rifenbark2013-02-142-25/+52
| | | | | | | | | | | | | | | | | | | | | | | | 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>
* ref-manual, dev-manual: Updates to BBMASK variable.Scott Rifenbark2013-02-142-25/+71
| | | | | | | | | | | | | | | | | | 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>
* ref-manual: Updates to the FILESEXTRAPATHS variable.Scott Rifenbark2013-02-141-12/+20
| | | | | | | | | | | | | | | 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>
* ref-manual: new BB_DANGLINGAPPENDS_WARNONLY variable added to glossary.Scott Rifenbark2013-02-141-0/+33
| | | | | | | | | | | | 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>
* documentation: Add chunk.quietly option to eclipse processingTimo Mueller2013-02-146-0/+6
| | | | | | | | | 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>
* documentation/tools/eclipse-help.sed: Fix whitespaceTimo Mueller2013-02-141-2/+2
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Fix copying of figures folderTimo Mueller2013-02-141-1/+1
| | | | | | | | | 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>
* documentation/Makefile: Clean up eclipse target and update help.Timo Mueller2013-02-141-12/+4
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/Makefile: Added conversion of links to other documentation parts.Timo Mueller2013-02-141-2/+16
| | | | | | | | 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>
* documentation/tools/eclipse-help.sed: Processes external links for eclipse ↵Timo Mueller2013-02-141-0/+18
| | | | | | | | | | | 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>
* documentation/Makefile: logic to make all for yocto-project-qs and cleanupTimo Mueller2013-02-141-3/+6
| | | | | | | | | 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>
* documentation/yocto-project-qs/yocto-project-qs.xml: Convert fake-title ↵Timo Mueller2013-02-141-6/+14
| | | | | | | | | | | 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>
* documentation/Makefile: Support for making Eclipse HTML yocto project qs manualTimo Mueller2013-02-141-1/+2
| | | | | | | | | | 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>
* documentation/yocto-project-qs/yocto-project-qs-eclipse-customization.xsl: ↵Timo Mueller2013-02-141-0/+24
| | | | | | | | | | | 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>
* documentation/yocto-project-qs: Added custom title pageTimo Mueller2013-02-142-0/+3821
| | | | | | | | | | | | | 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>
* documentation: Move yocto-project-qs global parameters to customization fileTimo Mueller2013-02-142-3/+2
| | | | | | | | 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 poky-ref-manual and cleanupTimo Mueller2013-02-141-3/+3
| | | | | | | | | 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>
* documentation/poky-ref-manual/poky-ref-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 poky ref manualTimo Mueller2013-02-141-1/+2
| | | | | | | | | | 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>
* documentation/poky-ref-manual/poky-ref-manual-eclipse-customization.xsl: new ↵Timo Mueller2013-02-141-0/+26
| | | | | | | | | | | 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>
* 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-17 22:25:40 +0000