summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* yocto-docs: Fixup a couple of merge issuesRichard Purdie2013-02-142-32/+75
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Revision of "Team Environment" section.Scott Rifenbark2013-02-141-86/+308
| | | | | | | | | | | | | | Fixes YOCTO #3274 First draft of a re-written section that describes best practices for scaling the YP over a large development effort. this draft is based on Richard Purdie's text he sent to me. (From yocto-docs rev: e5135f76946997a0a060dd16c0b62308be4f6048) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Cross-references between PR Service and cacheScott Rifenbark2013-02-142-3/+19
| | | | | | | | | | | | | Fixes YOCTO #3684 These changes help tie in the relationship between how the OE build system uses checksums and such and the PR Service that can track revision. (From yocto-docs rev: 39a3010a3bb4b2c1d37aef60984ac16e85b56aac) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* template: Changed the font color for footers and headersScott Rifenbark2013-02-141-12/+12
| | | | | | | | | | | | | | | Fixes YOCTO #3728 The poky-db-pdf.xsl file has code that controls the font color for the headers, footers, and separating lines for each when the PDF version of a manual is made. I changed the values from #cccccc to #999999 to darken these up so they can be seen a little better. (From yocto-docs rev: c9c83028a5f13dc672414b6ca395290f05019f8e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, bsp-guide: Added some linksScott Rifenbark2013-02-142-3/+6
| | | | | | | | | | | | | Fixes YOCTO #3552 Added some links to the FILESEXTRAPATHS and SRC_URI variables. These links connect appropriate sections to a newly improved section on FILESEXTRAPATHS glossary description. (From yocto-docs rev: a58e7c6f013393c87381411f918e16a8f04d55d1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated PR Service section with commentsScott Rifenbark2013-02-141-15/+3
| | | | | | | | | | | | Fixes YOCTO #2684 Applied some review comments to the section from Richard Purdie. (From yocto-docs rev: 772617a45df10e5e42364854fe03d8aad7cb46b6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: First draft of the PR Service section.Scott Rifenbark2013-02-141-49/+211
| | | | | | | | | | | Fixes YOCTO #2684 Completed first draft. (From yocto-docs rev: c8b81e372578b1964bca4aa26d1085162115a2b0) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Created "Development Host System Issues" sectionScott Rifenbark2013-02-141-0/+31
| | | | | | | | | | | | | Fixes YOCTO #2790 Created a new section in the "Debugging Build Failures" section to deal with host issues that cause a build to fail. (From yocto-docs rev: 9efc00146764086646b0c558d12168ab9813d683) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed <ulink> to be on a single line.Scott Rifenbark2013-02-141-2/+1
| | | | | | | | | | These types of links must not span multiple lines in order for mega-manual to process them. (From yocto-docs rev: bcea042cd796a51d866f82399b2fd0cc89ec9e2b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed three figures from poky-ref-manualTimo Mueller2013-02-143-0/+0
| | | | | | | | | | three PNG files go away from the eclipse folder due to the renaming of the poky-ref-manual to ref-manual. (From yocto-docs rev: 29907784ecb509b3d4fba633b2c4970e4105bea2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Part 2 of 2 for YP doc integration into Eclipse.Timo Mueller2013-02-143-0/+81
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit adds the three *.customization.xsl files. I (Scott Rifenbark). Split the commit because after applying the 18 patches, the list of stuff to stage was huge and I did not want to add them one-by-one. So I staged them using git add -u. Here is the general cover letter information from Timo included with the 18 patches: ----------------- Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo (From yocto-docs rev: eff391a17d0a2403634adfb2f4cd2ff50ad0b771) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Part 1 of 2 updates to integrating docs to Eclipse help.Timo Mueller2013-02-14194-11175/+35
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Hi, the generation of eclipse help files has been merged from the timo branch to the master. Since the creation of the timo branch there have been some changes to the master branch (e.g. new documentation, renamed documentation). This patch set does some cleanup for the renamed documentation and adds eclipse help generation support to the new documentation. 01: Removes the 'the' from the document titles 02..04: Cleanup obsolete artifacts resulting from the merge 05..08: Add eclipse help generation for ref-manual 09..13: Add eclipse help generation for kernel-dev 14..18: Add eclipse help generation for profile-manual Best regards, Timo This patch set originally contained 18 patches. I (Scott Rifenbark) had to push these changes as two parts. This is the first part. It does not include creation of the three cusomization files. (From yocto-docs rev: 9b1889f6e31ee70dae704fa08763fb9196616dad) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* adt-manual: Added cross-reference link for Cross-dev toolchain.Scott Rifenbark2013-02-141-9/+12
| | | | | | | | | | | | I placed a link on the term "Cross-Development Toolchain" in the section of the same name. This is to help the user see the recipes related to the toolchain. The link resolves back into the "Terms" section of the dev-manual. (From yocto-docs rev: c77ec0212bcf3b1c5f8079ccf08129ecbefea0aa) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to expose cross-toolchain recipes.Scott Rifenbark2013-02-142-33/+89
| | | | | | | | | | | | | | | | | Added a bulleted list to the "Terms" section to help define some toolchain recipes such as gcc-cross-initial, gcc-cross-intermediate, and so forth. Added a cross-reference link to the term "Cross-Development Toolchain" in the the "Working Using Stand-alone Cross-development Toolchains" section. This gives the reader a way to see more on the toolchain recipes. (From yocto-docs rev: 2cb612424c0cf6addfd8bce8a0ef77665c35bd9a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* kernel-dev: Added note for YP release requirements.Scott Rifenbark2013-02-141-0/+4
| | | | | | | | | | | The user needs to have YP 1.2.2 release or forward for the examples in the book to work. I have added a note indicating such. (From yocto-docs rev: 6fcbd3f526a13ef632c7ce5b9b4774d166b61895) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: edits to update-alternatives.bbclass description.Scott Rifenbark2013-02-141-22/+23
| | | | | | | | | | | | | | | | Fixes YOCTO #3838 First draft of edits for this class. Removed specific variable definitions as they are now deprecated. Added a general explanation of the variable functions. Pointed user to the commented code in the actual class for details. Removed statement saying that the build system supports only one binary per package. (From yocto-docs rev: bd574f2c8a95470c5a44500b70743a6e039522b7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Edits to the question on how source code is fetched.Scott Rifenbark2013-02-141-32/+49
| | | | | | | | | | | | Updated the question that asks "How doe the OpenEmbedded build system obtain source code and will it work behind my firewall or proxy server?". Some of the variables did not have links or proper font type. (From yocto-docs rev: be1f665b480a47483595381c9a837892100007e8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated SSTATE_MIRRORS glossary entry.Scott Rifenbark2013-02-141-1/+1
| | | | | | | | | | added links for the PREMIRRORS and MIRRORS variables used in the description. (From yocto-docs rev: 1ec0f9cbeebeaeaadee8cc8b3631e6194c013a2f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Updates to how to use local directories for sourceScott Rifenbark2013-02-141-10/+20
| | | | | | | | | | | | | | The section that describes an efficient way to set up the build system to look in local areas for tarballs needed updated so that PREMIRRORS was not the focus. The example used does not even employ PREMIRRORS. So I changed wording to support the example. I also added a mention of the PREMIRRORS variable and a linked reference to it for more information. (From yocto-docs rev: 7966942e2dfad85c2eb9480d7f706355871c40ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: added MIRRORS glossary definition.Scott Rifenbark2013-02-141-0/+25
| | | | | | | (From yocto-docs rev: 3dfc95974cdaf345d36a51e8f581602242c38148) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added PREMIRRORS glossary entry.Scott Rifenbark2013-02-141-0/+45
| | | | | | | (From yocto-docs rev: a91e562db5c1581cb88f0254f8d5a170296f3e41) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Various typos fixedScott Rifenbark2013-02-141-11/+11
| | | | | | | | | | | | Received a patch from Robert P. J. Day but deleted it from my Thunderbird account so could not apply it directly. I applied most of his corrections. A couple I left alone. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 2cadd5265fcb5cc281c22ccae81260a6633229e2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to "Using .bbappend Files" sectionScott Rifenbark2013-02-141-5/+14
| | | | | | | | | | | | | | | Fixes YOCTO #3664 Added some information in the note to point out that not all append files add files into the mix. Some just exist to add build options. And, in this case the _prepend part of the FILESEXTRAPATHS statement is not necessary. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 388c441341006227be2f9e7d42bb1c509c32790d) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: three typos fixed.Scott Rifenbark2013-02-141-3/+3
| | | | | | | | Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 3272f0d51e3d09f4ffd96b7322f66ffd878d3714) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-10 06:12:17 +0000