summaryrefslogtreecommitdiffstats
path: root/documentation/getting-started
Commit message (Collapse)AuthorAgeFilesLines
* poky.ent: Added YOCTO_DOCS_OM_URL entityScott Rifenbark2018-05-2430-7188/+0
| | | | | | | | | | 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: Changed getting-started manual titlesScott Rifenbark2018-05-243-6/+8
| | | | | | | | | | | 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-5/+6
| | | | | | | | | | | | | 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>
* getting-started: Moved concepts-manual-concepts.xml to getting-startedScott Rifenbark2018-05-241-0/+3612
| | | | | | | | | This chapter in now in the getting-started manual. (From yocto-docs rev: 206c4e2117cc3b404c81ac66f391cee68db4a1c2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Added figures from old concepts-manualScott Rifenbark2018-05-2414-0/+0
| | | | | | | | | | | | | The concepts-manual is going away for 2.5. It is being sucked back into the getting-started from where it came after originally being moved out of the ref-manual. I have moved all the figures from the concepts-manual to the figures folder of the getting-started manual. (From yocto-docs rev: 6a95ab558964f2833d6b214791be94cb87305926) 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-241-1/+1
| | | | | | | | | | | | | | 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>
* documentation: Updated "OpenEmbedded-Core" terms.Scott Rifenbark2018-05-241-5/+5
| | | | | | | | | | 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-242-7/+8
| | | | | | | | | | | | | | | 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>
* Documentation: Updated Manual NotesScott Rifenbark2018-05-241-15/+27
| | | | | | | | | | | | | 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>
* 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>
* getting-started, dev-manual: Updated verbiage around new YP website.Scott Rifenbark2018-03-251-6/+4
| | | | | | | (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-251-0/+0
| | | | | | | (From yocto-docs rev: 7c0d710a20246c305a0131f030696b036b950774) 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-252-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>
* 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>
* getting-started: Updated front matter that introduces manual.Scott Rifenbark2018-03-031-12/+15
| | | | | | | (From yocto-docs rev: 6809363f7596938e40f2685c68c0537857fa055b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Edits to the Git section.Scott Rifenbark2018-03-031-18/+26
| | | | | | | (From yocto-docs rev: d1512e2f9e17be58dcd8c64ce7911d6ee1ebc12c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Applied some minor edits to the Git workflow section.Scott Rifenbark2018-03-031-18/+26
| | | | | | | (From yocto-docs rev: 15eb983db02b352fd70de6cb3ef2c63e82fa4420) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Added Host Development SectionScott Rifenbark2018-03-031-121/+254
| | | | | | | | | | | Section to describe the key nature of the host development system and its role and preparation requirements for use in the Yocto Project development environment. (From yocto-docs rev: 379659af343ba84f9c8fc2f47474659e06219c53) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Created "Some Basic Terms" section.Scott Rifenbark2018-03-031-1/+177
| | | | | | | | | | This section contains some fundamental terms people decided were important enough to have in this getting-started manual. (From yocto-docs rev: 42bfa0d8fc0a61c26f6b2f4b9e285c06255e8b8d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Added section on BB workflowScott Rifenbark2018-03-032-123/+72
| | | | | | | | | | | New section called "The OpenEmbedded Build System Workflow". This section presents the tried and true flow block figure that shows what happens when you fire off a build. (From yocto-docs rev: 5b4313ba87a2ccd139f2b980f4cf097700421cf4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, mega-manual: Added reference distro poky sectionScott Rifenbark2018-03-032-0/+136
| | | | | | | | | | | | | | Added the new section "Reference Embedded Distribution (Poky)" section to the getting-started manual. The new section required a new figure. I had to add the figure to the figures folder of both the getting-started and mega-manual books. Updates to the Makefile to include the new figure as part the tarfiles created for each book. (From yocto-docs rev: e5f44e17d4c1e55b6f229cc3745727e439b5bcb7) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Added "Development Methods" sectionScott Rifenbark2018-03-031-2/+95
| | | | | | | | | | | | This section introduces the ways a developer can use the Yocto Project. They can use BitBake from a Linux shell, they can got through CROPS, they can use Toaster, and they can use the Eclipse IDE. The section overviews these possibilities. (From yocto-docs rev: 95af6303364f94f91c94fd0bd1890b4e6351048e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Created Components and Tools sectionScott Rifenbark2018-03-031-6/+449
| | | | | | | | | | New content that leverages off the same information from the new website. (From yocto-docs rev: 1d5bf1501a1d0efe388dc5f4a7f741a272c6301c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, dev-manual: Created Layer Model sectionScott Rifenbark2018-02-141-2/+116
| | | | | | | | | | | This involved removing the general information about layers from the dev-manual and incorporating it into the new section of the getting-started manual. (From yocto-docs rev: 26438b03751948661f48fb0c023e393101b80e19) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, mega-manual: New content for intro chapterScott Rifenbark2018-02-142-0/+255
| | | | | | | | | | | Created content for "What is the Yocto Project" section. Involved a new figure that had to be shared in the mega-manual figures folder. (From yocto-docs rev: 72c18abd11587f4d78848afb8a71ff7f4a0e76d0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started, mega-manual: Added new GS chapterScott Rifenbark2018-02-142-0/+49
| | | | | | | | | | | | I have added a chapter to the getting-started manual that will introduce the YP. Just the framework exists at this point. Changes to the mega-manual.xml file were made to include the new chapter in that manual as well. (From yocto-docs rev: 8a52156ac02d9a9a97c5f0cd8dce5f70d2be68d0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Chapter title changeScott Rifenbark2018-02-141-1/+1
| | | | | | | | | Updated the manual introduction chapter's title. (From yocto-docs rev: db067668a6202318bbbcc62cc455c34e099182de) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Moved the detailed build section to concepts-manual.Scott Rifenbark2018-02-141-1650/+0
| | | | | | | | | | | | | | The section that provides a closer look into the build system has moved from the getting-started manaul to the concepts-manual. I fixed all the links, provided some coded formatting of the entire section, and made general updates. The other manuals had links that needed fixed due to the move. (From yocto-docs rev: b83a5619f56ebd9879fdcadcf474859e68b26d58) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* getting-started: Removed unused figuresScott Rifenbark2018-02-1413-0/+0
| | | | | | | | | | The figures from the deeper look of the build section got moved to the concepts manual. Removed these unused figures. (From yocto-docs rev: 13175a89b6d7bf79a86f4ac45d5f2cd78ba02108) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* dev-manual, getting-started: Moved the BB syntax sectionScott Rifenbark2018-02-141-298/+1
| | | | | | | | | | | This section on BitBake syntax appeared in the Getting Started manual. I decided that it should live with the section on writing a new recipe. (From yocto-docs rev: 8d83ce3e11405b2f12f27cdd117a19c4af52146a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated links into new concepts-manualScott Rifenbark2018-02-141-2/+2
| | | | | | | | | | | | 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>
* concepts-manual: Removed unwanted figuresScott Rifenbark2018-02-141-0/+0
| | | | | | | | | | | | 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>
* documentation: Purged overview manual referencesScott Rifenbark2018-02-142-7/+7
| | | | | | | | | | | | | | | | | | | | 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>
* getting-started: Removed "concepts.xml" fileScott Rifenbark2018-02-142-1932/+1
| | | | | | | | | | | | 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>
* getting-started: Removed accidental tracked filesScott Rifenbark2018-02-1492-10021/+0
| | | | | | | | | | | | | 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>
* getting-started: Changed chapter idScott Rifenbark2018-02-141-1/+1
| | | | | | | (From yocto-docs rev: 52cc6ae12c5c92f6f8e508571b943443a6d133f1) 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-14119-0/+16087
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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-05-27 05:08:39 +0000