summaryrefslogtreecommitdiffstats
path: root/documentation
AgeCommit message (Collapse)Author
2018-02-14concepts-manual: Updated toolchain fig to use "*_ext"Scott Rifenbark
(From yocto-docs rev: 64f3edd786779a1c1a7da8a5005c653a4ff8ce2a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14ref-manual: Updated "Build System" term to "Build Host"Scott Rifenbark
(From yocto-docs rev: 2f5b8678e3c4b791a8cdfe5e75da706b97fbc753) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14concepts-manual: Updated toolchain figure to use "*_extScott Rifenbark
(From yocto-docs rev: 88bf1a438f7a7323f1b7275d3d7bf715d4973569) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14ref-manual: Updated comprehensive list of manuals etc.Scott Rifenbark
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>
2018-02-14concepts-manual: Content adjustments for the manual.Scott Rifenbark
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>
2018-02-14Makefile: Updates so that the new concepts-manual can be made.Scott Rifenbark
(From yocto-docs rev: ede784df8034d3e582248952716af3441315cae9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14documentation: Updated links into new concepts-manualScott Rifenbark
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>
2018-02-14concepts-manual: Updates to parent fileScott Rifenbark
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>
2018-02-14concepts-manual: Updated customization files to point to style guide.Scott Rifenbark
(From yocto-docs rev: d0b35e9fa0240466dc4d5436e3a12ba87114951e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14concepts-manual: Updated style sheet to display title PNG file.Scott Rifenbark
(From yocto-docs rev: 90eab7064d1fca0d37fd49db163d792880be5a1b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14mega-manual: Added concepts-manual so it can be madeScott Rifenbark
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>
2018-02-14concepts-manual, mega-manual: Added title fig for concepts-manual.Scott Rifenbark
(From yocto-docs rev: c932704d29bd0a065a28675859d5b6f09d8e87e5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14concepts-manual: Removed unwanted figuresScott Rifenbark
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>
2018-02-14concepts-manual: Removed redundant chapterScott Rifenbark
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>
2018-02-14concepts-manual: Added new manual treeScott Rifenbark
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>
2018-02-14documentation: Purged overview manual referencesScott Rifenbark
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>
2018-02-14mega-manual.xml: Removed the getting-started-concepts.xml fileScott Rifenbark
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>
2018-02-14getting-started: Removed "concepts.xml" fileScott Rifenbark
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>
2018-02-14poky.ent: Added variable for "concepts-manual"Scott Rifenbark
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>
2018-02-14dev-manual, ref-manual: Updated references to Bugzilla wiki pageKristi Rifenbark
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>
2018-02-14ref-manual: Reformatted Note to use bulletsKristi Rifenbark
(From yocto-docs rev: 2aa21e54b620c147ea6db9dee206e40800d7d34c) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14getting-started: Removed accidental tracked filesScott Rifenbark
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>
2018-02-14getting-started: Changed chapter idScott Rifenbark
(From yocto-docs rev: 52cc6ae12c5c92f6f8e508571b943443a6d133f1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14documentation: Created new "Getting Started" manual.Scott Rifenbark
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>
2018-02-14ref-manual, dev-manual: Moved "Speeding Build" to dev-manualScott Rifenbark
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>
2018-02-14documentation: Removed "usingpoky" chapter from ref-manualScott Rifenbark
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>
2018-02-14dev-manual, ref-manual: Moved build history info to dev-manualScott Rifenbark
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>
2018-02-14ref-manual, dev-manual: Moved QEMU info from ref-manual to dev-manualScott Rifenbark
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>
2018-02-14dev-manual, ref-manual: Consolidated debug info into dev-manualScott Rifenbark
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>
2018-02-14dev-manual: Removed "Build Notes" that had gone stale.Scott Rifenbark
(From yocto-docs rev: 38e51c441619bf6b9761faeef8278b51997f93d3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14dev-manual, ref-manual: Moved building image to dev-manualScott Rifenbark
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>
2018-02-14ref-manual: Variable Definition Edits for documentation.confKristi Rifenbark
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>
2018-02-14ref-manual, yocto-project-qs: Removed 6.x CentOS NotesKristi Rifenbark
(From yocto-docs rev: 0a553dabddd4cd11ec37339822072bd7bb674dab) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14poky.ent: Replaced python3-pip with python34-pip for CentOSKristi Rifenbark
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>
2018-02-14ref-manual: Variable Descriptions for documentation.confKristi Rifenbark
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>
2018-02-14dev-manual: Removed errant "-->" stringScott Rifenbark
(From yocto-docs rev: b0102a47278bc6c0f598be889d0bfb78bc5f322d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14ref-manual: Added overview-manual to list of related documentationScott Rifenbark
(From yocto-docs rev: f0b296e8623078d7d4df45984ebdcdf9f1b65062) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14yocto-project-qs: Removed "writernotes" formatting for Pseudo bulletScott Rifenbark
(From yocto-docs rev: 4b97a330bdc383b377995ebbd81a8a73bf06483a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14overview-manual: Updated "Fakeroot and Pseudo" sectionScott Rifenbark
I added a bit more detail and some better referencing for Pseudo and Fakeroot. (From yocto-docs rev: 459ba368cce50cca1c3b9b7f13b1ec59a7d933ad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14ref-manual: Removed the "technical-details.xml" fileScott Rifenbark
Fixes [YOCTO #12370] The "technical-details.xml" file was for the old chapter four of the ref-manual. All content in that chapter has been moved to the new concepts chapter of the overview-manual. I updated the mega-manual.xml file to not include the old technical-details chapter as part of the ref-manual. I also updated the ref-manual.xml file to not include the technical-details.xml chapter when building the ref-manual. (From yocto-docs rev: c4a88048dc099dbd2d0926a9194d5502fa2f1cfc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14overview-manual, ref-manual: Moved "Licenses" to overview-manualScott Rifenbark
Fixes [YOCTO #12370] The "Licenses" section in the technical details chapter of the ref-manual was concepts and needed moved to the new overview-manual. Some links were broke during the move and they were fixed in the BSP and dev-manual. (From yocto-docs rev: 34c013f055736dcde2fe12daea1aaf2beaee97c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14overview-manual, ref-manual: Moved "Wayland" section to overview manualScott Rifenbark
Fixes [YOCTO #12370] The "Wayland" section needed to be moved to the concpets chapter in the new overview-manual. I moved it and fixed a few links that needed adjusting due to the move. (From yocto-docs rev: b8e84a8cb47194b0d20fe155561d9a346916068b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14overview-manual, ref-manual: Moved Pseudo and Fakeroot to overview manualScott Rifenbark
Fixes [YOCTO #12370] The "Fakeroot and Pseudo" section is concepts and needed moved from the ref-manual to the new concepts chapter of the overview-manual. Some links needed to be fixed as well. (From yocto-docs rev: df2c09407abd5ca468fcd0bd9e241739907a9d63) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14overview-manual, ref-manual: Moved auto added runtime deps sectionScott Rifenbark
Fixes [YOCTO #12370] The "Automatically Added Runtime Dependencies" section moved from the ref-manual to the overview-manual. This topic is concepts and needs to live in the new overview-manual's concepts chapter. Fixed some links in the ref-manual and one in the dev-manual. (From yocto-docs rev: fa3e12030ce867cb81feed453d35c3a3643decd2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14overview-manual, ref-manual: Moved "Shared State Cache" to overview manualScott Rifenbark
Fixes [YOCTO #12370] The section on shared state cache needed to be in the overview manual and not in the ref-manual. I moved it. Some links were affected, which I fixed. (From yocto-docs rev: 1c4e5207bdde19d4b48ef42b1de81390d8a02d64) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14yocto-project-qs: Defined Poky and added overview manual linkScott Rifenbark
Fixes [YOCTO #12128] Updated the phonetic rendition of the term "poky". Historically, this term is mispronounced. I am now saying "Pock-ee" as the official way of pronouncing this term. I also added a link to the Yocto Project Overview Manual that was in the Tip box. The manual did not exist earlier. Since it does exist now, I have added the link. (From yocto-docs rev: 4ec3fe3b8ee4a680f51f53b919732670b3ffe738) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14ref-manual, overview-manual, Makefile: Moved toolchain conceptsScott Rifenbark
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>
2018-02-14ref-manual, overview-manual, yocto-project-qs: Moved YP ComponentsScott Rifenbark
Fixes [YOCTO #12370] Moved the "Yocto Project Components" section from the ref-manual to the overview-manual. This material falls into the "concepts" area and is being moved from the ref-manual. One link in the yocto-project-qs was affected and updated. Oh... another link in the ref-manual for a variable also fixed. (From yocto-docs rev: 75ced485bb223373591eb41d1b343d0c2b315345) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14dev-manual, ref-manual: Moved Wic Plug-In section to dev-manualScott Rifenbark
Fixes [YOCTO #12370] I had a section on Wick Plug-Ins in the ref-manual in the "technical details" chapter. This section has been combined with the section on using Wic that lives in the dev-manual. This move creates a single section on using Wic to create Wic-partitioned images. The section was moved out of the ref-manual and merged into the dev-manual Wic section. (From yocto-docs rev: 8724049141c9a793312dcf5ff5c3425948d1cbd0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
2018-02-14overview-manual, ref-manual, dev-manual: Moved x32 stuffScott Rifenbark
Fixes [YOCTO #12370] The section on the x32 psABI topic was in the "technical details" section of the reference manual. This section combined conceptual and "how to" information for x32 psABI. I moved the conceptual information to a new chapter in the overview-manual. I moved the "how-to" information to a separate topic in the dev-manual. This resulted in the mega-manual being updated to take on a new chapter for the overview-manual (overview-concepts.xml). No links were affected. (From yocto-docs rev: 84da28a4ad0f3f89bfc865f410a5d06b57439beb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>