summaryrefslogtreecommitdiffstats
path: root/documentation/mega-manual/mega-manual.xml
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Moved devtool workflow to sdk manualScott Rifenbark2017-07-121-2/+0
| | | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The section on the devtool workflow in the dev-manual was 99% identical to what was in the sdk-manual. I have moved the workflow procedure from the old "Model" chapter of the dev-manual to be merged with what was in the sdk-manual. In truth, the only things added were a note about devtool not being exclusive to SDK development. The result of moving (deleting) this section was that the "model" chapter of the dev-manual went away. The devtool stuff, Quilt, devshell, and python shell are all out now and there is no chapter left. So, mega-manual had to be adjusted to not pull that chapter in when building the dev-manual. I had to delete three figures that were used in the flow. The figures were already replicated in the sdk-manual. The figures were deleted from the figures folder of both the dev-manual and the mega-manual. I had to make sure all references to the old devtool stuf in the YP doc set were adjusted. (From yocto-docs rev: 5dbd643d31ab502df53a22229e457a03da7772b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Re-write of dev-manual setup chapterScott Rifenbark2017-07-121-1/+1
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The chapter on setting up YP has been completely re-written to move towards a "how-to" manual. This involved touching every aspect of the chapter. All subsections now have procedures surrounding set up stuff. There are some development sections that still need fleshed out. Many, many links and references in other chapters were affected. These have been fixed. A couple style-sheet (*.css) files were also updated to support the "writernotes" style, which renders paragraph text in red. (From yocto-docs rev: c4c2a6cf575ce5c783b1cc84d9f7e961aebef49c) 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/+3
| | | | | | | | | | | | | | 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: Added new appendix for customizing standard SDKScott Rifenbark2016-11-161-0/+2
| | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #8584] This fix essentially had to document how to add the API documentation to the standard SDK. The fix required adding a new appendix to the SDK manual on how to customize that standard SDK. I could not put just one topic in a new appendix so I also added a sub-section on how to add indidual packages to the standard SDK. Other changes here were the introduction of a new file for the new appendix, updated the mega-manual.xml file so that it would include the new chapter when the MM was built. Finally, I added some cross-referencing to the new appendix from the TOOLCHAIN_HOST_TASK and TOOLCHAIN_TARGET_TASK variables. And a cross reference from the distro features section on the api-documentation bullet. (From yocto-docs rev: 1fb4321ae42253d1fc9602496b5e9e8b495197dd) 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>
* mega-manual: Added new chapters to support building the manualScott Rifenbark2016-10-111-1/+6
| | | | | | | | | | | | Due to new chapters in the SDK manual and the movement of the devtool Quick Reference from the dev-manual to the ref-manual, I had to xinclude these various chapters in the mega-manual.xml file that builds out the manual. (From yocto-docs rev: 8d6fb3d97e6a64b53cfdf66d94d7306babb48378) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Added the new mars appendix to the sdk-manual build section.Scott Rifenbark2016-09-231-0/+2
| | | | | | | (From yocto-docs rev: 5e9e7553260e7c684f30fd2565ba8c03b8cd0462) 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>
* mega-manual: Added two new sections for the sdk manualScott Rifenbark2016-03-231-17/+4
| | | | | | | (From yocto-docs rev: 89bf843f13563288d556edf13fde8f6ad3c32868) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Initial Manual frameworkScott Rifenbark2016-01-071-0/+13
| | | | | | | | | | | | | | | | | | | | | | Makefile - Added support for new sdk-manual. mega-manual - Added the sdk-title.png file to the list of figures. Modified to support inclusion of the new sdk-manual into the mega-manual. poky.ent - Added a new string to support the new sdk-manual. sdk-manual - Created new sdk-title.png image. Created new sdk-manual.xml file. Created sdk-manual customization layers for both standard build and Eclipse build. Note that we are pointing to local XSL templates for and these will change going forward. Created new sdk-style.css file. Created three chapter files that are placeholders at this point. (From yocto-docs rev: ab591831a97a97d405d13ed75e9fb01e0452c292) 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-3/+3
| | | | | | | | | | | | 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>
* mega-manual: Updated the chapter structure for the toaster manual.Scott Rifenbark2015-04-011-0/+3
| | | | | | | | | | Added the reference chapter in so it is included as part of the mega-manual. (From yocto-docs rev: 90a6ebabd0657d6dd7381a8c1fc7db5ea8b26a1f) 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>
* mega-manual: Edits to fix titlingScott Rifenbark2015-02-171-18/+123
| | | | | | | | | | | | | | | | | | | | | The way the mega-manual used 'xinclude' to suck in the other YP manuals was to suck in the root XML file. The problem with this was that the root XML file for each subsequent book would include front-matter information. The front-matter information included an .authorgroup style, which caused the new mega-manual title displayed at the very top to be also re-displayed with a subsequent manual's title. These changes altered the strategy for using 'xinclude' to pull in the various YP manuals. Rather than pull in the root XML file for a given manual, individual chapters are pulled in that comprise a given manual. A slight side-effect is that chapter numbering is sequential from top to bottom in the mega-manual, which I suppose is better as it is being presented as an entire manual anyway. (From yocto-docs rev: 61cc9f2f92900894ef09ff13e1e92ebe30a17be3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Added toaster-title.png and code to include toaster-manualScott Rifenbark2015-02-171-0/+5
| | | | | | | | | | | | | | | Fixes [YOCTO #6901] Added the toaster-title.png file to the mega-manual/figures folder so the Toaster title would show up in the mega-manual. Added lines so that the mega-manual would include the Toaster manual file to the mega-manual. (From yocto-docs rev: 5a4a67e4f140802da133b7bcb480c84b4a8edb63) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual, Makefile, poky.ent: Added front matter to mega-manualScott Rifenbark2015-02-171-0/+60
| | | | | | | | | | | Put in proper front matter for the mega-manual. This effectively creates a real title for the manual as well as a brief abstract that explains why this behemoth exists. (From yocto-docs rev: 26c78f0b00762846a839fbfc9ba969b7aa5d5b58) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Revert "yocto-project-qs, mega-manual: Conformed to YP book set"Scott Rifenbark2014-12-191-2/+0
| | | | | | | | This reverts commit 914c482bd89071ab34b3381e3bd8065f871cc047. I had to revert this change because it broke the footnote behavior. Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs, mega-manual: Conformed to YP book setScott Rifenbark2014-12-191-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | I discovered some artifacts and inconsistencies with how the YP Quick Start was made. I made the following changes: 1. Changed the structure of the QS from "article" to "book" as it is a separate book. This change doesn't fix anything but it does bring the XML file closer to passing validation. 2. Removed the <abstract></abstract> tag. This tag was in place simply to display the PNG file for the Yocto logo in the upper right part of the first page. After turning the QS into a book from an article, the title could be displayed as a PNG file similar to the other books. This change solved two issues: 1) removed the empty "abstract" element from being displayed in both the mega-manual and the PDF version, and 2), brought the author and look of the first page into line with other YP manuals. 3. Removed the old PNG file used to display the Yocto logo at the top of the QS. This file was removed from both the yocto-project-qs and mega-manual "figures" directories. 4. Added a new "yocto-project-qs-title.png" file to both the yocto-project-qs and mega-manual "figures" directories. 5. Updated the "qs-style.css" file's .authorgroup element to match and behave like the other YP manuals. This effectively correctly displays the title PNG file for the QS. 6. Updated the Makefile area where the TAR files are made for both the yocto-project-qs and the mega-manual. I had to substitute in the new PNG file for the QS one and had to add the title PNG to the mega-manual part. (From yocto-docs rev: 914c482bd89071ab34b3381e3bd8065f871cc047) 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>
* mega-manual: Added support to build profile-manual.Scott Rifenbark2013-01-271-0/+5
| | | | | | | (From yocto-docs rev: fe59bccc799daf03d4dc8ccbbb842529dc41d3ea) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Updated the top-level XML file.Scott Rifenbark2013-01-161-0/+5
| | | | | | | | | | 1. Changed "poky-ref-manual" to "ref-manual" 2. Inserted new lines to support "kernel-dev" manual. (From yocto-docs rev: a134992633572c0b006ae73d47512be89d13ba8e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Fixed to include ref-manual.Scott Rifenbark2013-01-071-10/+10
| | | | | | | | | | this still had the "poky-ref-manual" string in it. It needed the "ref-manual" string. (From yocto-docs rev: f771aaa09bf439e506dc5d8573a34283a1a905fb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation/mega-manual: New mega-manual directoryScott Rifenbark2012-09-041-0/+48
This new directory contains the files for the mega-manual HTML document. Mega-manual is a compilation of all the existing YP manuals and guides. It is a single HTML file that simply lists each individual HTML document for the existing YP manuals and guides. The figures directory contains all the figures (duplicated) from the individual manuals and guides. (From yocto-docs rev: 5620c20ea4c7c69c96601b7480471e6166fd9409) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>