summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
Commit message (Collapse)AuthorAgeFilesLines
* documentation: Converted "meta-yocto" to "meta-poky"Scott Rifenbark2016-04-182-17/+17
| | | | | | | | | Occurrences in many manuals and one figure. (From yocto-docs rev: 26d30cd162083c62216fb4ab526d0b231f453de1) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Fixed references using the DISTRO_NAME variableScott Rifenbark2016-04-061-1/+1
| | | | | | | | | | | | With the introduction of a DISTRO_NAME_NO_CAP variable, the occurrences of the DISTRO_NAME variable had to be checked to see if they really should be using the "NO_CAP" variable instead. Output and actual branch names are case-sensitive. (From yocto-docs rev: 711a3255538298dd3c4bd2af8ad13bc2d159c872) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated release date in manual history tables.Scott Rifenbark2016-04-061-2/+2
| | | | | | | | | Updated to "April 2016" for all manuals that use this table. (From yocto-docs rev: 4d3753cc92c446668b0c383736c2071e24e53dd2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Edits to a previous patch.Scott Rifenbark2016-03-231-18/+22
| | | | | | | | | | I applied some grammar and writing edits to a large patch of new text. (From yocto-docs rev: 67cd700131e7cbca5769f25328772406f860d519) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Explain the local releaseBelen2016-03-234-445/+509
| | | | | | | | | | | | | The fact that the Local Yocto Project release does not provide any compatible layers confuses people. Add a section about the local release to explain what it does. [YOCTO #9229] (From yocto-docs rev: cc7ebcd5a66ff3041a7fdd17e697dfb60b08cadd) Signed-off-by: Belen <belen@icarus.isw.intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: remove all references to HobBelen Barros Pena2016-03-231-19/+0
| | | | | | | | | | | | | | | | | | | Hob and the packageinfo class have now been removed from the code base. This patch removes all references to: * Hob * meta-hob * packageinfo and * BBLAYERS_NON_REMOVABLE from the documentation. So long, Hob, and thanks for all the fish. (From yocto-docs rev: 6a1ba2761d5c2ec1072616ce3d791787f1b1b2a7) Signed-off-by: Belen Barros Pena <belen.barros.pena@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated how manage.py createsuperuser command is runBelen Barros Pena2016-03-031-3/+7
| | | | | | | | | | | | The manage.py createsuperuser command must be run from the directory containing the Toaster database, and not from the root of the checkout directory, as the manual indicated. Amend the section to provide the correct instructions. (From yocto-docs rev: 41fa8a04c947169d971c5e1ecb4619249d1dc7b3) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed prompts for json file.Belen Barros Pena2016-03-031-9/+0
| | | | | | | | | | Two instances existed instructing the user about a prompt for the json file prompt. These have been removed. (From yocto-docs rev: f45cb8c5db70ef15e685c68508fd3941d8c6727e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed typo - double "allow" words.Scott Rifenbark2016-03-031-1/+1
| | | | | | | (From yocto-docs rev: 47f55ee6ef4348d0825631f205815c97903ee4c8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Applied a patch to weed out build mode (modes).Scott Rifenbark2016-03-032-84/+72
| | | | | | | (From yocto-docs rev: 3013ced298115dd7567e7311a0c0e98626cb139d) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated the "Installation" to have TOASTER_DIR informationBelen Barros Pena2016-02-041-5/+26
| | | | | | | | | | | | | | In section 3.6 of the manual about setting up a production instance of Toaster, explain that TOASTER_DIR determines the location of the build directory, and that the checksettings command configures the build environment for Toaster. NOTE: I applied some minor fixes to the wording. (From yocto-docs rev: b900e4f3f7a1f798b82a25e350cb8626ffb5d786) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated instructions for production setup.Scott Rifenbark2016-01-291-28/+15
| | | | | | | | | | | Current instructions were wrong. Applied changes to correct them. Author: Belen Barros Pena <belen.barros.pena@intel.com> (From yocto-docs rev: edbcd9e2ef35772008107ff00ebb8e6bc71b1d50) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updates on how to start Toaster.Ed Bartosh2016-01-151-59/+8
| | | | | | | | | | | | | | | Recently, the way to start Toaster has been simplified. The only way to start it now is to source toaster script. Builds can be run either from command line or from Toaster web interface. Updated instructions to start toaster according to the changes described above. (From yocto-docs rev: 2e980c9157abad073e7d08309a99cb2f515441c0) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updates to toaster use chapter.Ed Bartosh2016-01-071-914/+5
| | | | | | | | | | | | * Removed obsolete bits that were already commented out of the XML file. * Added more detail to running Toaster and accessing the information. (From yocto-docs rev: d2b964e395273bde4f75ba3cd8e26a9e7d00b569) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepare for 2.1 buildsScott Rifenbark2016-01-071-0/+5
| | | | | | | | | | | The changes are for the poky.ent file and the mega-manual.sed file to take care of variables. Also, entries added for the manual revision table. (From yocto-docs rev: 60da39f85165e2d4aef55d456f8203183e089433) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed SDKMACHINE from the json file example.Scott Rifenbark2015-11-181-1/+0
| | | | | | | (From yocto-docs rev: f8c62ba32f471076a33d79f4e47f18dccd5690c6) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster manual: Updated the set up and use chapterScott Rifenbark2015-10-271-15/+26
| | | | | | | | | Applied review changes from Belen. (From yocto-docs rev: 1b9a8c1ee031d0633a0ace930d014399a09e7172) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added new Toaster functionality descriptions.Scott Rifenbark2015-10-273-11/+479
| | | | | | | | | | Flow and usage information has changed. Changes here reflect that from the Toaster Team. (From yocto-docs rev: 9774dec014b6d13623988b0d7c050c9e6deaad6f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated the json file example bits to be currentScott Rifenbark2015-10-211-97/+97
| | | | | | | | | Fixes [YOCTO #8428] (From yocto-docs rev: d719f76c6fb3d33b4633d2d64d448bf225af3298) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: New section on PREFERRED_VERSIONScott Rifenbark2015-10-215-51/+106
| | | | | | | | | | | | Added a new section in the interface use area that describes how to build a version of a recipe that is not the default version. Four new figures were added to support the description. (From yocto-docs rev: 232a875fb8fff97ce0578cf50b2a102bdaed1758) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added note for creating virtual environmentScott Rifenbark2015-10-211-0/+5
| | | | | | | | | | Added a note strongly suggesting that the user should set up this virtual environment even though it is not required. (From yocto-docs rev: 1e5f5c7e36eb8541d0d0e2c7e5d37d65c84946bf) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updates to example toasterconf.json fileScott Rifenbark2015-10-211-4/+4
| | | | | | | | | | | Fixes [YOCTO #8428] The changes to the .json file are now shown in the documentation. (From yocto-docs rev: 5636632f0a2f0d79d632c72037c4306cfad3ec75) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated the section for setting up virtual env.Scott Rifenbark2015-10-211-9/+9
| | | | | | | | | | | The section for setting up a Python virtual environment has gone from "optional" to "required". I re-worded the section as such. (From yocto-docs rev: 3a20244c8b0b594723c0b35c8808bb96a210d63a) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated files to support 2.0 release.Scott Rifenbark2015-10-211-3/+3
| | | | | | | | | | | | These updates included editing the poky.ent file so that DISTRO and related variables are now 2.0. Also updated all the title pages to have the manual revision table correct. Finally, used my email for the manuals. (From yocto-docs rev: deae61bfbb528ea0ced82399a78260a7f34a7a11) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed "dizzy" and replaced with "jethro"Scott Rifenbark2015-10-211-20/+20
| | | | | | | (From yocto-docs rev: 3cae958e49c091b2820631fc500171bb068eabf5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* yocto-project-qs and others: Rewrite of the QSScott Rifenbark2015-07-282-5/+5
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This was a complete re-write of the YP Quick Start in an attempt to streamline it, remove unecessary detail, and make it flow better with the examples. In doing so, many manuals were affected due to section headings being renamed, information being moved, etc. Here is a list of the changes by manual: Makefile - Removed two figures from TARFILE list for the yocto-project-qs. Added building-an-image.png to the ref-manual TARFILE list. Added using-a-pre-build-image.png to the adt-manual TARFILE list. Repositioned 'eclipse' in the adt-manual TARFILE list. adt-manual: Fixed a cross-reference so that it goes to the new 'Building Images' section that is within the YP QS. Added new section 'Example Using Pre-Build Binaries and QEMU' to hold the information that was formerly in YP QS. dev-manual: Removed a cross-reference into the YP QS that promised how to configure the most efficent build. Changed a cross-reference into the YP QS from 'The Packages' to 'The Build System Packages'. Changed a cross-reference into the YP QS from 'Building an Image' to 'Building Images'. Changed a text reference from the YP QS to the adt-manual. Moved the bit about getting YP files by using the YP website from the YP QS to the dev-manual. Changed a cross-reference into the YP QS from 'Using Pre-Built Binaries and QEMU' to 'Example Using Pre-built Binaries and QEMU', which was moved to the adt-manual. ref-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. Moved the note about if your system has oss4-dev in the packages area in the YP QS to the appropriate area in the ref-manual. Moved the introduction information regarding building an image along with the figure from YP QS to the ref-manual's section on building images. toaster-manual: Changed a cross-reference into the YP QS from 'What You Need and How You Get It' to 'Setting Up to Use the Yocto Project'. yocto-project-qs: Complete rewrite that changed many section headings and removed much detail, which was placed in other manuals. (From yocto-docs rev: da4ed8147b04963a700caa784bda709c57b4eb6e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed the daemon requirementScott Rifenbark2015-07-281-4/+4
| | | | | | | | | | | Fixes [YOCTO #7271] Removed all traces of the daemon requirement. (From yocto-docs rev: 1c1da060322e7e964f860dc4b80b5411ea19b1b3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated customization layers to point to XSL mirrorsScott Rifenbark2015-07-281-1/+8
| | | | | | | | | | | | | | The customization layers were pointing to Sourceforge site for the XSl files needed to build the manuals. Throuhgout time, this site has failed me enough to warrent trying to get these XSL files from some other source. Rather than ship the XSL files with the YP release, we decided to create some mirrors and point the customization files there. (From yocto-docs rev: 4fd1703870694dff1f593b421f90aad0803d9e65) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added detail for the URL to access Web InterfaceScott Rifenbark2015-07-281-0/+5
| | | | | | | (From yocto-docs rev: 3691068965b9b0db66f4b8b5bb0e4fb6e5d9741e) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Removed redundant video.Scott Rifenbark2015-04-241-18/+13
| | | | | | | (From yocto-docs rev: 4188241b40cf1ce5b70e21cd5f65362758742b02) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Preparation for 1.9 buildsScott Rifenbark2015-04-151-0/+5
| | | | | | | | | | | | | | | | | This involves the following: * Inserting a new row for all manual revision history tables to have "October 2015" and 1.9 as the release information. * Updating the mega-manual.sed file to process links for 1.9 * Updating variables in poky.ent to deal with the 1.9 release variables. (From yocto-docs rev: 1ed55c08b96cf0fded38833635111a5c6da86781) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Fixed release month in the manual table.Scott Rifenbark2015-04-101-1/+1
| | | | | | | (From yocto-docs rev: 1c67a2a19d5dd75030928c6f571d516e5edd0b99) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added new video link for toaster configuration.Scott Rifenbark2015-04-101-0/+5
| | | | | | (From yocto-docs rev: 8e418e1b203d749bd939bf0f109fb8fce6053ceb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
* toaster-manual: Review edits applied.Scott Rifenbark2015-04-022-49/+34
| | | | | | | | | | Some steps updated according to Belen and a video link fixed to not point to Belen's Youtube area. (From yocto-docs rev: 557c22fdd287160f6aabac0928ce6bd8d6af3394) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Updated customization layer to not use local XSL file.Scott Rifenbark2015-04-021-2/+2
| | | | | | | (From yocto-docs rev: f33dee9e57a8adc18d4674f97c0f77ccbbb4a6e5) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Applied final review edits.Scott Rifenbark2015-04-023-98/+113
| | | | | | | | | This should be it unless there are late coming comments. (From yocto-docs rev: cb32e3330a6fe2d26425f8765689749afcd989e9) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Made some updates for virtual environment section.Scott Rifenbark2015-04-011-9/+11
| | | | | | | | | | | I moved the note that tells the user they have to initialize the virtual environment every time before starting Toaster to the correct location. I had it misplaced. (From yocto-docs rev: 65258338e1ffb92ded573ea3b447b424b5f5fa97) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added a new video that shows fido features.Scott Rifenbark2015-04-011-0/+5
| | | | | | | (From yocto-docs rev: a94d6dec039d9b60468c0b26d48b9aa76c300afb) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Created links to Youtube for the GUI vidsScott Rifenbark2015-04-011-4/+50
| | | | | | | | | | I could not get the embedded vids working very well. So we defaulted to just linking to the Youtube locations directly. (From yocto-docs rev: 95bef674ec04eec94f568ab00b94f7174d456011) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added note telling user to initialize virtual envScott Rifenbark2015-04-011-0/+9
| | | | | | | | | | The user must re-initialize the virtual environment (if installed) prior to starting Toaster each time. (From yocto-docs rev: b0daa23784f17778f758b0572f90f9293a822812) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Draft of Manual.Scott Rifenbark2015-04-018-294/+2062
| | | | | | | | | Fixes [YOCTO #6901] (From yocto-docs rev: 258b46b0f3e23045b5fb8c97d03dceb69db5ce20) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: 2nd draft for review.Scott Rifenbark2015-02-173-290/+374
| | | | | | | | | | | Fixes [YOCTO #6901] This is the 2nd review draft of the manual. (From yocto-docs rev: 9f541e4421e0e74e59e3b3da1896b6c1254daf08) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Cleaned up the intro chapterScott Rifenbark2015-02-171-289/+0
| | | | | | | | | | | | Fixes [YOCTO #6901] I removed some left over stuff from the intro that should not have been in there. (From yocto-docs rev: 91d1ee2b4433312e0f94e1ac99f8ec0e14ef6ac7) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added two chapter files.Scott Rifenbark2015-02-172-0/+401
| | | | | | | | | | | Fixes [YOCTO #6901] These are the second and third chapters of the Toaster Manual. (From yocto-docs rev: 6ff4e3dfff391efdbb0f36dc6800bf115abcfc92) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Changed from "current" to "1.76.1" XSL templatesScott Rifenbark2015-02-171-1/+1
| | | | | | | | | | | Fixes [YOCTO #6901] Makes it so the boxes appear around the manual revision table. (From yocto-docs rev: f3ee2bc1ef957a585d0f814b91451a8460dec8c1) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Edits to the intro chapterScott Rifenbark2015-02-171-27/+45
| | | | | | | | | Fixes [YOCTO #6901] (From yocto-docs rev: 633368738e244313168edab86e843b8895e818e3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added two chapters to the manual's book file.Scott Rifenbark2015-02-171-0/+4
| | | | | | | | | | | | Added both chapters that follow the intro chapter to the root file so they will build as part of the book. Fixes [YOCTO #6901] (From yocto-docs rev: 37967896f12471d34188cd532e00211ca665910b) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: WIP - Some placeholder introductory text.Scott Rifenbark2015-02-171-1/+356
| | | | | | | (From yocto-docs rev: 50af668137ec11105f08398bf92649217f75aad3) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Initial file structure for new Toaster User Manual.Scott Rifenbark2015-02-175-0/+1085
For this commit, the manual only has a single "intro" file with placeholder text only. Graphic for title page is in place, stylesheet is in place, all files needed for a successful, initial build of the new manual. (From yocto-docs rev: 99416caa943fe6af13292b18bda53522ce3576d6) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>