summaryrefslogtreecommitdiffstats
path: root/documentation/Makefile
Commit message (Collapse)AuthorAgeFilesLines
* Makefile: Set params to suppress numbering in quick build doc.Scott Rifenbark2018-03-031-3/+3
| | | | | | | (From yocto-docs rev: a7a744c01a6ea1550d900d6f53b5d6a774eeeeaa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs, Makefile: New "First Build" article.Scott Rifenbark2018-03-031-2/+17
| | | | | | | | | | | | | | | I have created an brief article in the form of current YP docs that is a pared down version of the Quick Start (pre 2.5 release). The article fills a gap for a short (2-page), process-oriented article that steps the user through an initial build using YP. I had to make changes to the Makefile to support building the new article. (From yocto-docs rev: 47aace60cea4a892ae1efabb050b240c6abdaec9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, mega-manual: Added reference distro poky sectionScott Rifenbark2018-03-031-1/+2
| | | | | | | | | | | | | | Added the new section "Reference Embedded Distribution (Poky)" section to the getting-started manual. The new section required a new figure. I had to add the figure to the figures folder of both the getting-started and mega-manual books. Updates to the Makefile to include the new figure as part the tarfiles created for each book. (From yocto-docs rev: e5f44e17d4c1e55b6f229cc3745727e439b5bcb7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, mega-manual: New content for intro chapterScott Rifenbark2018-02-141-2/+2
| | | | | | | | | | | Created content for "What is the Yocto Project" section. Involved a new figure that had to be shared in the mega-manual figures folder. (From yocto-docs rev: 72c18abd11587f4d78848afb8a71ff7f4a0e76d0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Updated tarball lists for figuresScott Rifenbark2018-02-141-7/+7
| | | | | | | | | | | The list of *.png files included in the TARBALL variable setting changed due to figures moving from the getting-started manual to the concepts-manual. (From yocto-docs rev: 1439fa9f22a2b2746aa8e8303205f5ec33c7f67b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Updates so that the new concepts-manual can be made.Scott Rifenbark2018-02-141-3/+16
| | | | | | | (From yocto-docs rev: ede784df8034d3e582248952716af3441315cae9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Created new "Getting Started" manual.Scott Rifenbark2018-02-141-5/+5
| | | | | | | | | | | | | | | | | | | | Creation involved removing the overview-manual and replacing it with the getting-started manual. All links to the string "&YOCTO_DOCS_OVERVIEW_URL" had to be replaced with "&YOCTO_DOCS_GS_URL" across the entire YP manual set. I renamed files used to create the manual with prefixes suited for the new manual name, which is "Getting Started With Yocto Project". The style sheet for the new manual needed updating to display the new .PNG image for the title page. The mega-manual file had to be updated to include the files. The mega-manual.sed file had to be updated to include the new manual and not use the overview manual. (From yocto-docs rev: 6c7abf9192390121000f577d6c98f259d290d15d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved build history info to dev-manualScott Rifenbark2018-02-141-3/+2
| | | | | | | | | | | | | Fixes [YOCTO #12370] The section in the ref-manual on build history has been moved to the dev-manual. It is more of a "how-to" piece of information than a reference. (From yocto-docs rev: 9634bd8dc51e2972e6a5f3a3d3b4256c8ca8749c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved building image to dev-manualScott Rifenbark2018-02-141-2/+1
| | | | | | | | | | | | | Fixes [YOCTO #12370] The section in the ref-manual that overviewed the buld process was redundant and more of a "how-to" topic. I have moved and merged it into the dev-manual into a similar area. (From yocto-docs rev: 44f1351334342629aaa0976f62e64ac4f67166aa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, overview-manual, Makefile: Moved toolchain conceptsScott Rifenbark2018-02-141-2/+1
| | | | | | | | | | | | | | | | | | Fixes [YOCTO #12370] Moved the "Cross-Development Toolchain Generation" section from the ref-manual to the overview-manual into the concepts chapter. This information is conceptual and now needs to live in the concepts chapter of the new overview-manual. Moving the section caused a few links to have to be fixed in the ref-manual. There was also a figure in the section. So, I had to move the figure from the ref-manual to the overview-manual "figures" folder and update the Makefile for the TARFILE generation. (From yocto-docs rev: 1f3ee5ab308cbe6bd7194086026db397b67ca7c4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, ref-manual: Moved introductory material to overview manualScott Rifenbark2018-02-141-1/+2
| | | | | | | | | | | | | | Fixes [YOCTO #12370] Moved an introductory section for YP that was in the ref-manual to the beginning of the YP environment chapter of the overview-manual. Had to move a figure and update the makefile as well as adjust some links. (From yocto-docs rev: 8ec45f945a21b1f64e7529b95df6b5fb21e87449) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Created new YP Overview ManualScott Rifenbark2018-02-141-10/+11
| | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #12370] Added a new chapter to the newly created Yocto Project Overview Manual. This chapter originated from the YP Reference Manual and was the old chapter 3, which talked a lot about various concepts. This information is better suited for the new overview manual. The change involved moving the entire chapter and renaming it. This move of the content affected many, many external references and links into the old area. Consequently, I had to recast all these links from the different manual. Changes also included fixing the mega-manual.xml file so that it would include the new overview manual as part of it. Many figures had to be relocated as part of the move as well. This meant deleting them from the ref-manual/figures folder and putting them into the overview-manual/figures folder. (From yocto-docs rev: 87b81358f2bbd02b4a0d966d86c4d7b006d4d78f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added new "overview" manual to YP doc setScott Rifenbark2018-02-141-2/+15
| | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #12370] I added all the mechanics for this new "Yocto Project Overview Manual". For now, the manual builds and publishes into the 2.5 area. I used "overview-manual" for the folder name. Makefile properly builds the new manual. The mega-manual.sed file processes links for the new manual. The mega-manual.xml file includes the new manual. The poky.ent file includes a new ENTITY link for the overview manual. All pieces are in place. With this commit, just an overview chapter exists. The remaining content needs to be developed. (From yocto-docs rev: 632ebd4a91920585e736527e070ca8363a00f41b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs, mega-manual: Overhaul of the QSScott Rifenbark2017-12-091-3/+8
| | | | | | | | | | | | | | | | | | | | | | | | | | Changed the way the YP QS looks. The QS now has numbered sections rather than just formatted section heads. This allows the reader to better track the hierarchy of the sections. This feature has been asked for before and I decided it was time to implement it. One thing though, is I am not generating a full TOC at the head of the book as is done in the other YP manuals. Decided to add a manual title .PNG file. This required a new figure file (ypqs-title.png) that needed to reside in the figures folder of both the yocto-project-qs and mega-manual. Updates were required in the Makefile to include the figure. Updates required in the YP QS style sheet to display the figure. Basically, there were all kinds of changes to get this title to show up properly in both the YP QS and in the Mega Manual. Turned the structure of the YP QS into a book now rather than an article. This required creating a "qs.xml" file that has the actual content. (From yocto-docs rev: ef05f5c7ba2a61ebc4c58873cbbc32d35652659d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* makefile: Removed "yocto-environment.png" from tar list of mega-manualScott Rifenbark2017-12-091-1/+1
| | | | | | | | | File is not used. (From yocto-docs rev: 83eb6d4decfe698a5f4be9c3c9792ef60e404323) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to change dev-manual titleScott Rifenbark2017-10-301-6/+6
| | | | | | | | | | | | Updated several files to change the title of the dev-manual from the "Yocto Project Development Manual" to the "Yocto Project Development Tasks Manual." Did some edits in the README and the Makefile as well for completeness. (From yocto-docs rev: 0278d6d3bb458af1cb04fbc3eed96dff12d19475) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Fixed broken tar by adding ".png" to figureScott Rifenbark2017-09-021-1/+1
| | | | | | | | | | | | | The figure "figures/kernel-overview-2-generic.png" was missing the ".png" suffix in the TARFILES statment. This was throwing an error during the make process for the manual. Probably an error for quite some time and not noticed. I added the suffix to remove the make early exit error. (From yocto-docs rev: 00ad7874f8da149f193caeab8fd89bbf6d8132d7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs, ref-manual: Moved YP intro from QS to ref-manualScott Rifenbark2017-07-301-3/+3
| | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The introductory stuff in the QS is really conceptual information and needs to be in the ref-manual where YP is introduced. Regarding the QS, all we really need to do is point to places where the reader can go to find that stuff out. Part of this move involved getting the diagram of the YP flow for the environment from the QS to the ref-manual. That figure was named "YP-flow-diagram.png". It was named "yocto-environment.png" in the QS but I renamed it when moving it to the ref-manual. This caused some edits to the "Makefile" to clean up the figure lists for tarballs. (From yocto-docs rev: ab108c0959e3a9f36d25080245482f8a790c8c87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated "Performing a Simple Build" section.Scott Rifenbark2017-07-121-2/+2
| | | | | | | | | | | | | | I added a figure for this simple build workflow that uses BitBake from a Linux host. Also did a bit of re-writing. A new figure was introduced so the Makefile had to be adjusted to include that figure. The figure resides in the figures directory of both the dev-manual and the mega-manual. (From yocto-docs rev: c3b0b1d53f551c02202cef80a8a48dd24576b975) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Moved devtool workflow to sdk manualScott Rifenbark2017-07-121-4/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | 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>
* kernel-dev, dev-manual: Moved Kernel workflow section to kernel-devScott Rifenbark2017-07-121-2/+1
| | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The overview section of modifying the kernel needed to be in the kernel-dev manual and not in the dev-manual. I moved it and took care of all the links and external references throughout the YP doc set. One figure was involved that had to be moved to the figures folder in kernel-dev from dev-manual. That is why the Makefile had to be edited. (From yocto-docs rev: 3a704b64544678785b883f82d6e82aedac6790c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev: Moved the kernel build hierarchy sectionScott Rifenbark2017-07-121-2/+1
| | | | | | | | | | | | | | Fixes [YOCTO #11630] The section that presented the Yocto Linux kernel file structure resulting from a build using BitBake needed to be in the kernel-dev manual. I moved it over. This required transferring over a figure as well. (From yocto-docs rev: 0abc6c7d87a6aa10dac28fefbb280eb51fea61a7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, kernel-dev: Moved kernel branch concepts to kernel-devScott Rifenbark2017-07-121-2/+2
| | | | | | | | | | | | | | | Fixes [YOCTO #11630] The information in the dev-manual kernel overview area really neeeds to be in the Appendix on kernel structure in the kernel-dev manual. I moved that informtaion to the appendix. Removal of one redundant image was necessary from the dev-manual. The figure was literally repeated in the kernel manual already under a different file name. (From yocto-docs rev: 00ca68e760e41448c225fb1ca4a77f5201434b93) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, bsp-guide: Moved BSP development workflow sectionScott Rifenbark2017-07-121-1/+1
| | | | | | | | | | | | | | | Fixes [YOCTO #11630] Moved the section on BSP Development workflow from the dev-manual into the bsp-guide. This procedure needs to live in the BSP guide. Many links had to be fixed. (From yocto-docs rev: fbf06240f83221929aea237660146e0076207f6a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Moved "Workflows" section to ref-manualScott Rifenbark2017-06-221-2/+2
| | | | | | | | | | | | | Fixes [YOCTO #11630] I moved the "Workflows" section to the ref-manual. This section is primarily concepts and needs to be out of the dev-manual, which is being reconstituted into a "how-to" manual. (From yocto-docs rev: 2f8bfaac3da9e2d7042ea381a3e8957f96b5bf5a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Moved "Yocto Project Source Repositories" sectionScott Rifenbark2017-06-221-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | Fixes [YOCTO #11630] The "Yocto Project Source Repositories" section is purely conceptual and thus does not belong in the reconstituted dev-manual, which is converting to a "how-to" manual. I have moved this section to the ref-manual under "The Yocto Project Development Environment" section. Moving the section affected several things. Three figures that where in the dev-manual were copied and moved to the figures folder of the ref-manual. This required deleting them from the dev-manual and adding them to the ref-manual. The makefile had to be edited to move those figures into the ref-manual and delete them from the latest version of the dev-manual in order for the tarball of files to be correct when the manuals are made. Links to anchors within the moved section had to be fixed in various manuals. Links to the main section "id" had to be fixed to point to the ref-manual manual. (From yocto-docs rev: c619ae2bbc6be93cb0324ca44e936eefec12b28c) 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-3/+6
| | | | | | | | | | | | | | | | | | | 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>
* Makefile: Removed adt-manual supportScott Rifenbark2016-04-061-15/+2
| | | | | | | (From yocto-docs rev: 84abe03de1cff7952b5d0428e7433f094dde2b02) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Resolving a conflictScott Rifenbark2016-03-231-4/+4
| | | | | | | (From yocto-docs rev: b364516928d04da38ef3188f07f190ffac64762b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual, mega-manual, Makefile: Added new figuresScott Rifenbark2016-03-231-2/+4
| | | | | | | | | | 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>
* Makefile: Resolving a conflictScott Rifenbark2016-03-231-1/+3
| | | | | | | (From yocto-docs rev: 221b8eeee23841395b6323da0893156346dead6f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Added the ".png" part to a figure I forgot.Scott Rifenbark2016-03-231-1/+1
| | | | | | | | | | I left off the file extension when I added a new figure to the SDK manual. This caused the tarball to fail. (From yocto-docs rev: f1984b00b44ad7f1890adecdb7e2f6dd4af5b96c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Updated the figure list for the mega-manual.Scott Rifenbark2016-03-231-2/+3
| | | | | | | | | 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>
* Makefile: Added sdk-environment.png to figure list for SDK ManualScott Rifenbark2016-03-231-0/+1
| | | | | | | (From yocto-docs rev: 5576b989539c9fee989a1c75d142d89c62c4da76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual, Makefile: Added support for three new toaster figures.Scott Rifenbark2016-03-231-2/+4
| | | | | | | | | | | | 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>
* dev-manual, mega-manual, Makefile: Added support for new upgrade flowScott Rifenbark2016-03-031-1/+2
| | | | | | | | | | | | 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>
* dev-manual, mega-manual: Added new figure for devtool modify flowScott Rifenbark2016-03-031-2/+3
| | | | | | | (From yocto-docs rev: 2472ab38e0badd50d4e30e161bb56edba4cfbdb2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile, dev-manual, mega-manual: Added new figure supportScott Rifenbark2016-03-031-1/+2
| | | | | | | | | | | | 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>
* sdk-manual: Initial Manual frameworkScott Rifenbark2016-01-071-2/+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>
* Makefile: Updated the make file to not create toaster-manual pdfScott Rifenbark2015-10-211-1/+1
| | | | | | | (From yocto-docs rev: a9babbc10603a2dd984fb633e85f3b3d93e43ac7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs and others: Rewrite of the QSScott Rifenbark2015-07-281-3/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This was a complete re-write of the YP Quick Start in an attempt to streamline it, remove unecessary detail, and make it flow better with the examples. In doing so, many manuals were affected due to section headings being renamed, information being moved, etc. Here is a list of the changes by manual: Makefile - Removed two figures from TARFILE list for the yocto-project-qs. Added building-an-image.png to the ref-manual TARFILE list. Added using-a-pre-build-image.png to the adt-manual TARFILE list. Repositioned 'eclipse' in the adt-manual TARFILE list. adt-manual: Fixed a cross-reference so that it goes to the new 'Building Images' section that is within the YP QS. Added new section 'Example Using Pre-Build Binaries and QEMU' to hold the information that was formerly in YP QS. dev-manual: Removed a cross-reference into the YP QS that promised how to configure the most efficent build. Changed a cross-reference into the YP QS from 'The Packages' to 'The Build System Packages'. Changed a cross-reference into the YP QS from 'Building an Image' to 'Building Images'. Changed a text reference from the YP QS to the adt-manual. Moved the bit about getting YP files by using the YP website from the YP QS to the dev-manual. Changed a cross-reference into the YP QS from 'Using Pre-Built Binaries and QEMU' to 'Example Using Pre-built Binaries and QEMU', which was moved to the adt-manual. ref-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. Moved the note about if your system has oss4-dev in the packages area in the YP QS to the appropriate area in the ref-manual. Moved the introduction information regarding building an image along with the figure from YP QS to the ref-manual's section on building images. toaster-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. yocto-project-qs: Complete rewrite that changed many section headings and removed much detail, which was placed in other manuals. (From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to try to fix CentOS docs build errorsScott Rifenbark2015-04-011-1/+1
| | | | | | | | | | | | The docs are not building on CentOS and we think it is due to the XSL templates being called for the Eclipse parts. I located all the "current" templates and switched them out for "1.76.1" version as are used by the mainstream doc builds. (From yocto-docs rev: afbddde6524630433dfec973bbe886de32395bc8) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Added figures to the mega-manual TARFILE listScott Rifenbark2015-04-011-3/+5
| | | | | | | | | | | Added the three Toaster Manual figures to the list of mega-manual figures so they will be included in the tarball generated for mega-manual. (From yocto-docs rev: 2190bc43dfc20c0c0ef5da82c85570f9294e1788) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Added additional PNG files to toaster TARFILE list.Scott Rifenbark2015-04-011-1/+3
| | | | | | | (From yocto-docs rev: b662062cd575f187918f6841983d5682426b266e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated tar contents to not include the PDF file.Scott Rifenbark2015-02-171-1/+1
| | | | | | | (From yocto-docs rev: b80931a3930ac4eda8daec37dc3de0f1d4d3844e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Makefile: Removed default PDF creation of Toaster Manual.Scott Rifenbark2015-02-171-1/+1
| | | | | | | (From yocto-docs rev: 7cceb7b0a0f53a4207070ff369bec8a3a6ceb135) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Support files to build Toaster Manual.Scott Rifenbark2015-02-171-12/+27
| | | | | | | | | | | | | | | | | | | Changes to the files that support building out and publishing the Toaster User Manual: * poky.ent - Added a new variable YOCTO_DOCS_TOAST_URL that can be used in other manuals to link to sections with the Toaster User Manual. * Makefile - Added a section of code to build out the Toaster User Manual. Currently, no eclipse support is added as I don't think we want to cross into that development environment with Toaster. (From yocto-docs rev: 35ea6656265d61024d5db36a534a7250f783956a) 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-1/+1
| | | | | | | | | | | 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>
* documentation: First draft devtools.Scott Rifenbark2015-02-171-2/+3
| | | | | | | | | | | | | | | | | | | 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>
* Makefile: Modified to make 'pdf' target not part of 'all'Scott Rifenbark2015-02-171-39/+45
| | | | | | | | | | | | | By default, making a file will not include the PDF version of the manual. Some manuals you can't do a PDF version anyway (i.e. yocto-project-qs and mega-manual). The PDF versions do not need to be part of the mainstream make process. If someone wants these they can take the extra step of doing 'make pdf DOC=<manual>'. (From yocto-docs rev: 16f605350adb1b252b94e921faf282d0634cefb6) 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-11-14 03:02:24 +0000