summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
Commit message (Collapse)AuthorAgeFilesLines
* Documenation: Prepared for the 3.1.1 releaseSteve Sakoman2020-06-021-1/+6
| | | | Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentaiton: Change author infoakuster2020-04-061-3/+2
| | | | | | | | | | Update the author indo and use variables for author and email to make it easier to change in future. (From yocto-docs rev: 4fdf2a060705fa00b11b5a9d270f4ffa506c9927) Signed-off-by: Armin Kuster <akuster808@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* use defined entity "YOCTO_DOCS_URL", not "YOCTO_HOME_URL"rpjday@crashcourse.ca2020-04-061-2/+2
| | | | | | | | | | | | | | | Given the defined DocBook entity: <!ENTITY YOCTO_DOCS_URL "&YOCTO_HOME_URL;/docs"> replace numerous instances of the more verbose "&YOCTO_HOME_URL;/documentation", which is a redirect, anyway. rday (From yocto-docs rev: 53fa17321624028b12d880bc4236fbef46675eb4) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* manuals: Update YP manual notes with pointer to docs MLRobert P. J. Day2020-03-111-6/+8
| | | | | | | | | | Update the "Manual Notes" section of numerous YP manuals with a reference to the recently-introduced YP documentation mailing list. (From yocto-docs rev: a10fe36c864b8f1a71c6a8eb7e1f6a4eef2f5171) Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP 3.1 Docs: Updated Manual revision tables.Scott Rifenbark2019-12-161-2/+2
| | | | | | | | | | Scrubbed so subsequent releases are relevant to the initial release only. (From yocto-docs rev: 7bb2c4f851aa968eb05b11c5471b81962f268eba) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* YP Documentation: Set up for YP 3.1 releaseScott Rifenbark2019-12-091-1/+6
| | | | | | | | | | | * Updates to poky.ent * Updates to mega-manual.sed * Updates to all <manual>.xml files for date (From yocto-docs rev: 5f752ef0193cb60cd5d46a63e99ffcd02107e0c2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documenation: Changed "2.8" to "3.0".Scott Rifenbark2019-10-231-2/+2
| | | | | | | | | | I was using "2.8" throughout the manual set instead of "3.0". Updated all aspects to "3.0". (From yocto-docs rev: db19937e98c59d4d2a9ce89877be3c8e0b05991a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared for 2.8 releaseScott Rifenbark2019-05-071-1/+6
| | | | | | | | | | | poky.ent - variables all set up for 2.8 mega-manual.sed - "2.7" replaced with "2.8" <folder>.xml - manual revision history tables updated. (From yocto-docs rev: 6092a9282cbd397a2f64ca74361f862ea76b0e28) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Preparing for 2.7 release.Scott Rifenbark2018-12-151-1/+6
| | | | | | | | | | | Updated poky.ent to have variables for 2.7. Updated mega-manual.sed file to use "2.7" string. Updated all <manual>.xml Manual History Tables to use "TBD" (From yocto-docs rev: d6f8bbd6e107913265ea1ac95ab8817e199ff60b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed bad target ID for the dev-manual.Scott Rifenbark2018-08-151-1/+1
| | | | | | | | | This fix involved a few other manuals. (From yocto-docs rev: d2659951a458a8db773e8c1b2b86a7b109d667fa) 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: Changed title to remove redundancyScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | The "Setting Up the Development Host to Use the Yocto Project" title changed to "Preparing the Build Host". Fixed links in a lot of other manual. (From yocto-docs rev: 00e487e01a0e2a16f5b8d786b3124cbe5115b38b) 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>
* toaster-manual: Updated step 7 of the To "Installation" sectionScott Rifenbark2018-05-241-0/+20
| | | | | | | | | Changed some wordings to accomodate reviewer feedback. (From yocto-docs rev: 6de69db7ae5bbbe5e6e7f0b5f6b9b1326f3f5f6a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Setting Up Toaster Without a Web Server"Scott Rifenbark2018-05-241-2/+13
| | | | | | | | | | | | | This section had a new bullet added for talking about one instance of Toaster web server to track and capture multiple command-line builds. Also, provided better wording surrounding shutting down Toaster. (From yocto-docs rev: 9dbe242bf90860afabc9ab218992d2b81aaf8896) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated database schema step for ToasterScott Rifenbark2018-05-241-47/+37
| | | | | | | | | | | The step for getting toaster to create the database schema, default data, and gather the statically-served files changed. I updated with the proper steps. (From yocto-docs rev: 2c3f7ac7f9419c32147be860897984d391a0e930) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated bad links and added two sectionsScott Rifenbark2018-05-241-3/+57
| | | | | | | | | | | | | | | The links to the DATABASES, SECRET_KEY, and STATIC_ROOT were bad. They were pointing to old dated software. I updated the links. Also, added a couple new sections. One is how to start a Toaster environment without its web server. The other is how to start a Toaster environment without a build server. (From yocto-docs rev: afe2708014600c0a86c649f6533dd1f6317fe742) 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>
* toaster-manual: Fixed note formatting in "Useful Commands"Scott Rifenbark2018-05-241-20/+21
| | | | | | | (From yocto-docs rev: 61e26883ed2c3cb82e7853297222d5b1499788f8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed capitalization on "Build Directory" term.Scott Rifenbark2018-05-241-1/+1
| | | | | | | (From yocto-docs rev: a02905ae2ad015d43d5c9b88f9b68e603734bcf4) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed some links.Scott Rifenbark2018-05-241-2/+2
| | | | | | | (From yocto-docs rev: 57c261c94de9ac567321fbe8d80a1d793857d355) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed a couple links.Scott Rifenbark2018-05-241-5/+5
| | | | | | | (From yocto-docs rev: fe26835dc9448738be49d08f3e96a464599897e9) 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-243-3/+3
| | | | | | | | | | | 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>
* documentation: Updated everything for new overview-manualScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | | | | | | | 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>
* documentation: Changed getting-started manual titlesScott Rifenbark2018-05-241-1/+1
| | | | | | | | | | | 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 "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: Purged the YP Quick Start references from YP setScott Rifenbark2018-05-241-4/+3
| | | | | | | | | | | | | | | 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-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>
* bsp-guide: Removed deprecated tool sectionsScott Rifenbark2018-03-251-5/+5
| | | | | | | | | | | | | | | 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>
* documentation: Set up for "sumo" (YP 2.5) Release.Scott Rifenbark2017-11-121-0/+5
| | | | | | | | | | | poky.ent - updated variables <manual>.xml - updated manual revision tables mega-manual.sed - replaced "2.4" with "2.5" for links. (From yocto-docs rev: 15d1f805ad11fba145155dcec17b7ec8a21ad487) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated title page notes and author groupScott Rifenbark2017-10-301-17/+19
| | | | | | | | | | | | | Made the title page notes consistent across the manual set. Made the author group information consistent as well. It is better that authorship is seen as a third party and not tied to Intel Corporation. (From yocto-docs rev: 32cec087e384e1d92e3e84bbae5c6560a0af3136) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed external linksScott Rifenbark2017-10-304-4/+4
| | | | | | | | | | Found four links going to the dev-manual that should have benn going to the ref-manual. These were for YP terms. Fixed them. (From yocto-docs rev: 0c75eda3a772d8c40e381e44e563a5b79b3d0cb5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Defining the Default Distro and Other Values"Kristi Rifenbark2017-10-301-7/+6
| | | | | | | | | Updated with review fixes. (From yocto-docs rev: 0436ae269a02579903adae659577e944761139f5) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated the "Remote Toaster Monitoring" sectionKristi Rifenbark2017-10-161-7/+7
| | | | | | | | | Updated with review fixes. (From yocto-docs rev: de6e7e194a414826c9b1bcc19a4975c67f90ee4f) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated the "Configuring Toaster" sectionKristi Rifenbark2017-10-161-4/+12
| | | | | | | | | Updated with review edits. (From yocto-docs rev: 43dc539fb195e6194117dbc4de4d053fff53e9ff) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Remote Toaster Monitoring" chapterKristi Rifenbark2017-10-161-2/+6
| | | | | | | | | Review fixes. (From yocto-docs rev: 8f01b79dd217af94af1794c339027a00ff1f64c2) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Created "Configuring Toaster" chapterKristi Rifenbark2017-10-162-273/+181
| | | | | | | | | | Deleted the existing JSON chapter, and replaced it with this new chapter. (From yocto-docs rev: 86f9fb9c567310ecd1b06944c4c9107ec30df29c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed section "What Makes up a Release"Kristi Rifenbark2017-10-161-140/+0
| | | | | | | | | | The content was obsolete. The new information is covered in the new chapter "Configuring Toaster". (From yocto-docs rev: 680273cb8fecea84297c3102c0b19fff5bcd9d88) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Remote Toaster Monitoring" sectionKristi Rifenbark2017-10-161-5/+5
| | | | | | | | | Updated with review fixes. (From yocto-docs rev: 424e9cad5f950b068e6f977355c5dbdb17da52a2) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added new chapter "Remote Toaster Monitoring"Kristi Rifenbark2017-10-161-0/+164
| | | | | | | | | | Documented new direct JSON API with four subsections to let you remotely monitor Toaster. (From yocto-docs rev: 8b18ccffbcfe896f878dd912ea39b14557426b2c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Install Toaster Packages" sectionKristi Rifenbark2017-10-161-1/+1
| | | | | | | (From yocto-docs rev: ad679fbcd86c06e784d0ba722030b73a4698e64c) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated "Use the Fixture Feature" sectionKristi Rifenbark2017-10-161-1/+1
| | | | | | | | | Updated section based on review notes. (From yocto-docs rev: 843fb2c1344a50eb7481cfc6632fa1118a3b542f) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed toaster-command-loadconf sectionKristi Rifenbark2017-10-161-24/+2
| | | | | | | | | There is no longer a "loadconf" command (From yocto-docs rev: 25c4385833c636bf4cff889ff6325b2a14f5fc14) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added "Use the Fixture Feature" sectionKristi Rifenbark2017-10-161-158/+27
| | | | | | | | | | | Removed two outdated sections, "Use the toasterconf.json File" and "Edit the Configuration File" and replaced them with "Use the Fixture Feature" section. (From yocto-docs rev: 8a247836a958449836effac3600f6923c5289bb6) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Rewrite of the 'Pre-Configured Releases' sectionKristi Rifenbark2017-10-161-13/+6
| | | | | | | (From yocto-docs rev: 4036a69be34613f71cca4a1f879998409f7a0665) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Rewrite of the 'Setting Up External Access' sectionKristi Rifenbark2017-10-161-7/+20
| | | | | | | (From yocto-docs rev: f3737aaeabf5ae169d07b72ef6b70e2b5d7cb4b7) Signed-off-by: Kristi Rifenbark <kristi.rifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documenation: Updated "Usually October" to "October 2017" stringScott Rifenbark2017-10-061-1/+1
| | | | | | | | | | The string in the manual revision table needed updated across the set except for the kernel-dev manual. (From yocto-docs rev: e087a707e02ff913baba2ac8bc6594206f53f70c) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed links for "build-directory" term.Scott Rifenbark2017-06-222-3/+3
| | | | | | | | | | | | | Fixes [YOCTO #11630] Moving the "Yocto Project Terms" section from the dev-manual to the ref-manual broke several links to the id "build-directory". I fixed these to reference into the ref-manual now. (From yocto-docs rev: debe2ae8ce203ebe0f1cee0de54124c15df8bb7e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* Documentation: Created YP 2.4 "latest" docsScott Rifenbark2017-06-041-0/+5
| | | | | | | | | | | | | | Updated poky.ent to use 2.4 variables and numbering Updated mega-manual.sed to use "2.4" string for links Updated all manual revision tables to use "2.4" and "Usually October, 2017" string. (From yocto-docs rev: 17ec7da6ab3fd450c2010812f7ad689288b12dcc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Added support for "pyro" name and May release date.Scott Rifenbark2017-03-241-1/+1
| | | | | | | | | | | | | poky.ent - changed the "tbd" and "TBD" strings to "pyro" and "Pyro", respectively. Manual Head Files - Updated the manual history table with the May release month. (From yocto-docs rev: 076226d2986d0cf69685121e4342f50c1603fc7b) 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-01 01:53:33 +0000