summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
Commit message (Collapse)AuthorAgeFilesLines
...
* dev-manual: Updated Wic exampleScott Rifenbark2018-05-241-26/+24
| | | | | | | | | | | I updated the first example in the section telling how to build out a Wic image. I could not get the example to run so I used Stephano's output. (From yocto-docs rev: 6b4595215d6c24e3efb89288a7547f79ca3e59b7) 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-241-1/+1
| | | | | | | | | | | | 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>
* dev-manual: Fixed broken linkScott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 4abc25e1b0b93bb232291e0bb51ec89c5e1f66f9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken link to WORKDIR variable.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: c239bd40e92cedee6301c176ff96821ea270fc39) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Replaced SERIAL_CONSOLE with SERIAL_CONSOLESScott Rifenbark2018-05-241-1/+1
| | | | | | | | | The former is deprecated. (From yocto-docs rev: 1a1f89d91ceeb35f8cb5c2f9fc42fdb089ffc05c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed broken link to Carna Botnet's article.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 1d5e9bfea217051a457c30dcbd890366e9dd7611) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed target for a link.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 59697f22f79d07b800d4f3ce2eb2ea41c987802b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed non-functioning link to EXTERNAL_TOOLCHAINScott Rifenbark2018-05-241-2/+1
| | | | | | | (From yocto-docs rev: b0bd0c4d8070adf1439140230700b0de18f884ae) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Replaced "BSD" with "BSP" typo. Also small word change.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: d67856c849c5275a07ee1f87db839cd4d4d9a6f6) 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-241-1/+1
| | | | | | | | | | | 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>
* dev-manual: Removed redundant link.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: bf64aad87e0248362e9cf9b693cd806ca32873fa) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed formatting issue.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 4cd711d1305f480068447bac8881212a5b999d34) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Slight wording change and link to a list of items.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 26dd48f6995a1ac8da5ceba124d7795ebe857d53) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed a broken Gitolite link.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 5d900f38079701a2ed8243071bd669bca1d97e1e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed link to Toaster User Manual.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | Had "Toaster Manual" in the cross-reference so it was not resolving correctly when processed by mega-manual.sed. (From yocto-docs rev: c99ce4a706df55e97388b45620ed2a503cb8312d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Removed writer note about needing a figure.Scott Rifenbark2018-05-241-3/+8
| | | | | | | | | | | Nobody provided a figure for me for this section, which would have been nice. So, I have generalized the text to work without that detail. (From yocto-docs rev: 7570167196c26c9eb08e97d1350a715bff37c75f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed grammar... missing word.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 37cf33513896f2cf9accf801b0847d9f132fc06a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Cleaned up links to the source repositoriesScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | I was using the ENTITY with "cgit/cgi"/ appended to the end. The appended part is not necessary. Removed it. (From yocto-docs rev: 64593694d62c99cbe2897804c04fea24110ee861) 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-243-25/+25
| | | | | | | | | | | | | | | | | 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>
* dev-manual, ref-manual: Fixed two broken links.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 1ce02bf1c81629d9e008c05b48c4cddad264bafc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Changed getting-started manual titlesScott Rifenbark2018-05-243-5/+5
| | | | | | | | | | | Throughout the documentation, the manual "Getting Started With Yocto Project" was used. The manual now is called "Yocto Project Overview and Concepts Manual". (From yocto-docs rev: f47d10029487420cbeb292f680084b63be0ec7e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links to old concepts-manualScott Rifenbark2018-05-242-21/+25
| | | | | | | | | | | | | The concepts-manual is going away for 2.5. I have fixed all the links across the YP documentation set that were cross-referencing into the concepts-manual so they now cross-reference into the getting-started manual, where that concepts chapter will live post 2.4x. (From yocto-docs rev: e9145e9e7fef882a13c982d34514a94f864b3c12) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-mnaual: Changed "Dockers" to "Docker"Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: af6bf8474462584b183005ce51fec42efb94e232) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Fixed grammar error.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: a0f045418cb378ec07725dfd6de20b5d7ce33239) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Corrected "Docker" typo.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 5615e6803dbbe64e66cced29f44f1cf9e94fdf38) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links to concepts-manual.Scott Rifenbark2018-05-241-1/+2
| | | | | | | | | | Some inconsistencies in the links to the concepts-manual existed. I fixed these throughout the YP manual set. (From yocto-docs rev: ad7f840bb6f4a5248ef455b98ce9b35197e07e1a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed "Getting Started" manual linksScott Rifenbark2018-05-243-5/+5
| | | | | | | | | | | | | | There was inconsistent use when referencing the getting-started manual. The manual's name does not include the word "Manual". So, I cleaned this up across the manual set and also in the mega-manual.sed file, which was incorrectly processing the links to that manual that do not target a specific section. (From yocto-docs rev: 0f5321416f7ec50cb6c96cccb7c87ef191a25367) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* mega-manual: Fixed various links to the dev-manualScott Rifenbark2018-05-241-2/+2
| | | | | | | | | | | | Found a few links that were not using the correct wording when referencing a section to the dev-manual. Also, fixed one link that was assuming a section outside the dev-manual when the link was to a section inside the dev-manual. (From yocto-docs rev: 7a577b135e1a01d6a9924ba89733e46d029c6cca) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated "OpenEmbedded-Core" terms.Scott Rifenbark2018-05-241-1/+1
| | | | | | | | | | Throughout the manual set, I made sure that "OpenEmbedded-Core" and "OE-Core" appear with the hyphens. (From yocto-docs rev: 1f570df3eccb74b9e2e60af94c0e0dd48e1489e9) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Purged the YP Quick Start references from YP setScott Rifenbark2018-05-243-11/+12
| | | | | | | | | | | | | | | The original Yocto Project Quick Start is being retired for the YP 2.5 release (sumo). I have purged all the various references from the YP manual set and replaced them with references to the appropriate doc. The references were mainly into the YP dev-manual for setting up the host or for building an image. There were a few references into the new "Yocto Project Quick Build" document for overviewing manual-type references. (From yocto-docs rev: 11c0ab693962f16f87f1e21f33dd5c6ca6a6f895) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added new section on conserving disk spaceScott Rifenbark2018-05-241-0/+19
| | | | | | | | | | | | | For conserving disk space during builds, I added a new section that tells how to add "rm_work" to your local.conf file. This information was part of the original YP Quick Start and was not carried forward into the new brief build document. (From yocto-docs rev: 719d70587d908390a134559472d57ce7fced6aae) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Updated Manual NotesScott Rifenbark2018-05-241-13/+25
| | | | | | | | | | | | | I did some re-wording to account for when the user does a web search for a manual and the search returns an ancient version of the manual. Many times the user is oblivious of this fact and is trying to use a version of the docs that don't come close to matching the version of the YP. (From yocto-docs rev: 1cbe06cefda2b35584a8365564e01888d229d0b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Added an id tag for the create layer step.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: 59b8c053f8fe94cc51ece86733c435ac7085eb57) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Create Your Own Layer" sectionScott Rifenbark2018-05-241-88/+71
| | | | | | | | | | | Updated the explanation of the layer.conf file. I am going to use this section as the definitive section that explains the layer.conf file. (From yocto-docs rev: 4c70c7467f0ca5cf2346ef8d10bde437b971d2d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Creating Your Own Layer" section.Scott Rifenbark2018-05-241-9/+15
| | | | | | | | | | Added information to the list of variables used in the layer.conf file to specify LAYERSERIES_COMPAT. (From yocto-docs rev: c41ff41e75b654d5d7df8c2a1e83ba5525490285) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated the "Creating Your Own Layer" section.Scott Rifenbark2018-05-241-2/+9
| | | | | | | | | | For step 3 on creating the layer, I put in wording to make sure the user does not create a layer in the cloned poky directory. (From yocto-docs rev: 1a0d1d0c0cdfa77c6df005d0294d11a02ca3770c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual: Updated layer creation example to use $HOME directoryScott Rifenbark2018-05-241-2/+3
| | | | | | | | | | | Best practices dictate that the use not create a layer in the poky repo. So, I updated the example to move the user to a top-level directory first and then create the layer. (From yocto-docs rev: 81ab8b0f393f90785880aec7685c4c431cb7ad87) 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-251-10/+47
| | | | | | | | | | | | | | 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>
* 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>
* 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-251-8/+15
| | | | | | | (From yocto-docs rev: 033c7771ff1dfabf9f6ef9b6cb88a18f471e0c76) 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>
* 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-19 07:46:32 +0000