summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
Commit message (Collapse)AuthorAgeFilesLines
...
* overview-manual: Updates to "OpenEmbedded Build System Concepts"Scott Rifenbark2018-05-241-11/+18
| | | | | | | | | | | I removed the less than pretty build process figure and swapped in the more aesthetically pleasing one. Also, am refering to the figure as the "general workflow figure". (From yocto-docs rev: 093f1337131bc658d6afd1b56fb3661a76751aad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Removed bitbake workflow figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | This version of the figure was not as cool looking as the other version, which is preferred. I have removed it. (From yocto-docs rev: ed0346b00ee6b47d90efedd1dd69e4a92a42afe9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Bolstered the "Layers" section in the concepts chapter.Scott Rifenbark2018-05-241-14/+31
| | | | | | | | | | This section was really sparse for being in the concepts chapter of this manual. I added some more text to it. (From yocto-docs rev: 9369ba5292126957f89f8b96e06bc2492825c54b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updates to "Components" section.Scott Rifenbark2018-05-241-7/+7
| | | | | | | | | | | | I changed the "Metadata (Recipes)" title to simply "Recipes". It is less confusing since the term "Metadata" is in general recipes, classes, and configurations. Provdided a few small edits elsewhere in the section. (From yocto-docs rev: 566b54f58ca7859bf860f25e433bff4b429c2507) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Changed build workflow titleScott Rifenbark2018-05-242-4/+4
| | | | | | | | | | | | | The section titled "Development Concepts" is really mis-titled. It is more about the OpenEmbedded Build System. So, I renamed the section "OpenEmbedded Build System Concepts." There were a couple links all within the overview-manual. No other place in the YP doc set linked to that heading. (From yocto-docs rev: 889eaf3373a80ca0978ee79ecd2ff26aefb9025b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added a link to OpenEmbedded-CoreScott Rifenbark2018-05-241-1/+2
| | | | | | | (From yocto-docs rev: c4642a81045a2267ceac967b7668cb64b4db1286) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added intro text for the concepts chapter.Scott Rifenbark2018-05-241-0/+10
| | | | | | | (From yocto-docs rev: 6ea1e6f016957da96d6cf8a058ec9c18c9843949) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Removed redundant paragraph.Scott Rifenbark2018-05-241-5/+0
| | | | | | | (From yocto-docs rev: 215ed3598780737feb928bb3b515882c468dbb27) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated checkout example for Git based on a tag.Scott Rifenbark2018-05-241-4/+4
| | | | | | | (From yocto-docs rev: ee0021b0db85ced7a36b0f25e1c1e09a0f5b1894) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Better wording for a workflow summary paragraph.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: db3679a4ac22964302e4ff1b16856c25a7ce69fd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fixed wording for use of DOWNLOADS page.Scott Rifenbark2018-05-241-5/+6
| | | | | | | (From yocto-docs rev: 575e33179779ab147b2bfc27183f2b9a25628a5a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added clearer instructions for downloading softwareScott Rifenbark2018-05-241-2/+3
| | | | | | | (From yocto-docs rev: df16ac0829aaf99841044de99200efdf3a03cb41) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Grammar fix.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 81515d5ba7f26c7b93548a338ca7ab8ce649e387) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Grammar fix and link to build system added.Scott Rifenbark2018-05-241-4/+4
| | | | | | | (From yocto-docs rev: 3130b38b638c8487032f3732afdd6954ab6bbfad) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added a link to the "build host" term.Scott Rifenbark2018-05-241-1/+3
| | | | | | | (From yocto-docs rev: e3bdd81857752db01c3404c2eb29792439239fa9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fixed grammar issue.Scott Rifenbark2018-05-241-4/+4
| | | | | | | (From yocto-docs rev: a3075cdd5a3db1883dc358f7ccd6721d89677387) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added link to layers section.Scott Rifenbark2018-05-241-1/+3
| | | | | | | (From yocto-docs rev: 8a9588d27aa86bb194e85dd6bd0c885ce96507e5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fixed grammar issue.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: b911f05e5e3ae7161785ca3dd5cea5ffc565b804) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Removed redundant text for "build system"Scott Rifenbark2018-05-241-1/+0
| | | | | | | (From yocto-docs rev: 513082f4d63ac618d67d35b886a0347f059a8fe5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fixed reference to "chapter" that was "section"Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: d40924637836043fd92a2464f38f3d97c0cbcbb7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fixed link to the matchbox repo.Scott Rifenbark2018-05-241-3/+3
| | | | | | | (From yocto-docs rev: 73ba1ab13a977c15db9d5aa7cd560006e3a4ef70) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added a link to the Toaster User ManualScott Rifenbark2018-05-241-0/+2
| | | | | | | (From yocto-docs rev: 5571f28452c3af9a7394924cb2509693a6f8f528) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added a few links to the "Poky" term.Scott Rifenbark2018-05-242-4/+6
| | | | | | | (From yocto-docs rev: 34007b337ae0636156d64464d39470c9f20b78f0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added a few links for "OpenEmbedded build system" term.Scott Rifenbark2018-05-241-18/+24
| | | | | | | (From yocto-docs rev: c6c23daac976e69b7e5c1a4b42abcac33b0694e2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added link to YP Compatible program section.Scott Rifenbark2018-05-241-3/+4
| | | | | | | (From yocto-docs rev: e5361d48c0807ab2f7bc674ec615e432baff2819) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added a link to the YP workflow area from "Challenges"Scott Rifenbark2018-05-241-3/+4
| | | | | | | (From yocto-docs rev: cf90be30c3a89a55295060bb4604a468509423ed) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added links to supplemental webpage docs.Scott Rifenbark2018-05-241-3/+5
| | | | | | | | | | | | In the "Challenges" section, the bullet item about YP's steep learning curve referenced the "what I wish I'd Known" and "Transitioning to a Custom Environment for Systems Development" docs. I added links to these. (From yocto-docs rev: 627042de38495f79d512c6b98c46193b1de0db47) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added link to license information.Scott Rifenbark2018-05-241-2/+3
| | | | | | | | | | The "License Manifest" bullet needed a link to the License stuff in the dev-manual. (From yocto-docs rev: 6350d68a6c1c5432fd833930437b4e5fe502033b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added link to release cycleScott Rifenbark2018-05-241-2/+3
| | | | | | | | | | The bullet "Releases According to a Strict Schedule" bullet mentions the release cycle. I added a link to that section. (From yocto-docs rev: c206c31d20aabe657863fc05274e2d533cdf7252) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Supports Partial Builds" bulletScott Rifenbark2018-05-241-3/+5
| | | | | | | | | Added a link into the concepts area for sstate. (From yocto-docs rev: ac395452c3a2f34fb9775c77051b526e39fd9b4c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added meaningful links to feature bulletScott Rifenbark2018-05-241-3/+6
| | | | | | | | | | The "Widely Adopted Across the Industry" bullet item did not have good links to the YP home page. Added them in. (From yocto-docs rev: 8695f3e2bcc2a0d37dd8e6b113639628bffdf4b2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Cleaned up other reference paragraph.Scott Rifenbark2018-05-241-7/+0
| | | | | | | (From yocto-docs rev: add845649de2c91489dd2e920865707eb3224243) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added a bullet intro topic for the new concepts chapt.Scott Rifenbark2018-05-241-0/+7
| | | | | | | (From yocto-docs rev: 4b05fd99cfb258c56957fdf864754065a74f407a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated title .PNG fileScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | | The file was stretching beyond the rendered display window such that part of the Yocto Logo was missing. Also had to place the updated .PNG file in the mega-manual/figures folder. (From yocto-docs rev: 5b73c54fcb2c3f60aee2ff7dc19c4aad102aa505) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Cleaned up links to source reposScott Rifenbark2018-05-242-2/+2
| | | | | | | | | | | | I was using the "/cgit/cgit.cgi/" string as part of the link to the source repos, which uses the ENTITY "&YOCTO_GIT_URL;". That ENTITY is all that is necessary to get the link to work. I removed the other stuff. (From yocto-docs rev: f9a63c2cc824ef05230f614e933d178469890e97) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Terminology fix for "OpenEmbedded Layer Index"Scott Rifenbark2018-05-242-4/+5
| | | | | | | | | | | Found several instances of this being referred to as the "OpenEmbedded Metadata Index". Changed to "OpenEmbedded Layer Index". (From yocto-docs rev: 60fb601be324a350cd4d51b199915e6b72e2f9b0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Scrubbed links and fixed a fewScott Rifenbark2018-05-244-16/+9
| | | | | | | | | | Found some mangled links in various spots that were causing the mega-manual.sed file issues. (From yocto-docs rev: 405a92f934bf7e209f3b8a543e63a1b4c693af29) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Review feedback appliedScott Rifenbark2018-05-242-7/+10
| | | | | | | | | Minor wordings based on Stephano's feedback. (From yocto-docs rev: 4aa7aa0e9c7d8e554771743ecabdf0e64f3884e0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated everything for new overview-manualScott Rifenbark2018-05-242-15/+11
| | | | | | | | | | | | | | | | | This involved changing the root manual folder from "getting-started" to "overview-manual". Also, every link using the ENTITY "YOCTO_DOCS_GS_URL" was changed to "YOCTO_DOCS_OM_URL". Most manuals had several occurrences of these links. The makefile needed updating to process the new manual and not process the old "getting-started" manual. (From yocto-docs rev: 1abf64e56e9096258038ae37b787a81bf786bb3b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Added YOCTO_DOCS_OM_URL entityScott Rifenbark2018-05-2430-0/+7188
| | | | | | | | | | The variabe for the "getting-started" manual goes away and is replaced by this one for the new "overview-manual." (From yocto-docs rev: 45fc9beac6db4c40c3660fc9e54cc11e9c1f96c4) 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-1427-6066/+0
| | | | | | | | | | | | | | | | | | | | 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: Consolidated debug info into dev-manualScott Rifenbark2018-02-142-4/+4
| | | | | | | | | | | | | 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>
* overview-manual: Updated "Fakeroot and Pseudo" sectionScott Rifenbark2018-02-141-23/+31
| | | | | | | | | | 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>
* overview-manual, ref-manual: Moved "Licenses" to overview-manualScott Rifenbark2018-02-141-0/+390
| | | | | | | | | | | | | | 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>
* overview-manual, ref-manual: Moved "Wayland" section to overview manualScott Rifenbark2018-02-141-0/+135
| | | | | | | | | | | | | 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>
* overview-manual, ref-manual: Moved Pseudo and Fakeroot to overview manualScott Rifenbark2018-02-141-0/+72
| | | | | | | | | | | | | 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>
* overview-manual, ref-manual: Moved auto added runtime deps sectionScott Rifenbark2018-02-141-0/+147
| | | | | | | | | | | | | | 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>
* overview-manual, ref-manual: Moved "Shared State Cache" to overview manualScott Rifenbark2018-02-142-1/+636
| | | | | | | | | | | | | 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>
* ref-manual, overview-manual, Makefile: Moved toolchain conceptsScott Rifenbark2018-02-143-4/+220
| | | | | | | | | | | | | | | | | | 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>
* ref-manual, overview-manual, yocto-project-qs: Moved YP ComponentsScott Rifenbark2018-02-141-60/+308
| | | | | | | | | | | | | | | 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-25 02:50:51 +0000