summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* dev-manual: Fixed variable link to DEFAULTTUNE variableKristi Rifenbark2018-02-141-1/+1
| | | | | | | | | Fixed [YOCTO #12458] (From yocto-docs rev: 161d7ec7c81db93120af11b07162b36785614302) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added 16.04 as the LTS for UbuntuKristi Rifenbark2018-02-141-1/+1
| | | | | | | | | Fixed [YOCTO #12537] (From yocto-docs rev: 20a80210eeefddff91a6ea669a63c417144a529c) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, dev-manual: Created Layer Model sectionScott Rifenbark2018-02-142-72/+120
| | | | | | | | | | | This involved removing the general information about layers from the dev-manual and incorporating it into the new section of the getting-started manual. (From yocto-docs rev: 26438b03751948661f48fb0c023e393101b80e19) 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-144-2/+257
| | | | | | | | | | | 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>
* getting-started, mega-manual: Added new GS chapterScott Rifenbark2018-02-143-0/+52
| | | | | | | | | | | | I have added a chapter to the getting-started manual that will introduce the YP. Just the framework exists at this point. Changes to the mega-manual.xml file were made to include the new chapter in that manual as well. (From yocto-docs rev: 8a52156ac02d9a9a97c5f0cd8dce5f70d2be68d0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Chapter title changeScott Rifenbark2018-02-141-1/+1
| | | | | | | | | Updated the manual introduction chapter's title. (From yocto-docs rev: db067668a6202318bbbcc62cc455c34e099182de) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Removed Ubuntu 14.04 from Supported Linux DistributionKristi Rifenbark2018-02-141-2/+2
| | | | | | | | | Fixes [YOCTO #12537] (From yocto-docs rev: 1bfa46614a93320c44ddc31fa8866e82c5349293) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Moved the detailed build section to concepts-manual.Scott Rifenbark2018-02-148-1711/+1850
| | | | | | | | | | | | | | The section that provides a closer look into the build system has moved from the getting-started manaul to the concepts-manual. I fixed all the links, provided some coded formatting of the entire section, and made general updates. The other manuals had links that needed fixed due to the move. (From yocto-docs rev: b83a5619f56ebd9879fdcadcf474859e68b26d58) 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>
* getting-started: Removed unused figuresScott Rifenbark2018-02-1413-0/+0
| | | | | | | | | | The figures from the deeper look of the build section got moved to the concepts manual. Removed these unused figures. (From yocto-docs rev: 13175a89b6d7bf79a86f4ac45d5f2cd78ba02108) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Added figures for closer look sectionScott Rifenbark2018-02-1413-0/+0
| | | | | | | | | | Had to move these figures from the getting-started manual to the concpets manual. (From yocto-docs rev: ba221db465a7535197d9e29f5136ef2d3a6e3171) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, getting-started: Moved the BB syntax sectionScott Rifenbark2018-02-142-300/+327
| | | | | | | | | | | This section on BitBake syntax appeared in the Getting Started manual. I decided that it should live with the section on writing a new recipe. (From yocto-docs rev: 8d83ce3e11405b2f12f27cdd117a19c4af52146a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Updated the introduction text.Scott Rifenbark2018-02-141-23/+4
| | | | | | | (From yocto-docs rev: f8ee4c23b46bb02cf82d26ed6c1849cae0cad51f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: General editsScott Rifenbark2018-02-141-61/+58
| | | | | | | | | | Removed redundant links, changed some wordings. This was a general scrub of the prose. (From yocto-docs rev: 2c0ff0af7df3aa46fc05aaf28039a2ffb380424a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Updated toolchain fig to use "*_ext"Scott Rifenbark2018-02-141-0/+0
| | | | | | | (From yocto-docs rev: 64f3edd786779a1c1a7da8a5005c653a4ff8ce2a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated "Build System" term to "Build Host"Scott Rifenbark2018-02-141-2/+2
| | | | | | | (From yocto-docs rev: 2f5b8678e3c4b791a8cdfe5e75da706b97fbc753) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Updated toolchain figure to use "*_extScott Rifenbark2018-02-141-0/+0
| | | | | | | (From yocto-docs rev: 88bf1a438f7a7323f1b7275d3d7bf715d4973569) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated comprehensive list of manuals etc.Scott Rifenbark2018-02-141-11/+36
| | | | | | | | | | I added the concepts manual, the ref manual, and the mega- manual to the list. (From yocto-docs rev: 180387ac9ae74cd5b69c4cf6338b72daef4b9f37) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Content adjustments for the manual.Scott Rifenbark2018-02-142-23/+23
| | | | | | | | | | | The manual's two files are an introductory chapter and then a deeper concepts chapter. I scrubbed through the material, which originated from the getting-started (overview-manual). (From yocto-docs rev: 2ca572fac3ca71e73aad9bdd516a6ce90b148c53) 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: Updated links into new concepts-manualScott Rifenbark2018-02-144-10/+10
| | | | | | | | | | | | Creation of a new concepts manual and moving of chapters from the getting-started (overview-manual) caused many links and manual reference titles to break. I fixed these throughout the YP docs. (From yocto-docs rev: 30f2bc46be4a0faf5302eb8605bcb29f3bee6cf3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Updates to parent fileScott Rifenbark2018-02-141-8/+6
| | | | | | | | | | Edits to create the main file that builds the concepts-manual. Includes the chapters that comprise the book. (From yocto-docs rev: d3a82e7cf50d77fcc4a37f13be98a61d85b1e527) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Updated customization files to point to style guide.Scott Rifenbark2018-02-142-2/+2
| | | | | | | (From yocto-docs rev: d0b35e9fa0240466dc4d5436e3a12ba87114951e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Updated style sheet to display title PNG file.Scott Rifenbark2018-02-141-1/+1
| | | | | | | (From yocto-docs rev: 90eab7064d1fca0d37fd49db163d792880be5a1b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Added concepts-manual so it can be madeScott Rifenbark2018-02-142-0/+14
| | | | | | | | | | Also updated the mega-manual.sed file with two lines to process links in the concepts-manual. (From yocto-docs rev: 622ce2fc82cbf92351aa2000c3d92bbabafc1d24) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual, mega-manual: Added title fig for concepts-manual.Scott Rifenbark2018-02-142-0/+0
| | | | | | | (From yocto-docs rev: c932704d29bd0a065a28675859d5b6f09d8e87e5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Removed unwanted figuresScott Rifenbark2018-02-1420-0/+0
| | | | | | | | | | | | When creating the new concepts-manual, I copied the existing getting-started manual over. This created a figures folder that had a lot of figures not needed in the concepts-manual. They have been removed. (From yocto-docs rev: 24bd39c7f3967a1e8fbac7a8ab44360c25a9bec1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Removed redundant chapterScott Rifenbark2018-02-141-2890/+0
| | | | | | | | | This chapter appears in the getting-started manual. (From yocto-docs rev: 3f4c2fc211189e59e45bef6b379dc1f6ebfb7391) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Added new manual treeScott Rifenbark2018-02-1427-0/+6066
| | | | | | | | | Tree added only. (From yocto-docs rev: bacfd8c9103489c9b5a3459855d0804531ef3a75) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Purged overview manual referencesScott Rifenbark2018-02-1419-104/+110
| | | | | | | | | | | | | | | | | | | | When I converted the Yocto Project Overview Manual to the Getting Started With Yocto Project Manual, I updated the strings for references from "&YOCTO_DOCS_OVERVIEW_URL" TO "&YOCTO_DOCS_GS_URL". Unfortunately, I did it with a global command that did not take into account the text the might follow the link by saying "see such-and-such section in the Yocto Project Overview Manual." So, I had to hand fix these. Additionally, since I have moved a deeper concepts chapter that was in the getting-started manual to a new Yocto Project Concepts chapter, many of those links changed had to really go to the new manual instead. Those were fixed. (From yocto-docs rev: fca1c56b0764802fb6a687ea81ab0fb95186cf0a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual.xml: Removed the getting-started-concepts.xml fileScott Rifenbark2018-02-141-3/+0
| | | | | | | | | | | | Because the deeper concepts chapter that was in the Getting Started With Yocto Project Manual was moved to a new Yocto Project Concepts Manual, I had to delete it from the mega-manual.xml file where it would be included as a chapter in the getting-started manual. (From yocto-docs rev: a6847cc90cd0e35e275dd4cf080067ecbe5d4361) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Removed "concepts.xml" fileScott Rifenbark2018-02-142-1932/+1
| | | | | | | | | | | | This file was for a deeper concepts chapter. It will go into the new Yocto Project Concepts Manual. Removing it required deleting the *.xml file and updating getting-started.xml to not include it in the build. (From yocto-docs rev: 2df213c1cdba8f48918e8240de47c1758352807d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Added variable for "concepts-manual"Scott Rifenbark2018-02-141-0/+1
| | | | | | | | | New variable for links into the new "Yocto Project Concepts Manual". (From yocto-docs rev: 8a19b2b9d54cce664605993da068eed9537736a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Updated references to Bugzilla wiki pageKristi Rifenbark2018-02-142-4/+10
| | | | | | | | | Fixes [YOCTO #12475] (From yocto-docs rev: 460660fda7433959cff13897ece4a6c9f7ff8d09) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Reformatted Note to use bulletsKristi Rifenbark2018-02-141-23/+24
| | | | | | | (From yocto-docs rev: 2aa21e54b620c147ea6db9dee206e40800d7d34c) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Removed accidental tracked filesScott Rifenbark2018-02-1492-10021/+0
| | | | | | | | | | | | | I accidentally pushed a commit after building out the new getting-started manual before applying some key files to the .gitignore file. So, the HTML, TGZ, and eclipse/* stuff got tracked in Git. I don't want that. So I had to use the 'git rm' command to untrack those files. (From yocto-docs rev: 217f6db7f741cee266885a845b2b0e7faf96e537) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Changed chapter idScott Rifenbark2018-02-141-1/+1
| | | | | | | (From yocto-docs rev: 52cc6ae12c5c92f6f8e508571b943443a6d133f1) 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-14148-125/+10147
| | | | | | | | | | | | | | | | | | | | 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>
* ref-manual, dev-manual: Moved "Speeding Build" to dev-manualScott Rifenbark2018-02-142-25/+19
| | | | | | | | | | | | | Fixes [YOCTO #12370] The section on "Speeding Up a Build" that was in the ref-manual needed to be in the dev-manual as it is a "how-to" section. Moved it. (From yocto-docs rev: 44d2889a4f3fb5dfabb1ea4df68a1b8bbf9347c8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed "usingpoky" chapter from ref-manualScott Rifenbark2018-02-144-189/+165
| | | | | | | | | | | | | | | | | Fixes [YOCTO #12370] All of the information from the "usingpoky" chapter in the ref-manual has been distributed out over the rest of the YP manual set. Primarily, this information went into the dev-manual and the overview-manual. Because the chapter is no more, I had to update the mega-manual.xml to not include that chapter. Also, had to update ref-manual to exclude the chapter as part of the Make process. (From yocto-docs rev: b988cab06d42f0ac2220cefe66949c5ab6cbf803) 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-149-515/+576
| | | | | | | | | | | | | 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>
* ref-manual, dev-manual: Moved QEMU info from ref-manual to dev-manualScott Rifenbark2018-02-142-377/+351
| | | | | | | | | | | | | | | | Fixes [YOCTO #12370] The QEMU information in the ref-manual "using" chapter has been moved to the dev-manual's chapter 5, which is a dedicated QEMU chapter. Some information is reference and that is why I had it separated out into the reference manual. However, pressures are mounting to get that stuff out of the ref-manual and into the dev-manual. So, it has been moved. (From yocto-docs rev: 69098ad83b10fab341ec3d5532e377dcfbbfc05e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, ref-manual: Consolidated debug info into dev-manualScott Rifenbark2018-02-145-1350/+1436
| | | | | | | | | | | | | Fixes [YOCTO #12370] Moved the debug information from the ref-manual to the dev-manual where other debug information exists. We now have a single area (section) that deals with various debugging techniques and tips. (From yocto-docs rev: 95394197fc04981bf7571e581ff8a0fd9c76223f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed "Build Notes" that had gone stale.Scott Rifenbark2018-02-141-52/+0
| | | | | | | (From yocto-docs rev: 38e51c441619bf6b9761faeef8278b51997f93d3) 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-144-158/+120
| | | | | | | | | | | | | 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: Variable Definition Edits for documentation.confKristi Rifenbark2018-02-141-50/+49
| | | | | | | | | | | Fixes [YOCTO #5600] Grammar scrub of variable definitions in documentation.conf (From yocto-docs rev: 199fdc55aae4f34d95988ee2e43f3524fe82714a) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, yocto-project-qs: Removed 6.x CentOS NotesKristi Rifenbark2018-02-142-21/+0
| | | | | | | (From yocto-docs rev: 0a553dabddd4cd11ec37339822072bd7bb674dab) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Replaced python3-pip with python34-pip for CentOSKristi Rifenbark2018-02-141-1/+1
| | | | | | | | | | | | Fixes [YOCTO #12467] This is an essential package for CentOS. The variable affected two lists, one in ref-manual and one in yocto-project-qs. (From yocto-docs rev: 73dbdca86716c1d264d14d2472a8acd3a963b26e) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Variable Descriptions for documentation.confKristi Rifenbark2018-02-141-20/+23
| | | | | | | | | | | Fixes [YOCTO #5600] Grammar scrub on all variable description for documentation.conf (From yocto-docs rev: 3054b1e4649d232f08f1065bad96b90eed57d517) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed errant "-->" stringScott Rifenbark2018-02-141-2/+0
| | | | | | | (From yocto-docs rev: b0102a47278bc6c0f598be889d0bfb78bc5f322d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>