aboutsummaryrefslogtreecommitdiffstats
path: root/documentation/mega-manual
AgeCommit message (Collapse)Author
2016-06-06documentation: Prepared manuals for a 2.2 release.Scott Rifenbark
* 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>
2016-04-18documentation: Converted "meta-yocto" to "meta-poky"Scott Rifenbark
Occurrences in many manuals and one figure. (From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-04-06documentation: Updated release date in manual history tables.Scott Rifenbark
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>
2016-04-06mega-manual: Removed the adt title .PNG file.Scott Rifenbark
(From yocto-docs rev: b98f02b7ded825ef6bde3df0a201f9aaac9ebdfe) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23sdk-manual, mega-manual: Updated the SDK devtool modify diagramScott Rifenbark
Removed the bitbake option and the TMPDIR terminology. (From yocto-docs rev: c543e00eeb9e9a8074dfb195c971c37c095ecbdd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23mega-manual: Added two new sections for the sdk manualScott Rifenbark
(From yocto-docs rev: 89bf843f13563288d556edf13fde8f6ad3c32868) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23ref-manual: Resolving a conflictScott Rifenbark
(From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23sdk-manual, mega-manual: Added new figure for Eclipse flow.Scott Rifenbark
(From yocto-docs rev: 27150d4ed7dded90d726d91d92e4f905d365c3ba) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23sdk-manual, mega-manual, Makefile: Added new figuresScott Rifenbark
Added a devtool add and devtool modify flow digram. Updated the Makefile to support those figures in the tarball creation. (From yocto-docs rev: b40692065262dee0209329886b6e3a743c32b1bd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23sdk-manual: Added a new figure for installed extensible sdk directory.Scott Rifenbark
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23Makefile: Updated the figure list for the mega-manual.Scott Rifenbark
Including three figs for Toaster manual. (From yocto-docs rev: c41f9859b6cfc4e34b8e0d0e812fad0b8dd44540) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-23mega-manual, Makefile: Added support for three new toaster figures.Scott Rifenbark
These figures were added through a patch and needed to also be local to the figures directory in the mega-manual. Also, the Makefile must list the figures for the TAR file. (From yocto-docs rev: 6904899f2df8c531f1d6f7c61482d737b9e93971) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11dev-manual, mega-manual: Updated "Application Development SDK" section.Scott Rifenbark
I updated the figure for this section to include some stuff for the extensible SDK. I updated the text supporting the figure to cover the different SDKs and the different SDK variable sets. (From yocto-docs rev: 5aafab3e2e841293ddba45dfd8683cbdc223ed7c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-11ref-manual, mega-manual: Updated "SDK Generation" section.Scott Rifenbark
Updated the figure used to show SDK generation. I added a block to cover the extensible SDK stuff. This affected the figures folder in both the ref-manual and the mega-manual. Updated the text section to support the new figure. (From yocto-docs rev: b9fd7c2b0ea0e2fe1805a1bb1eb1bcb82c807b66) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual, Makefile: Added support for new upgrade flowScott Rifenbark
Created a new figure for the devtool upgrade flow. Put the figure in the "figures" folder of the dev-manual and the mega-manual. Updated the Makefile to include the new figure when creating Tarball of the dev-manual and the mega-manual. (From yocto-docs rev: 4b504f6f179ca7c7e9a69f23fc25b1f33ced8e44) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Updated the workspace directory structure imageScott Rifenbark
Removed the "mis-spelling" indicators. (From yocto-docs rev: 558362fa59be94a8ebd29fbdbd932ef88d411272) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Updated three figures for devtoolScott Rifenbark
Made some review changes to the workflow structure, devtool add flow, and devtool modify flow diagrams. (From yocto-docs rev: f432d9b0270615974e67a0cc243560fdbfa44724) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Updated the devtool modify flow diagram.Scott Rifenbark
(From yocto-docs rev: 54fbb2c739eb696388c622fd755f0417fa98fe5e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Updated the devtool add flow diagram.Scott Rifenbark
(From yocto-docs rev: eef94731d1eb094623511e1b85a2d8bc47e58b86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Updated the devtool workspace figure.Scott Rifenbark
(From yocto-docs rev: 7c26a08d7549dd47557386e7037429465732b112) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Updated devtool add flow diagramScott Rifenbark
(From yocto-docs rev: 8ae3414d80a7636719184e1b7ae4cc8618ba6887) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Added new figure for devtool modify flowScott Rifenbark
(From yocto-docs rev: 2472ab38e0badd50d4e30e161bb56edba4cfbdb2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Updated the devtool add flow figureScott Rifenbark
(From yocto-docs rev: aec89678e191405e7757d322c004de7bd1ab482c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03dev-manual, mega-manual: Updated the workflow layer content figure.Scott Rifenbark
dev-manual: I did not have the checksum figure there or the sources directory. mega-manual: Per normal, had to copy the updated figure into the figures directory of the mega-manual. (From yocto-docs rev: d6fb3373b2f3c1e89da87d3e8b9877e643f73c8e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-03-03Makefile, dev-manual, mega-manual: Added new figure supportScott Rifenbark
Created a new figure for devtool add flow. Added support for it in the Makefile. The figure, as usual, needs to reside in the figures directory in both the dev-manual and the mega-manual. (From yocto-docs rev: 2040a31b806fdade060f7a4182a09673b76db7b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29ref-manual: Updated the SDK figure.Scott Rifenbark
Added the SDKPATH variable to figure. It was missing. Also, had to adjust the display parameters to get it to display decently. (From yocto-docs rev: 4862288ab4675051ec6fc93927839da7eb3634b6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-29ref-manual, mega-manual: Updated the Image Creation figureScott Rifenbark
The old version was off schematically. Moved some boxes around and created more detail to reflect technical correctness. (From yocto-docs rev: 7793101e6866c0c58d0f1202fb04769a21f2f882) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2016-01-07sdk-manual: Initial Manual frameworkScott Rifenbark
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>
2016-01-07documentation: Prepare for 2.1 buildsScott Rifenbark
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>
2016-01-07mega-manual: Added four new figures for GUI example.Scott Rifenbark
Forgot to add these to the mega-manual figures folder so they were not being found when the mega-manual was made. This is an issue with the tarball for jethro but will be correct for the HTML published versions in the jethro branch. (From yocto-docs rev: 509f5c746fc44947ed519307ec6abfa12c954bb2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-10-21documentation: Updated files to support 2.0 release.Scott Rifenbark
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>
2015-07-28documentation: Updated customization layers to point to XSL mirrorsScott Rifenbark
The customization layers were pointing to Sourceforge site for the XSl files needed to build the manuals. Throuhgout time, this site has failed me enough to warrent trying to get these XSL files from some other source. Rather than ship the XSL files with the YP release, we decided to create some mirrors and point the customization files there. (From yocto-docs rev: 4fd1703870694dff1f593b421f90aad0803d9e65) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-05-03ref-manual; mega-manual: Edits to further define packaging processScott Rifenbark
In response to community input where developers were attempting to locate information on how to write packages out to a directory other than ${DEPLOY_DIR}/<package_type>, I updated the "Package Feeds" section, added several new DEPLOY_DIR_* variables, updated four classes, and updated four tasks. Here are some details: * Made changes to the "Package Feeds" section to provide more accurate information in the package feeds directory structure used by the build system in build/tmp. These changes included updating the figure itself and some explanatory text. * Updated the DEPLOY_DIR variable description. * Added new variable descriptions for DEPLOY_DIR_DEB, DEPLOY_DIR_IPK, DEPLOY_DIR_RPM, and DEPLOY_DIR_TAR. * Updated the related classes: package_deb, package_ipk, package_rpm, and package_tar. * Updated the related tasks: do_package_write_deb, do_package_write_ipk, do_package_write_rpm, and do_package_write_tar. Reported-by: Trieu Nguyen <trieu.t.nguyen@intel.com> (From yocto-docs rev: e8742267506bf9359346cfcd3965f762ed2c7d6f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-15documentation: Preparation for 1.9 buildsScott Rifenbark
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>
2015-04-01mega-manual: Added two figures to the figures directory.Scott Rifenbark
The figures I added are for the Toaster manual. (From yocto-docs rev: fb9bb83e48afd2e7d24d68f0c167d8d64f5d25fd) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-04-01mega-manual: Updated the chapter structure for the toaster manual.Scott Rifenbark
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>
2015-03-19documentation: Updated Manual revision tables with "April 2015"Scott Rifenbark
(From yocto-docs rev: a012e34956b8ac2fa7610e264f460bc27bdd66d8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17ref-manual, mega-manual: Adjustments to variable context imagesScott Rifenbark
Fixes [YOCTO #5601] Discovered that the solution I had to display a small PNG file to indicate the context a variable is used in the build system was not displaying properly in the ref-manual variable glossary when using the Chrome browser. The solution was to adjust some settings in the CSS file and place the image after the term. This allowed me to dump the webkit stuff that I had inserted into the CSS file styles to make it work in Mozilla, which ended up not working in Chrome. Additionally, I needed to update the 'define-generic.png' file to have less white space on top as part of the figure. Note that this commit adds the figure to Git for tracking as well. (From yocto-docs rev: 59a1295aeb1c866f330634907ad28642a997cd63) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17mega-manual: Edits to fix titlingScott Rifenbark
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>
2015-02-17mega-manual: Fixed reference to style sheet.Scott Rifenbark
the customization layer for some reason was referencing the ref-style.css file instead of the mega-style.css. I changed this over. (From yocto-docs rev: f47e14c27cde0a436a9ffbf26ca425951eae5d4e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17mega-manual: Added toaster-title.png and code to include toaster-manualScott Rifenbark
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>
2015-02-17mega-manual: New PNG file for mega-manual title page.Scott Rifenbark
(From yocto-docs rev: e3d8af0c6cd88e76f7cf2bcff82e1fffd7a46589) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17documentation: Reverted back to the 1.76.1 XSL stylesheetScott Rifenbark
Using the 1.76.1 version in all the customization layers so the manual revision tables will build with boxes. (From yocto-docs rev: 85a31ef53a59d17bed23ebf57a14db507eb21338) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17mega-manual, Makefile, poky.ent: Added front matter to mega-manualScott Rifenbark
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>
2015-02-17documentation: First draft devtools.Scott Rifenbark
Completed draft of the new devtool material. This commit affects some linking and figures across the YP doc set. * Added the build-workspace-directory.png file to both the dev-manual and the mega-manual. * Updated the Makefile to include the new figure in the TARFILE for dev-manual and mega-manual. * Re-did the section organization to pull the quilt and finding source file out of the "Modifying Source Files" section. (From yocto-docs rev: 4585b9fbb1636ae3c65e2e3ad2d1d6baca636e59) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17ref-manual, mega-manual: Updated buildhistory example figureScott Rifenbark
Scrubbed the eglibc from the buildhistory directory and also replaced with an i586 example. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: c7469f1a857f278e1adac9012d99802195e36849) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17documentation: Changed back to the "current" XSL style sheet.Scott Rifenbark
I need to get back to how it was working and then fix the table box issue from there. Using the 1.76.1 stylesheets makes the build too long for the manuals and sometimes the XSL sheets do not load. (From yocto-docs rev: 7bc502fa069fdc4aebf5705513bb82127716859f) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-02-17dev-manual, mega-manual: Updated kernel-overview-2-generic.png file.Robert P. J. Day
There was a sample string in this tree that ended in "ro" when it should have been "r0" (as in release 0). Anytime you update a figure, the modified file must go in both the "figures" directory of both the manual (dev-manual in this case) and in the mega-manual. Reported-by: Robert P. J. Day <rpjday@crashcourse.ca> (From yocto-docs rev: 8e75cc23fbf03f355fade416a12b7c8fe1e656a5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2015-01-06documentation: Updated all XSL style sheet imports to use 1.76.1 versionScott Rifenbark
This fixes the issue where the lines for the manual revision table are not appearing. For some reason they do not appear when building the docs using Ubuntu 14.10 and the "current" XSL transformation files. So, I backed up to the 1.76.1 version, which is the nearest version where the issue does not surface. (From yocto-docs rev: 82b15986b97b9ed082b652b562eaaf843572fdff) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2014-12-19Revert "yocto-project-qs, mega-manual: Conformed to YP book set"Scott Rifenbark
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>