summaryrefslogtreecommitdiffstats
path: root/documentation/overview-manual
Commit message (Collapse)AuthorAgeFilesLines
* Documenation: Prepared for the 2.7.2 releaseScott Rifenbark2019-10-231-1/+6
| | | | | | | | | | | Entails all the cover pages for the release date. Used November 2019 for now. Updated poky.ent and the mega-manual.sed file. Good to go. (From yocto-docs rev: f7bf30b96ba7feaf33df544162a713204520b389) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Prepared for 2.7.1 releaseScott Rifenbark2019-07-181-1/+6
| | | | | | | | | | | * Updated all variables in poky.ent * Updated all *.xml files for manual history * Updated the mega-manual.sed file for 2.7.1 (From yocto-docs rev: 7e20c42cbcdab63e02eab4ad316385d18b7beb68) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated manual history table.Scott Rifenbark2019-07-181-1/+6
| | | | | | | | | | The 2.7 release was inadvertantly left out and the date for the 2.6 release was what should have been for the 2.7 release. (From yocto-docs rev: 67c5c84df5c61c2fa7919b1825e4720f0b0565a6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated SCM sectionScott Rifenbark2019-06-181-3/+6
| | | | | | | | | | | | Fixes [YOCTO #10098] I updated the "Source Control Managers (Optional)" section to reference the "Fetchers" section in the BB manuual. (From yocto-docs rev: 3bc281e4092207dc5b757b9da50f7d80cb2f4c6a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Removed all references to EclipseScott Rifenbark2019-06-182-64/+4
| | | | | | | | | I also fixed all linking as needed. (From yocto-docs rev: f987bc2846a2356a58934164652bb1dc59623b3b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual, overview-manual: Added updated index releases figureScott Rifenbark2019-06-181-0/+0
| | | | | | | | | | | The index-downloads.png file changes due to "eclipse" no longer being there. Both the overview-manual and the mega-manual figures folders hold this figure. (From yocto-docs rev: ef7b8dd8d636ef0ad563d1fe1ef44227f5f89fbc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Removed customization.xsl files for EclipseScott Rifenbark2019-06-181-35/+0
| | | | | | | | | | | The help files for YP manuals used in the Eclipse application are no longer supported. I removed the individual *-customization.xsl files for the individual YP manuals. (From yocto-docs rev: 8c19244298b2c95ac92a398a5b6d3aca788f075e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fixed broken link to pseudo.Scott Rifenbark2019-04-091-4/+3
| | | | | | | | | | | Link has disappeared. I am no longer using it and am using the article to "Why Fakeroot" to cover both Fakeroot and Pseudo "extra information" stuff. (From yocto-docs rev: 679c6a48a8e4bcc51bb8e97f2ba80123bdba6a5c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated Package Feeds diagramScott Rifenbark2019-02-251-0/+0
| | | | | | | | | | The diagram had a typo in it ".ipd" rather than ".ipk". Fixed and dropped in the figures folder for each manual. (From yocto-docs rev: d39d196713a68df8d298f6ed0f40899bc148a323) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Fixed typo.Brian Silverman2019-02-121-1/+1
| | | | | | | | | "eSDSK" -> "eSDK" (From yocto-docs rev: 5ececa4362e0400e01327dbe4ce25202f2c392ce) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual, overview-manual: Fixed BitBake User Manual linksScott Rifenbark2018-12-271-2/+2
| | | | | | | | | | | | | | Some occurrences of links to the BitBake User Manual were using a target (i.e. &YOCTO_DOCS_BB_URL;#bitbake-user-manual). Using this form causes the mega-manual.sed file to not process the link correctly for the mega-manual. These are subtle errors and have probably existed for some time. I removed the target ID to fix the problem. (From yocto-docs rev: 701f61fd80e5103ee02efbe5eed9a8607ac9a336) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed section title for required packages.Scott Rifenbark2018-08-151-1/+1
| | | | | | | | | | | The title needs to use the terminology "Build Host" to be consistent with the manual set. I updated the title and the many links into that section. (From yocto-docs rev: 930030433e58e6180ee4f95e559d079c3899defc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Set up the 2.6 version of the docsScott Rifenbark2018-05-241-0/+5
| | | | | | | | | | | poky.ent - Edited for new variables. <manual>.xml - Manual revision tables updated mega-manual.sed - swapped out 2.5 for 2.6 (From yocto-docs rev: 2bae8fa18ae82a325785276acdeb1394e110d2cf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Moved the "Simple Build" sectionScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | | | I had a section on building an image up in chapter that talks about getting set up to use YP. I moved the build section to a new parent section that will hold topics on building various things. I renamed the section to "Building a Simple Image". I had to fix several links in the sdk-manual, overview-manual, and dev-manual. (From yocto-docs rev: c119fc7c6148e7b08acad374fe2981842e9462a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed "Working With Yocto Project Source Files" titleScott Rifenbark2018-05-241-2/+2
| | | | | | | | | | Changed to "Locating Yocto Project Source Files". I am moving the sections on cloning repositories out from under this section. (From yocto-docs rev: 3889aadab9b603097b6cc5b7afb9d0066021106c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved licensing how-to stuff to dev-manualScott Rifenbark2018-05-241-391/+0
| | | | | | | | | | | | The section on licensing in the overview-manual was really "how-to" information. I moved this to a new section in the dev-manual for "working with licenses". I fixed some references in the ref-manual and in the bsp-guide as well. (From yocto-docs rev: f150a1ea2da900aae88fc5fa60f4115cc213ba2d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved Wayland and WestonScott Rifenbark2018-05-241-135/+0
| | | | | | | | | | | The Wayland and Weston topic moved from the overview-manual to the dev-manual. The topic was really a "how-to" topic and not a concepts topic. (From yocto-docs rev: b0f20a67c99590c48d595f4e572339bb5b6b83b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, dev-manual: Moved sstate debug tips sectionsScott Rifenbark2018-05-241-107/+28
| | | | | | | | | | | | Two sections at the end of the shared state concepts section in the overview-manual are really task sections. I took those and created a couple new sections in the dev-manual to house those topics. (From yocto-docs rev: 86382e7873d796f44554c8e04d3bd8091d350f51) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Invalidating Shared State" sectionScott Rifenbark2018-05-241-2/+2
| | | | | | | | | Removed "OpenEmbedded" in the string "OpenEmbedded build system." (From yocto-docs rev: d44b370b0fb993c32c9dfe3515188fa9e7ff2437) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Shared State" section.Scott Rifenbark2018-05-241-29/+41
| | | | | | | | | | | Added the line with "stamp-extra-info" flag to the example from the deploy.bbclass. This line was missing or it had been added since the original writing of this section. (From yocto-docs rev: 50f5482c2132235962d4ab48d0d7263628df1728) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Cross-Development Toolchain Generation"Scott Rifenbark2018-05-241-8/+12
| | | | | | | | | I made some small edits to this section. (From yocto-docs rev: a2cc355c1bdfbf10f86f8d4994cc81dfb12d8f87) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Removed release date ENTITYScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | Now that 2.5 has released, I replaced the ENTITY variable used for the moving month and year with the actual release month and year (i.e. May 2018). (From yocto-docs rev: 2d6e8ddce4fce0c405d2aea69cea2a5b262410f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Minor edits to the SDK generation section.Scott Rifenbark2018-05-241-60/+74
| | | | | | | | | | Added the descriptions for the SDK_HOST_MANIFEST and SDK_TARGET_MANIFEST variables. (From yocto-docs rev: 212d6c5b3290016431604e67dfb27a1408ac0463) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated the sdk figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | Added the manifest files to the figure and the associated variables. Also added the test files. (From yocto-docs rev: cfba55462d1c37ef2ff6454890da64a40f9c3607) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Minor wording changes to the "Images" section.Scott Rifenbark2018-05-241-5/+4
| | | | | | | (From yocto-docs rev: a3e825e6086ec7674641658cc956020e3e1cd9dd) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated the Images figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | I needed to add some italic formatting for variable type strings. (From yocto-docs rev: afc6d2d10081f9e9d940075c03b3e704b37cf13b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updates to the "Images" section.Scott Rifenbark2018-05-241-18/+18
| | | | | | | | | Some minor rewrites. (From yocto-docs rev: 71cbc1c389389ffac9e59faacdc56d3ea05facd7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updates to "Setscene Tasks and Shared State"Scott Rifenbark2018-05-241-25/+22
| | | | | | | | | | Updated with a few minor wording changes. Tried to get a little more active from some of the passive wording. (From yocto-docs rev: 7dcd8117e3ea40d4b3c1ee5c3b1ea3c2bd29893a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated text for Image and SDK generation.Scott Rifenbark2018-05-241-33/+37
| | | | | | | | | General improvements to both sections. (From yocto-docs rev: 977fdeaf1258613c3dfc41d78c8125fdba9b2a24) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated image generation imageScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | The figure for image generation of the BitBake process needed some enhancing. (From yocto-docs rev: fc978663a7962d1515d4f47abe8ae522b9e24ce1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated SDK generation imageScott Rifenbark2018-05-241-0/+0
| | | | | | | | | The image needed a little bit of clean up. (From yocto-docs rev: d4fb680be194b7f9b192e06f0081a09504649633) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated the "Package Splitting" section.Scott Rifenbark2018-05-241-14/+52
| | | | | | | | | | Rewrite included the "do_populate_sysroot" task and a bunch of STAGING_DIR_* variables. (From yocto-docs rev: 53484d4982a41f83ac9355aada46526b5d05f64a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated package splitting figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | | More changes to the "analysis-for-package-splitting.png" figure. I needed to work in "do_populate_sysroot" task and several STAGING_DIR_* variables. (From yocto-docs rev: fcb88024a7dfff1b6cca49770f67bf4c1f548362) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Changed title for configure/compile section.Scott Rifenbark2018-05-241-16/+15
| | | | | | | | | | The stage of the BitBake workflow is really "Configuration, Compilation, and Staging". I updated the title to be such. (From yocto-docs rev: 4aab6d001119aa8c52e09ef0f6f66694719add29) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated the config/compile figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | The figure had the wrong hierarchy for the "image", "recipe-sysroot", and "recipe-sysroot-native" folders. Moved out a level. (From yocto-docs rev: e1f45b666b1cd589cee9c9ae6dba01467b991ef9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated the package splitting figure.Scott Rifenbark2018-05-241-0/+0
| | | | | | | | | Figure was out of date. (From yocto-docs rev: 5b56862ec39fc05299cd6d468f13f75b74c3b800) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated the "Configuration and Compilation" sectionScott Rifenbark2018-05-241-9/+15
| | | | | | | | | | This section needed some verbiage tweaks. Nothing major. Just a few modifications to help clarify some areas. (From yocto-docs rev: 9deabf424387fd1441882ce8cf28ea69421ea237) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated Config and Compile figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | | | | The "configuration-compile-autoreconfig.png" figure was badly out of date. It was not showing the two sysroot directories and did not use the $BPN variable. I have updated the figure and placed in both the overview-manual/figures area and the mega-manual/figures area. (From yocto-docs rev: dba3b2b65f18870229dcb3dbcb8fadc099165894) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Small revisions to "Patching" section.Scott Rifenbark2018-05-241-4/+12
| | | | | | | (From yocto-docs rev: 081a60766b67e8822e0c841f3259ff633580149c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Added a link to the do_patch task.Scott Rifenbark2018-05-241-2/+3
| | | | | | | (From yocto-docs rev: 934de6a59cef6a7b80530de1ccbe7006bb196238) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Patching" section.Scott Rifenbark2018-05-241-11/+26
| | | | | | | | | | | | | | | This section presents a deep dive into the patching phase of the build process. I removed the vague "apply=yes" reference and added more references for the reader to read and learn about patching. The bit about the SRC_URI parameters (i.e. "apply") is going to be covered in the do_patch documentation since that is the task that handles that stuff. (From yocto-docs rev: 5a2c98543ccc9ed24d16bb9442b674532940c0da) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Increased viewport for patching.png image.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: fb8419753846e391dfc1b2dd5973eaff7627c57a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Converted paragraph on figure to noteScott Rifenbark2018-05-241-9/+11
| | | | | | | | | | The paragraph at the end of the section about the file hierarchies is better cast as a note. (From yocto-docs rev: 4e8a33be61ea1ea5db12fc5fc97832393213fb5d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated the "patching.png" figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | The figure had a bad "PN" variable being used in the "S" directory. This needed to be changed to "BPN". (From yocto-docs rev: beafc55eb3646ecb96929e44538de952207f0b76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated source-fetching.png figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | | The figure was incorrect. Replaced the PN variable with BPN for the "S" directory. (From yocto-docs rev: 440edcdae932a83b6c32b51e85d97178a77b4bed) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Source Fetching" section.Scott Rifenbark2018-05-241-32/+73
| | | | | | | | | | | | I scrubbed through this section and provided much better explanations of the inside workings of BitBake fetching source with building recipes. During that, I fixed an error where the PN variable was being used rather than the BPN variable. (From yocto-docs rev: 5765987259ac46f140e099d8e1da2ab33f006d36) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated the package-feeds.png figureScott Rifenbark2018-05-241-0/+0
| | | | | | | | | The figure was out of date. (From yocto-docs rev: ae84cd2a09f81415e22333d179bcd146560b34da) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added ENTITY variable to track a release date and yearScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 65a87312f541e2f2b01fa1918f7a12da607fe7ab) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual: Updated "Sources" section with minor edits.Scott Rifenbark2018-05-241-3/+9
| | | | | | | (From yocto-docs rev: 7cc11321fec1e9cd17f20129fbb201b7891eaf60) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* overview-manual, mega-manual: Updated figuresScott Rifenbark2018-05-242-0/+0
| | | | | | | | | | | Updated the layer-input.png and source-input.png figures. Had to trim them so they were tighter in the figure. Also, updated some context in the source-input.png figures. (From yocto-docs rev: cad644af48b0a1cb2baeb8d2649b9aa7ccbdeda5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>