summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
Commit message (Collapse)AuthorAgeFilesLines
...
* 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>
* documentation: Updated "latest manual" note on title pageScott Rifenbark2017-02-191-6/+26
| | | | | | | | | | | | | | | Fixes [YOCTO #10076] The note on the title page for each manual was brief regarding where to find the latest version of the manual. I updated the note to have more detailed information on finding current, alternate, and latest versions of the manual based on YP releases. (From yocto-docs rev: 0ec81465296a7a78309d3039af4d00caa52d2285) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updates to support developing 2.3 YP docsScott Rifenbark2016-11-161-0/+5
| | | | | | | | | | | | | | | | | | Changes to the following: * All manual revision tables to indicate a 2.3 release proposed for April of 2017. * Updated the poky.ent file so that all variables needed reflect 2.3 values. * Updated the mega-manual.sed file so that processing of links in the mega-manual work for a 2.3 release. (From yocto-docs rev: 926e282c17b67c79b94a0b62a0b18bfbe0b26c40) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Added video link to 2.2 Toaster Intro.Scott Rifenbark2016-10-131-0/+7
| | | | | | | (From yocto-docs rev: 5f93674dbb26db55302471b65f2bc2fa2d78ab8b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Updated Manual revision table for 2.2Scott Rifenbark2016-10-111-1/+1
| | | | | | | | | Added string "October 2016" as the release date. (From yocto-docs rev: db40986677746afbbb138d9cbe3885111550b7c5) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Changed the Webport address:Scott Rifenbark2016-07-191-2/+2
| | | | | | | | | | Using 0.0.0.0:8400 as a better way to set up this address. Easier on the user. (From yocto-docs rev: bef463d2743989596388fda7e97119f43da045a8) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: splitted long lineEd Bartosh2016-07-191-1/+2
| | | | | | | | | | | The TOASTER_DIR=... checksettings line is too long and got truncated when documenation in pdf format is made. Splitting it to two lines should fix this. (From yocto-docs rev: f3bf1c7b4094a9fda60f7f9d99363a947afed261) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: point keywords to Django documentationEd Bartosh2016-07-191-3/+7
| | | | | | | | | | Pointed SECRET_KEY, STATIC_ROOT and DATABASE keywords to the Django documentation. (From yocto-docs rev: d4a6291ad6ef40963c601e60dd861c76499d8b3f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Update toaster start documentationMichael Wood2016-07-191-6/+22
| | | | | | | | | | | | - Update starting toaster to source toaster start - Add webport address documentation - Remove redundant "syncdb" call - Make it clearer that collectstatic uses STATIC_ROOT (From yocto-docs rev: 75516923f72b8d1f52cfd62281f71b637c9cac93) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add OpenSUSE to the list of distrosEd Bartosh2016-07-191-1/+1
| | | | | | | | | | | Updated instructions of restarting apache. As OpenSUSE way of restarting apache is the same as Ubuntu and Debian it's enough to just add OpenSUSE to the list of distros. (From yocto-docs rev: 0aed02ca72303574d17996dc56484f76c772c864) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update runbuilds instructionsEd Bartosh2016-07-191-11/+42
| | | | | | | | | | | | Added sample configuration files and instructions for the runbuilds systemd service. Service runs runbuilds in a screen session for user convenience. User can attach to the session to see the runbuilds output, monitor logs and build environment. (From yocto-docs rev: 40beaa575fb96a06992a1d62bb45cd0cbbe2ae86) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update apache configuration fileEd Bartosh2016-07-191-5/+15
| | | | | | | | | | | | | | | | Changed access control instructions to work with Apache 2.4 according to https://httpd.apache.org/docs/current/upgrading.html. Added 'Require all granted' for wsgi.py according to https://docs.djangoproject.com/en/1.9/howto/deployment/wsgi/modwsgi/. Changed python module path for WSGIDaemonProcess as python version changed and modules are installed to the different path. (From yocto-docs rev: 503b6c3c250936e889ce146bfcd301ed55e638d2) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add instructions for OpenSUSEEd Bartosh2016-07-191-0/+4
| | | | | | | | | | Added description of the location of apache configuration file for OpenSUSE Leap 42.1 (From yocto-docs rev: 50f9a376072ce0b7d3ed4650ca3c3ea8e5ff14dc) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: change mysql driverEd Bartosh2016-07-191-2/+1
| | | | | | | | | | | | | Here is a quote from Django 1.9 documentation regarding this: mysqlclient is a fork of MySQLdb which notably supports Python 3 and can be used as a drop-in replacement for MySQLdb. At the time of this writing, this is the recommended choice for using MySQL with Django. (From yocto-docs rev: deb02aeea4912f9d7978de3529467e4503eeeffb) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add instructions to create userEd Bartosh2016-07-191-2/+1
| | | | | | | | | | Creating separate toaster account would make production setup more isolated and maintainable. (From yocto-docs rev: 50ed20ad881da8d454a520903dadff20c5011fae) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add list of packages for openSUSEEd Bartosh2016-07-191-0/+7
| | | | | | | | | Added package installation instructions for openSUSE Leap 42.1 (From yocto-docs rev: 895fd65a8641c877ef6eba49e20d34fd71dd7d66) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update list of packagesEd Bartosh2016-07-191-2/+2
| | | | | | | | | | | Changed mod_wsgi package names as Toaster requires python 3 version of mod_wsgi. Added missing python3-pip, mariadb-server, mariadb-devel and python3-devel to the list of packages for Fedora. (From yocto-docs rev: 8a2da9855c0ed5dd137808fa976cbe707048551e) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: update distro versionsEd Bartosh2016-07-191-2/+3
| | | | | | | | | Changed Ubuntu and Fedora versions to the latest ones. (From yocto-docs rev: 50a7d0110e9f8c7c3c8c8c5b6e3a1495c9f9ff79) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: Switch to pip3 dependency installerbrian avery2016-07-192-65/+34
| | | | | | | | | | | | | Our switch to python3 requires us to dump the virtualenv approach as long as we need python to resolve to python2 in the same shell that python3 resolves to python3. To enable users to install Toaster's python package dependencies locally, we are changing to using pip3 and these doc changes explain how to do that. (From yocto-docs rev: 06b8820bcb90d1855ccb2712b616bb89847a148f) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* toaster-manual: add instructions to create userEd Bartosh2016-07-191-2/+8
| | | | | | | | | | Creating separate toaster account would make production setup more isolated and maintainable. (From yocto-docs rev: 33c638d3e9a68d06d929276c6064d567ed7fe696) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* documentation: Prepared manuals for a 2.2 release.Scott Rifenbark2016-06-061-0/+5
| | | | | | | | | | | | | * Updated poky.ent to have the appropriate 2.2 variables * Updated all manual revision tables to have a new entry for 2.2 - used "Sometime in 2016" for the date. * Updated the mega-manual.sed file to process internal links for 2.2. (From yocto-docs rev: 2acd49ee197e3e3e725f4cb8cc432437afd8646b) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
* 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>
generated by cgit v1.2.3-54-g00ecf (git 2.39.0) at 2024-11-14 21:22:44 +0000