summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/dev-manual.xml
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Updated manual revision table to new dateScott Rifenbark2015-04-281-1/+1
| | | | | | | | | Using May of 2015 now. (From yocto-docs rev: b5ade15ae89769e6e9a082e48d635a09ecdcc116) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared for YP 1.6.3 doc release.Scott Rifenbark2015-03-101-0/+5
| | | | | | | | | | | | | | | Updated the following: * poky.ent - bumped the variables for 1.6.3 * <manuals>.xml - updated the manual revision tables for June of 2015. * mega-manual.sed - Rolled the 1.6.2 string to 1.6.3 so links in mega-manual will work locally. (From yocto-docs rev: b3048611d268d129e9e1244d8dab6203519aa361) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added "November 2014" to manual history lists.Scott Rifenbark2014-10-281-1/+1
| | | | | | | (From yocto-docs rev: 6666a0877ecc505493b1bb164f3c405db357f03e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated manual history tables to support 1.6.2Scott Rifenbark2014-07-221-0/+5
| | | | | | | (From yocto-docs rev: 8aeaec680c92955a1bf5ad3898a3f01bd45b8951) 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.6.1Scott Rifenbark2014-06-181-1/+1
| | | | | | | | | Added the release date of "July 2014" (From yocto-docs rev: 7770bbe444c152fb97b9085ac81df91bb0bdbc14) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual Revision Tables for 1.6.1 point release.Scott Rifenbark2014-05-121-0/+5
| | | | | | | | | | I put in the "Sometime in 2014" string for when this point release would be available. (From yocto-docs rev: 82d14a71db7e033e8cc58d2b4cc470792275be8f) 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>
* 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>
* 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/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: dev-manual - Removed all trailing whitespace.Scott Rifenbark2012-12-111-9/+9
| | | | | | | (From yocto-docs rev: d117584a589460412a7fc4df15512b0d9c9448c7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: prepare for 1.4Scott Rifenbark2012-12-031-0/+5
| | | | | | | | | | | | | | Made changes to the poky.ent file to change the three variables needed to build manuals for 1.4. Made new entries in the manual revision history tables for the five manuals that have them. Each entry shows the "TBD" release coming up. (From yocto-docs rev: f7f75a238d709698f1582ce22e209c09ee60581b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Release date updated.Scott Rifenbark2012-10-171-1/+1
| | | | | | | | | | Updated the release month in all the manual revision history tables to say "October 2012" from "Sometime in 2012". (From yocto-docs rev: 1fc9313fe6c69db3d8cece6d940f78a2f0dc8386) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documenation: dev-manual - re-ordered chapters.Scott Rifenbark2012-10-101-2/+2
| | | | | | | | | | The "Common Tasks" chapter is better suited as the last chapter in this manual. So I moved the development workflows up a chapter. (From yocto-docs rev: 19f0a6411c065388b5bd0083338b164b43baff0e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual, bsp-guide - Removing/Moving Appendix AScott Rifenbark2012-10-101-2/+0
| | | | | | | | | | | | The kernel example appendix is being removed. This broke a lot of links. For now I have moved the information into a new section called "Patching the Kernel". I have preserved the information by adding the old appendix file as kerne-appendix-orig.xml. (From yocto-docs rev: 994235a69362dfb0114ef9001ea7f2f2e2fdc5c3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: dev-manual - Removed Appendix A.Scott Rifenbark2012-10-041-2/+0
| | | | | | | | | | | This appendix is antiquated and needed removed. The BSP development example is now in the BSP guide where it talks about running the yocto-bsp script. (From yocto-docs rev: 892ff450d79a7564a72f11eb7510d349ca71d47a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixes to note for mega-manual processingScott Rifenbark2012-09-041-2/+1
| | | | | | | | | | | | | the notes that say "Due to production processes..." at the start of each manual contain links to manuals. the links needed to be formatted such that the entire <ulink> code and manual name appeared on the same line so that the sed script can effectively remove the link in the resulting mega-manual. (From yocto-docs rev: 0a41971c331ad1961e6ee1e067b59c36c9f048f6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: fixed so mega-manual worksScott Rifenbark2012-09-041-2/+2
| | | | | | | | | | | I moved "the" outside of the generated HTML link so that the sed script will process this part of the manual correctly for the HTML mega-manual. (From yocto-docs rev: 3bdf7c7dc4478f2a435cbc84a8a815daf7130660) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed references to the YP Dev ManualScott Rifenbark2012-09-041-1/+1
| | | | | | | | | | The references to the YP Development Manual were inconsistant. These references were fixed. (From yocto-docs rev: f4ded0b965fcbce7b500ca21886ee9b755c38383) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added manual history for 1.3Scott Rifenbark2012-05-311-0/+5
| | | | | | | | | Added entries for the Manual History table for upcoming 1.3 docs. (From yocto-docs rev: 430b384035593cd05c4f286e20c01f0fe72da8ec) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual Revision Tables again.Scott Rifenbark2012-04-231-1/+1
| | | | | | | | | | | After some discussion from Song and Richard, the dates in the manual revision table has been updated to "April 2012" for the 1.2 release. (From yocto-docs rev: b3fc2ec7c5aedb8ea0a2d502bdcd7e8f4092ed96) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Manual Revision Tables updatedScott Rifenbark2012-04-231-2/+2
| | | | | | | | | | Five tables updated for the five manuals that have the tables. Used "May 2012" as the date. (From yocto-docs rev: 0d4d46ba300c07ff9c73186506be5b409bef9d1b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added TBD entry to 1.2 manual history table.Scott Rifenbark2012-03-281-0/+5
| | | | | | | | | | | | There needed to be an entry in all the manual history tables that indicated this version of the manual is for 1.2 but is WIP. Reported-by: Rudolf Streif <rudolf.streif@linux.com> (From yocto-docs rev: 6792b88af4f0171cfc84e4d77bda871d4af3d36c) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual: Converted to use poky.entScott Rifenbark2012-03-231-4/+5
| | | | | | | | | | | | | I converted the hard links to use the variables as established in the file poky.ent. Also, Cleaned up some bad text in the term "Yocto Project Files." Looks like a cut-and-paste problem. (From yocto-docs rev: e2e20bf4895d80dae73595e93132f37fb31121d1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated copyright notices to 2012.Scott Rifenbark2012-03-081-1/+1
| | | | | | | (From yocto-docs rev: a270fe40606ccbef5c453bb77f009306a7bdfb93) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: top-level manuals edited for new structureScott Rifenbark2012-03-081-0/+2
| | | | | | | | | | | | | I updated dev-manual.xml to include the new common tasks file 'dev-manual-common-tasks.xml' and updated poky-ref-manual.xml to not have the file 'extended.xml'. This reflects the new chapter swap between the YP reference manual and the YP development manual. (From yocto-docs rev: 978e3be4f20b0a95cf124ce1a9136016a3e71da1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed all manual links to point to "latest"Scott Rifenbark2011-11-251-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | There are many references to YP documentation throughout the YP manual set. They used to have hard-coded links to the current release (e.g. yoctoproject.org/docs/1.1 for Edison). This created a situation where if you went to a document on the website and clicked on a external reference to another manual, you would redirect to the current manual on the website. Really, you would want to go to the latest manual, which is one that is under development. Changing the links to "yoctoproject.org/docs/latest" makes the tip of master, which is used for devloping the next release, always have references to the manuals being developed and not back to the stable released set of manuals. This "latest" and "current" scheme for the links is not perfect. What has to happen when the latest set of the manuals freezes and becomes the next stable release, all the links in the docs will need to be changed from "latest" in the URL to the new release number. So for example, all the "latest" occurences would need to be changed to "1.2". Then for the next cycle as development begins again, the links need to be infused with "latest" again. (From yocto-docs rev: a234aef34303b07671da956de0e94b352797143e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated title pages.Scott Rifenbark2011-10-041-3/+2
| | | | | | | | | | | | Updated the title pages for the ADT, BSP, Dev, and Ref manuals to contain the Oct 6 release date for the books. Also, changed the author field for the BSP guide to include Tom Zanussi as well as Richard Purdie. (From yocto-docs rev: 301da0a5b305e4b332397bb67f6a6a77751991d2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changes to Paul Eggleton's edits for various manuals.Scott Rifenbark2011-08-241-1/+1
| | | | | | | | | | | | | | Paul sent me a bunch of minor edits and technical corrections for the ADT, BSP, Development, and YP reference manual. Most changes were taken as he submitted them. However, some formatting conventions were not followed in the commits he made to yocto-docs/paule/docs2. After merging them to my yocto-docs/master branch I fixed some issues. (From yocto-docs rev: 93f4ea2dee976448f623953e801a80d59736450a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: set titles for all documentsPaul Eggleton2011-08-241-1/+1
| | | | | | | | | | These documents do not have titles when showing up on the website; set the title tag value so that they do. (From yocto-docs rev: baf958e3f49317689275b14dd31c6141f36c8c65) Signed-off-by: Paul Eggleton <paul.eggleton@linux.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: updated the note in the front matter to use a link specific ↵Scott Rifenbark2011-08-201-1/+1
| | | | | | | | | to manual. (From yocto-docs rev: 8008a00e188dc0569d0fb6e5cf497637a0b57747) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: updated note for latest documentation.Scott Rifenbark2011-08-201-2/+4
| | | | | | | | | The link does not exist yet. (From yocto-docs rev: e74440f299eee8372090a749a301b10871eb297f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: Repositioned note.Scott Rifenbark2011-08-041-6/+7
| | | | | | | | | | Put the note about manual differences in the legalnotice area. this produced a better looking note. (From yocto-docs rev: 8d44a5fba7c52d5798758467e93c9c64e48d512a) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: Added note to title page.Scott Rifenbark2011-08-041-9/+12
| | | | | | | | | | | Note mentions possible differences between docs in the released tarball and docs on the website. Suggests website for latest docs. (From yocto-docs rev: 1675c31aa02a4daed356af4ea9c78d493a9a2597) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: updated files to the bookScott Rifenbark2011-08-041-2/+2
| | | | | | | | | I removed the cases chapter and added an appendix for kernel example. (From yocto-docs rev: 60c8ec3444c08e94468ff349b676652c7f6ff0cd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: Added the new appendix for BSP.Scott Rifenbark2011-08-041-0/+2
| | | | | | | | | Updated the list of files to include dev-manual-cases-bsp-appendix. (From yocto-docs rev: 0756e69e25fb4008fae592f3e06b03b3d773e0a8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: re-ordered the chapters for the make.Scott Rifenbark2011-07-211-2/+2
| | | | | | | (From yocto-docs rev: 0fa74f9339128d8817e7d26de5d48a54772d7274) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: Added chapterScott Rifenbark2011-07-211-0/+2
| | | | | | | | | | I added the dev-manual-model.xml chapter to the list of chapters to include. (From yocto-docs rev: 513faf68cdf338b28020119266148287ea459916) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/dev-manual/dev-manual.xml: Initial file with new name.Scott Rifenbark2011-07-211-0/+69
(From yocto-docs rev: cd67481e8a6424b424a15dbbcbed8d39f1f6d689) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>