summaryrefslogtreecommitdiffstats
path: root/documentation
Commit message (Collapse)AuthorAgeFilesLines
* kernel-dev: Clean up of "bsp_name" placeholder.Scott Rifenbark2018-03-252-15/+25
| | | | | | | | | | | | This string is now being presented as "bsp_root_name" in the YP manual set. A BSP name is essentially "meta-bsp_root_name". It was being presented in the manual set as "meta-bsp_name", which is not technically correct. (From yocto-docs rev: 9ad25836b2b3ca79aa3430be014871f50205cf9e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updated BSP terminolgy and BBLAYERS orderingScott Rifenbark2018-03-251-49/+61
| | | | | | | | | | | | | | Fixed the way we refer to a BSP name. It is really "meta-<bsp_root_name>" rather than "meta-<bsp_name>". The name is the whole string and not just the root name. Also added a tip on ordering the layers in the BBLAYERS variable in the bblayers.conf file. Order is important. (From yocto-docs rev: 9c56238295f5631c496377616ea98b860253e6f7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Added term "container layer"Scott Rifenbark2018-03-251-0/+14
| | | | | | | | | This is a layer that contains other layers (From yocto-docs rev: 0cd1881c18e8a63d5f2f078b03fe4e89fd9c75b5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Cleaned up layer naming terminologyScott Rifenbark2018-03-251-60/+111
| | | | | | | | | | | | | | | | | | Reality dictates that the YP does not treat layer naming consistently. Layers are talked about as the "meta-whatever" layer and never the "whatever" layer. However, the tooling sometimes appends or uses just the "whatever" part of the layer name. A good example is the meta-yocto-bsp configuration file. All the variables in there use just the root name of a layer's name. In the manuals, I had been distinguishing the layer name as just the "whatever" part sans "meta-". I talked about the convention of using "meta-" in front of layer names, etc. Well, this is confusing in light of how everyone says a layer's name is "meta-whatever". So, I fixed all this up. (From yocto-docs rev: 79e52f6ccf4246fc69a460ce9d3a4a18720a9442) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated the section on creating a general scriptScott Rifenbark2018-03-253-15/+53
| | | | | | | | | | | | | | Split this section into two sections: one for creating the layer using bitbake-layers create-layer and one for adding the layer to bblayers.conf using bitbake-layers add-layer. Needed to update some references in the yocto-project-qs and kernel-dev manuals. (From yocto-docs rev: 741a29b0cbeaaeaa0ac9155036ace2623938aee3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Created tip for using server outside of build areaScott Rifenbark2018-03-251-6/+11
| | | | | | | | | | | | | | Fixes [YOCTO #12419] In the section on runtime package management, I created a "Tip" box to tell the user about using a location for the package index information outside of the "deploy" area of the hosts build directory. (From yocto-docs rev: 2aee814d3d3ed4052fca332693d5416907ae640e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updates to the section on creating a layerScott Rifenbark2018-03-251-11/+15
| | | | | | | | | Provided some key links to help clarify content. (From yocto-docs rev: 8d27b9946dad89729d30497bcc4de26b9a5c87d9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Sanity edit through the layer creation sectionScott Rifenbark2018-03-251-1/+1
| | | | | | | (From yocto-docs rev: 91cda82ca148c56c18f059eeaa656d3561aed26d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Completed rewrite of runtime package managementScott Rifenbark2018-03-251-88/+197
| | | | | | | | | | | | Fixes [YOCTO #12419] This section was unclear and needed some work. I added text to help clear things up. (From yocto-docs rev: 54358a39a5710dbd0cbcfe8dafd2f641ec3863ef) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated PACKAGES_FEED_ARCHS variableScott Rifenbark2018-03-251-6/+15
| | | | | | | | | | | | | | | | Added the fact that this variable is really optional. If you don't use it then you are setting up a package feed URI that will include all supported arcchitectures for the package. Using it means you are setting up specific URIs for specific architectures. Added a "Tip" note box to show how you can use the variable to whitelist architectures. (From yocto-docs rev: 009f3551aa61aaf6459fd24105a2e06511b59da3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the IMAGE_INSTALL variable description.Scott Rifenbark2018-03-251-36/+50
| | | | | | | | | | I created a two-bullet "Caution" note to highlight the stuff a user needs to be aware of that can cause problems. (From yocto-docs rev: 553bc13e5fd350adb15400afe170e587965929db) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Review edits to the kernel layer.Scott Rifenbark2018-03-251-8/+10
| | | | | | | | | Minor corrections. (From yocto-docs rev: f7fa509b461d4b187f7f91c184b2de3c619de5a3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Added "cd poky" step after cloning example.Scott Rifenbark2018-03-251-0/+1
| | | | | | | (From yocto-docs rev: 3a05201aabc4633ffead17a01ed36cd25529595e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Review updates for minor wordings and linksScott Rifenbark2018-03-252-14/+17
| | | | | | | (From yocto-docs rev: 51dc5dd5362a8e6d6d558a566554bec34764227f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Removed deprecated tool sectionsScott Rifenbark2018-03-254-1855/+1497
| | | | | | | | | | | | | | | I took out the sections at the end of the manual that talked about the yocto-kernel tool. This tool is no longer maintained and there is no equivalent tool. I also fixed the yocto-bsp tool to be the bitbake-layers tool. This involved some consolidation of sections. I fixed some links in the kernel-dev and toaster-manual. (From yocto-docs rev: 20cda99b301b6327d816c4a4cfb3511ad25c987c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Minor edits to the licensing section.Scott Rifenbark2018-03-251-184/+232
| | | | | | | (From yocto-docs rev: a7d13e2e9f9a947e65f969422202f04784724063) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updates to Reqs and Recommeds for released BSPsScott Rifenbark2018-03-251-122/+198
| | | | | | | | | Updated this section with minor edits. (From yocto-docs rev: 1bc1dcda5fbab4a66737653164222f4fc5a7289c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updated the section on developing a BSPScott Rifenbark2018-03-251-88/+117
| | | | | | | | | | This section had several out-of-date items. They are all up to date now. (From yocto-docs rev: 247f3eceeccc645a1b556aea433d4cf66399e962) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Fixed link to section.Scott Rifenbark2018-03-251-1/+1
| | | | | | | | | Wrong title used in link. (From yocto-docs rev: aa42a8752af97aaa4f16c89059eef63700ea48f4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Updated BSP development flow figure.Scott Rifenbark2018-03-252-0/+0
| | | | | | | | | This figure was out of date. (From yocto-docs rev: 8b649ab3c4667a45f263818c2532b18f2dae9464) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Scrubbed the BSP structure section.Scott Rifenbark2018-03-251-157/+226
| | | | | | | | | | | | | Made changes to sync the raspberrypi BSP example to what is really in the source directories. It was pretty out of date. Made some minor edits to the sections describing the framework of the BSP. (From yocto-docs rev: b222d0988cb365cb1943ee1857e5cfd6b9fe173a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: Edits to "Preparing Your Build Host to Work with BSP Layers"Scott Rifenbark2018-03-251-20/+30
| | | | | | | | | | Applied some edits to make the section more up-to-date. Dumped minnow as a BSP example for raspberrypi. (From yocto-docs rev: a40515bad28d07d736e1ddd1832c19b074749d53) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* bsp-guide: General edits to "BSP Layers" sectionScott Rifenbark2018-03-251-18/+29
| | | | | | | | | | Added more relevant information around the discussion of BSP layers. (From yocto-docs rev: 8ca439b0bbfdcf390edb723fd12e8a00d90024e3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated example output for creating layerScott Rifenbark2018-03-251-5/+2
| | | | | | | | | | The example that creates a layer using bitbake-layers had old output. Updated it. (From yocto-docs rev: c58d738a59f113f8fffe0fc40b22e06b9d96cb6f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Review edits to manual upgrades for recipes.Scott Rifenbark2018-03-251-11/+18
| | | | | | | (From yocto-docs rev: 05307788395cb16af95e89592bda070be6c1a397) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs: Replaced AUH red-text with real cross-reference.Scott Rifenbark2018-03-251-4/+7
| | | | | | | | | | | | This reference to tools to help upgrade now exists with the creation of the section in the dev-manual that talks about how to upgrade recipes. I converted the bullet item here in the QS to point to the actual section. (From yocto-docs rev: b3d8895fefb99799a7c06abff5cc1604530ee36a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added section on manually upgrading recipesScott Rifenbark2018-03-251-1/+94
| | | | | | | (From yocto-docs rev: b5515ad6f4b5653095e338114607dd11a11181df) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, dev-manual: Updated verbiage around new YP website.Scott Rifenbark2018-03-252-14/+19
| | | | | | | (From yocto-docs rev: 033c7771ff1dfabf9f6ef9b6cb88a18f471e0c76) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, mega-manual: Updated YP website page image.Scott Rifenbark2018-03-252-0/+0
| | | | | | | (From yocto-docs rev: 7c0d710a20246c305a0131f030696b036b950774) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* sdk-manual: Updates to the devtool upgrade flow section.Scott Rifenbark2018-03-251-67/+107
| | | | | | | | | | Did some rewriting to add some references to other sections in the manual set. Did some other minor clean up. (From yocto-docs rev: 7e7be31e96a0e73e230b8596b2431716f254e027) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated devtool sectionsScott Rifenbark2018-03-251-53/+60
| | | | | | | | | | | | Updated the devtool add -h output. Updated the devtool --help output. Fixed wording for the "attic" file associated with the figure of the workspace area. (From yocto-docs rev: bc53d9a1236ba2545c112256e886729b08b507de) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* ref-manual: Updated the section on devtool upgradeScott Rifenbark2018-03-251-7/+34
| | | | | | | | | | | Provided a bit of rationale on why and when you use this command. Put in several links to help the reader get to related areas where command use is explained. (From yocto-docs rev: 7b30f29bfa15dd15f1388bb856e2047be55e7fb9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added section on upgrading recipes.Scott Rifenbark2018-03-251-0/+456
| | | | | | | | | | Section covers AUH, devtool and manual. Still need to add manual. (From yocto-docs rev: 56f04b1fcc8673e20df6d8f5c65120b03cad31e7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, mega-manual: Updated two figuresScott Rifenbark2018-03-254-0/+0
| | | | | | | | | | Had to update the umbrella YP figure and the Poky figure. The figures changed on the website so this gets them back in sync. (From yocto-docs rev: f7f1a689a847ab4a01106eadacfccb4bec6c4b01) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Updated tip to mention the index of all sstateScott Rifenbark2018-03-031-0/+5
| | | | | | | (From yocto-docs rev: c8fac47e6bf0a610cb5ec190b1c8ae67c78d1044) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Changed heading for mirror and pre-fectch sectionScott Rifenbark2018-03-031-6/+6
| | | | | | | | | | | The old heading was dangerously close to a heading in the previous chapter. I altered this heading to target more specifically the content. (From yocto-docs rev: 797bef2256308531f02e35dc0ef8b1d9cbaff935) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added MACHINE conf qualifier to virtual providerScott Rifenbark2018-03-031-1/+3
| | | | | | | | | | Needed to call out that using the include file is actually using a MACHINE configuration file in this case. (From yocto-docs rev: b33838d4711e0c55c6cf78e7491ce97bc9fd519f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Added cross-reference to the "My First Build" docScott Rifenbark2018-03-031-0/+4
| | | | | | | (From yocto-docs rev: 42da5337d498f537613dc71a43c7c92ccb38f682) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* poky.ent: Added an ENTITY for the "my first build" paper.Scott Rifenbark2018-03-031-0/+1
| | | | | | | (From yocto-docs rev: 9dcdaa67697fd301917d9f2cefd0e3eafb9e373a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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: Removed Manual notes from title pageScott Rifenbark2018-03-031-2/+3
| | | | | | | | | | | This document is not a manual. We are not going to list it as a full-blown manual. It does not need the "Manual Notes" part in the title page. (From yocto-docs rev: 23267dea9a90dda33d646fcfc3e8b7a1c919adea) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Added "tip" to use mirrors to speed build.Scott Rifenbark2018-03-031-1/+15
| | | | | | | (From yocto-docs rev: 4088481f081e4746da4a774648a59d6ec31439b7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Added a section on "Layers"Scott Rifenbark2018-03-031-0/+24
| | | | | | | | | | | The section briefly introduces layers but leaves the real explanation to the section in the getting-started manual, which this section references. (From yocto-docs rev: 9b3957a5d7c3a2f6b41ec26205ae31f3b2d05643) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* concepts-manual: Updated how the general build figure is referencedScott Rifenbark2018-03-031-13/+13
| | | | | | | | | | | | this figure had been being referred to as the YP build process. However, it is really more of the OpenEmbedded build system process. Basically, what goes on during a build. I changed the way the general figure is referred to. (From yocto-docs rev: 1cb79b04182bd660b37637d9cec7d6edf33fc292) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed checkout by tag exampleKristi Rifenbark2018-03-031-1/+1
| | | | | | | (From yocto-docs rev: 70cf6e2eb2f9999f1d1b24c3897106e7e8f3e93f) Signed-off-by: Kristi Rifenbark <kristi@buzzcollectivemarketing.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Updated reference to wiki for Proxy issues.Scott Rifenbark2018-03-031-1/+1
| | | | | | | (From yocto-docs rev: 0618e0bebc69f13ce0cd2a120d2a141b5e77e115) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* brief-yoctoprojectqs: Slight wording change regarding Poky meaning.Scott Rifenbark2018-03-031-2/+2
| | | | | | | (From yocto-docs rev: 2363aa3bb45b6683208b71399996031e7d47a6c1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* .gitignore: Added html, pdf, tgz, and eclipse types to ignoreScott Rifenbark2018-03-032-240/+0
| | | | | | | | | This is for the brief-yoctoprojectqs article. (From yocto-docs rev: 7237c9a36e855eee9056650455a4b6f3d2412961) 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-039-2/+5427
| | | | | | | | | | | | | | | 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>
* concepts-manual: Changed wording for simplicity.Scott Rifenbark2018-03-031-4/+4
| | | | | | | (From yocto-docs rev: 7725507cc1648e41d5928651217379217bdcd35b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>