summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-manual.xml
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Updated the manual ref tablesScott Rifenbark2018-12-151-80/+0
| | | | | | | | | I truncated the rows pre-2.4. This is needless history. (From yocto-docs rev: 8f728b4ff907ca06e08e6e3f89e69aed3c777efc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Updated month and year date for 2.4.4 release.Scott Rifenbark2018-11-221-1/+1
| | | | | | | | | | | | Implemented the ENTITY method to apply the month and date release time for the 2.4.4 release, which is now "December 2018". Updated poky.ent to use the new ENTITY. (From yocto-docs rev: 89f034c819288a936fd029dd754fcdd17a86ce43) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated release date for 2.4.4 releaseScott Rifenbark2018-10-201-1/+1
| | | | | | | | | | It was September. More likely to be November now. All manual history tables updated. (From yocto-docs rev: ee04a4f2b95ab99d16b2c0418c12f91350c5bdef) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Preparation for 2.4.4 releaseScott Rifenbark2018-08-151-0/+5
| | | | | | | | | | | | poky.ent - updated variables for 2.4.4 mega-manual.sed - updated string from "2.4.3" to "2.4.4" <manual>.xml - updated manual revision tables for 2.4.4 and September 2018 date (From yocto-docs rev: 1bba098ba20f2b1349ac840fd36f62de401f8701) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepped set for a 2.4.3 releaseScott Rifenbark2018-05-291-0/+5
| | | | | | | | | | | | poky.ent - variables updated mega-manual.sed - 2.4.3 replaced 2.4.2 <manual>.xml - Updated the manual revision tables for a "June 2018" date. (From yocto-docs rev: 62919ae0c15f12f0fcb75e3fc78387ab756d07a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated manual notesScott Rifenbark2018-05-291-13/+26
| | | | | | | | | | | | | I updated the notes to help the user get the version of the docs that they are interested in. Sometimes a search using the web returns really old versions of the manual and the user is clueless about using a manual that is not matching the YP release they are working with. (From yocto-docs rev: d0ef1c7edec0a28ce8a49992b71e6d3c878cdbb4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual Revision Table for 2.4.2 Release DateKristi Rifenbark2018-02-141-1/+1
| | | | | | | (From yocto-docs rev: 1e406f3a88a9a399491e2e0859b568a9ab459b4c) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared files for a 2.4.2 point releaseScott Rifenbark2018-02-141-0/+5
| | | | | | | | | | | | poky.ent - Updated variables to reflect 2.4.2 mega-manual.sed - changes "2.4.1" string to "2.4.2" <manual>.xml - Updated release manual table to use "TBD 2018" release date. (From yocto-docs rev: cee187153d4136a90556fefbdaaf41bdc9d65006) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepped manual set for a 2.4.1 point releaseScott Rifenbark2017-12-181-0/+5
| | | | | | | | | | | * poky.ent updated the variables * Added a January 2018 date to the manual revision tables * Updated the mega-manual.sed file with 2.4.1 string. (From yocto-docs rev: 73993e367c8ba761d61ed69d9f4d5fad69d70e85) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated title page notes and author groupScott Rifenbark2017-10-301-18/+20
| | | | | | | | | | | | | Made the title page notes consistent across the manual set. Made the author group information consistent as well. It is better that authorship is seen as a third party and not tied to Intel Corporation. (From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved kickstart reference to ref-manualScott Rifenbark2017-10-161-0/+2
| | | | | | | | | | | | | | This section was misplaced in the dev-manual and really needed to be in the ref-manual. I created a new chapter that follows the devtool reference chapter and put the kickstart chapter there. Links were needed to be fixed up and a new chapter in the ref-manual named ref-kickstart.xml had to be created. (From yocto-docs rev: b4d5b7077a978e4966d1273a374741075a1b0c7d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documenation: Updated "Usually October" to "October 2017" stringScott Rifenbark2017-10-061-1/+1
| | | | | | | | | | The string in the manual revision table needed updated across the set except for the kernel-dev manual. (From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Re-org for "closer-look" chapterScott Rifenbark2017-06-221-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The ref-manual needs expansion for the old "closer-look" chapter. This chapter previously held a detailed look at what happens when a user uses the YP to develop something. Now, the chapter needs to also contain YP development environment concepts (e.g. open- source philosophy, etc.), which are coming from the dev-manual. Because of this, I renamed the "closer-look.xml" chapter to be "ref-development-environment.xml". I also renamed the larger section that was formerly the entire chapter into its own section named "Development Concepts". Both these changes caused a few links to break. I fixed all the links from within the various manuals so they would find appropriate targets. I did some re-writing for introductory material to introduce the new chapter and the section on "Development Concepts". A new file ("ref-development-environment.xml") was added by basically renaming the "closer-look.xml" chapter. And, the tracking for "closer-look.xml" was deleted. (From yocto-docs rev: e37806474578b4f0ed137f64d68a39a17ab60644) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Created YP 2.4 "latest" docsScott Rifenbark2017-06-041-0/+5
| | | | | | | | | | | | | | Updated poky.ent to use 2.4 variables and numbering Updated mega-manual.sed to use "2.4" string for links Updated all manual revision tables to use "2.4" and "Usually October, 2017" string. (From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added support for "pyro" name and May release date.Scott Rifenbark2017-03-241-1/+1
| | | | | | | | | | | | | poky.ent - changed the "tbd" and "TBD" strings to "pyro" and "Pyro", respectively. Manual Head Files - Updated the manual history table with the May release month. (From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new "Release Process" chapterScott Rifenbark2017-03-241-0/+2
| | | | | | | | | | | | | | Fixes [YOCTO #10888] The YP documentation was missing information on how the major and minor (point) release process works. I added a new chapter in front of the "Maintenance" chapter that details the naming schemes, cadence, and maintenance for YP releases. (From yocto-docs rev: b486f871e1fb8a6f763510ed385f459fe215fa27) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated "latest manual" note on title pageScott Rifenbark2017-02-191-6/+26
| | | | | | | | | | | | | | | Fixes [YOCTO #10076] The note on the title page for each manual was brief regarding where to find the latest version of the manual. I updated the note to have more detailed information on finding current, alternate, and latest versions of the manual based on YP releases. (From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to support developing 2.3 YP docsScott Rifenbark2016-11-161-0/+5
| | | | | | | | | | | | | | | | | | Changes to the following: * All manual revision tables to indicate a 2.3 release proposed for April of 2017. * Updated the poky.ent file so that all variables needed reflect 2.3 values. * Updated the mega-manual.sed file so that processing of links in the mega-manual work for a 2.3 release. (From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual revision table for 2.2Scott Rifenbark2016-10-111-1/+1
| | | | | | | | | Added string "October 2016" as the release date. (From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: devtool upgrade and quick ref changes to mult manualsScott Rifenbark2016-09-281-0/+2
| | | | | | | | | | | | | | | | | | | Did the following: * Added the devtool upgrade flow to the SDK manual. * Removed the devtool Quick Reference from the dev-manual and added it as a new chapter to the ref-manual. * Made sure all the links and cross-references work now with the moved material. * Updated the Make file so that the manual set builds correctly regarding the new chapter in the ref-manual. * Created cross-referencing notes in both the sdk-manual and the dev-manual to the newly located devtool Quick Reference chapter. (From yocto-docs rev: fda0bf68b3654b1b96407d552c5254657465b5fc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared manuals for a 2.2 release.Scott Rifenbark2016-06-061-0/+5
| | | | | | | | | | | | | * Updated poky.ent to have the appropriate 2.2 variables * Updated all manual revision tables to have a new entry for 2.2 - used "Sometime in 2016" for the date. * Updated the mega-manual.sed file to process internal links for 2.2. (From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated release date in manual history tables.Scott Rifenbark2016-04-061-2/+2
| | | | | | | | | Updated to "April 2016" for all manuals that use this table. (From yocto-docs rev: 4d3753cc92c446668b0c383736c2071e24e53dd2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepare for 2.1 buildsScott Rifenbark2016-01-071-0/+5
| | | | | | | | | | | The changes are for the poky.ent file and the mega-manual.sed file to take care of variables. Also, entries added for the manual revision table. (From yocto-docs rev: 60da39f85165e2d4aef55d456f8203183e089433) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated files to support 2.0 release.Scott Rifenbark2015-10-211-2/+2
| | | | | | | | | | | | These updates included editing the poky.ent file so that DISTRO and related variables are now 2.0. Also updated all the title pages to have the manual revision table correct. Finally, used my email for the manuals. (From yocto-docs rev: deae61bfbb528ea0ced82399a78260a7f34a7a11) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Preparation for 1.9 buildsScott Rifenbark2015-04-151-0/+5
| | | | | | | | | | | | | | | | | This involves the following: * Inserting a new row for all manual revision history tables to have "October 2015" and 1.9 as the release information. * Updating the mega-manual.sed file to process links for 1.9 * Updating variables in poky.ent to deal with the 1.9 release variables. (From yocto-docs rev: 1ed55c08b96cf0fded38833635111a5c6da86781) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual revision tables with "April 2015"Scott Rifenbark2015-03-191-1/+1
| | | | | | | (From yocto-docs rev: a012e34956b8ac2fa7610e264f460bc27bdd66d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the manual revision history tables.Scott Rifenbark2014-11-041-0/+5
| | | | | | | | | | Added an entry for the 1.8 release stating that the release is slated for sometime in 2015. (From yocto-docs rev: 9799a7848f24024048eae0cbed470a2be4b4b879) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated release date for manual rev tables.Scott Rifenbark2014-10-031-1/+1
| | | | | | | | | | Added "October 2014" to table for all manuals that have the table. (From yocto-docs rev: 3f9ceb4dd2397fe907bf701c842277eb65d11a56) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new chapter on QA error and warning messages.Scott Rifenbark2014-05-301-0/+2
| | | | | | | | | | This new chapter is a reference on the default configuration QA check messages you can get from errors and warnings. (From yocto-docs rev: 04d766b4e1235ae46df38c4b296cb2729b6a439f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added new chapter on task documentationScott Rifenbark2014-05-131-0/+2
| | | | | | | | | | | | | | Changes to support a new chapter on the 51 tasks that the OpenEmbedded build system defines. The changes include a new file called ref-tasks.xml, changes to the ref-manual.xml building file to include the new chapter, and a new bullet item to the list that describes what is in the reference manual. (From yocto-docs rev: a816746051ec025014e515fb848b3e0e58d4c7be) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the manual revision history tables for 1.7Scott Rifenbark2014-05-131-0/+5
| | | | | | | (From yocto-docs rev: 9014fe95b9607a15c0e72ef1b6df14f250a3d241) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated all the manual revision history tables.Scott Rifenbark2014-04-211-1/+1
| | | | | | | | | Set the release date to April 2014. (From yocto-docs rev: 2592bc968edeea941a92e6bdd321dd872745b78c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed the BitBake chapter.Scott Rifenbark2014-03-301-2/+0
| | | | | | | | | | | | | | | This information now exists in the separate BitBake User Manual. To remove this information, the ref-bitbake.xml file was taken out of the ref-manual.xml build, an overview bullet describing BitBake chapter was removed from the "Introduction" chapter, and one cross-reference link to a sub-section of the old BitBake chapter had to be re-routed into the similar section of the BitBake Manaul. (From yocto-docs rev: 3828291699b5997c28a782600c9d472b8449ecd3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed "Relased date" for the 1.5.1 entryScott Rifenbark2014-03-251-1/+1
| | | | | | | | | | | | | Fixes [YOCTO #5857] I had missed replacing the release date in the manual revision history tables for the 1.5.1 release. It was still an estimate. I have replaced with the actual date of "January 2014" (From yocto-docs rev: fb9abe0df33a9b551d797ac1b72577931f5f8ce6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed Note for most recent manualScott Rifenbark2013-11-011-5/+4
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #5368] Changes partially address this issue, which is the removal of tarball installations for poky. The notes at the beginning of the YP manuals suggested that the tarball version of a manual might lag the version found on the website. Because we are discouraging installing poky/documentation from a tarball now, I have re-written the note to be generic and suggest simply that for the most recent version of the manual associated with the release, see the manual on the website. (From yocto-docs rev: a5e96e7eb719e69bbcf2139af2e20230aedc4247) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to Manual revision tablesScott Rifenbark2013-11-011-0/+10
| | | | | | | | | | | Updated all six tables for both 1.5.1 and 1.6 releases. Both entries need to ultimately be in the 1.6 version of the manuals. (From yocto-docs rev: ac1d2cc5686da142562cd674f7fa8908895a27df) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual Revision History TablesScott Rifenbark2013-10-011-1/+1
| | | | | | | | | Placed the release month of October in for the 1.5 release. (From yocto-docs rev: c0431b2b3115d9687dcb5d3ba37adf6bf4695867) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Created new "Closer Look" chapterScott Rifenbark2013-09-121-0/+2
| | | | | | | | | | | | | | | | | Fixes [YOCTO #2808] I extracted the section that takes a closer look at the YP development process into its own chapter. Feedback during the review indicated that this information should not be buried as it was in a section but rather pulled higher out for visibility. So, The changes create a new chapter three that is dedicated to this topic. (From yocto-docs rev: 32c66976b6b84787d14d6174dab843862a0d184b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to properly build the 1.5 manualsScott Rifenbark2013-05-221-3/+3
| | | | | | | | | | | | | | 1. Changed the variables in poky.ent to contain the "1.5" string and the "tbd" string for the unknowns. 2. Updated the manual revision history tables so to replace the 1.4.1 release entry, which should not be there, to the 1.5 entry. (From yocto-docs rev: d03a09875b1fe0d244b7a7c1bde718319d95a8ab) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Set up the 1.4.1 manual set.Scott Rifenbark2013-05-221-0/+5
| | | | | | | | | | | 1. Edited poky.ent to have 1.4.1 and 9.0.1 for release stuff. 2. Updated the manual revision tables to have a new entry for 1.4.1 release. (From yocto-docs rev: bd4058b98f93ea5fd5d878f24018ce78b8ce1a53) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the release month to April in manual history tables.Scott Rifenbark2013-04-101-1/+1
| | | | | | | (From yocto-docs rev: 3dc4e3db0a76a29c9726d38e3f862940437317c9) 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-141-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* 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: Rename of poky-ref-manual folder to ref-manual.Scott Rifenbark2013-01-071-0/+125
Changing the folder that holds the YP Reference Manual to be "ref-manual". This will help with confustion over the manual's intended purpose. (From yocto-docs rev: 1106442964b5080cb0b6b3bd3af32e9407c0f7c1) 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-21 21:58:54 +0000