diff options
Diffstat (limited to 'documentation/toaster-manual')
-rw-r--r-- | documentation/toaster-manual/history.rst | 46 | ||||
-rw-r--r-- | documentation/toaster-manual/index.rst | 1 | ||||
-rw-r--r-- | documentation/toaster-manual/intro.rst | 7 | ||||
-rw-r--r-- | documentation/toaster-manual/reference.rst | 63 | ||||
-rw-r--r-- | documentation/toaster-manual/setup-and-use.rst | 49 | ||||
-rw-r--r-- | documentation/toaster-manual/start.rst | 4 |
6 files changed, 60 insertions, 110 deletions
diff --git a/documentation/toaster-manual/history.rst b/documentation/toaster-manual/history.rst deleted file mode 100644 index 05b63e5b9a..0000000000 --- a/documentation/toaster-manual/history.rst +++ /dev/null | |||
@@ -1,46 +0,0 @@ | |||
1 | .. SPDX-License-Identifier: CC-BY-SA-2.0-UK | ||
2 | |||
3 | *********************** | ||
4 | Manual Revision History | ||
5 | *********************** | ||
6 | |||
7 | .. list-table:: | ||
8 | :widths: 10 15 40 | ||
9 | :header-rows: 1 | ||
10 | |||
11 | * - Revision | ||
12 | - Date | ||
13 | - Note | ||
14 | * - 1.8 | ||
15 | - April 2015 | ||
16 | - The initial document released with the Yocto Project 1.8 Release | ||
17 | * - 2.0 | ||
18 | - October 2015 | ||
19 | - Released with the Yocto Project 2.0 Release. | ||
20 | * - 2.1 | ||
21 | - April 2016 | ||
22 | - Released with the Yocto Project 2.1 Release. | ||
23 | * - 2.2 | ||
24 | - October 2016 | ||
25 | - Released with the Yocto Project 2.2 Release. | ||
26 | * - 2.3 | ||
27 | - May 2017 | ||
28 | - Released with the Yocto Project 2.3 Release. | ||
29 | * - 2.4 | ||
30 | - October 2017 | ||
31 | - Released with the Yocto Project 2.4 Release. | ||
32 | * - 2.5 | ||
33 | - May 2018 | ||
34 | - Released with the Yocto Project 2.5 Release. | ||
35 | * - 2.6 | ||
36 | - November 2018 | ||
37 | - Released with the Yocto Project 2.6 Release. | ||
38 | * - 2.7 | ||
39 | - May 2019 | ||
40 | - Released with the Yocto Project 2.7 Release. | ||
41 | * - 3.0 | ||
42 | - October 2019 | ||
43 | - Released with the Yocto Project 3.0 Release. | ||
44 | * - 3.1 | ||
45 | - April 2020 | ||
46 | - Released with the Yocto Project 3.1 Release. | ||
diff --git a/documentation/toaster-manual/index.rst b/documentation/toaster-manual/index.rst index f13ba7b8a1..3ff4c6913a 100644 --- a/documentation/toaster-manual/index.rst +++ b/documentation/toaster-manual/index.rst | |||
@@ -14,6 +14,5 @@ Toaster User Manual | |||
14 | start | 14 | start |
15 | setup-and-use | 15 | setup-and-use |
16 | reference | 16 | reference |
17 | history | ||
18 | 17 | ||
19 | .. include:: /boilerplate.rst | 18 | .. include:: /boilerplate.rst |
diff --git a/documentation/toaster-manual/intro.rst b/documentation/toaster-manual/intro.rst index 57e5b2bb7b..046ff88ce8 100644 --- a/documentation/toaster-manual/intro.rst +++ b/documentation/toaster-manual/intro.rst | |||
@@ -76,9 +76,8 @@ extensive information about the build process. | |||
76 | - See performance information such as build time, task time, CPU | 76 | - See performance information such as build time, task time, CPU |
77 | usage, and disk I/O. | 77 | usage, and disk I/O. |
78 | 78 | ||
79 | For an overview of Toaster shipped with the Yocto Project &DISTRO; | 79 | For an overview of Toaster, see this |
80 | Release, see the "`Toaster - Yocto Project | 80 | `introduction video <https://youtu.be/BlXdOYLgPxA>`__. |
81 | 2.2 <https://youtu.be/BlXdOYLgPxA>`__" video. | ||
82 | 81 | ||
83 | Installation Options | 82 | Installation Options |
84 | ==================== | 83 | ==================== |
@@ -92,6 +91,7 @@ suited for a single user developing on a single build host. | |||
92 | 91 | ||
93 | .. image:: figures/simple-configuration.png | 92 | .. image:: figures/simple-configuration.png |
94 | :align: center | 93 | :align: center |
94 | :width: 70% | ||
95 | 95 | ||
96 | Toaster as a hosted service is suited for multiple users developing | 96 | Toaster as a hosted service is suited for multiple users developing |
97 | across several build hosts. When Toaster is set up as a hosted service, | 97 | across several build hosts. When Toaster is set up as a hosted service, |
@@ -99,3 +99,4 @@ its components can be spread across several machines: | |||
99 | 99 | ||
100 | .. image:: figures/hosted-service.png | 100 | .. image:: figures/hosted-service.png |
101 | :align: center | 101 | :align: center |
102 | :width: 50% | ||
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst index d2ab14c8e6..755b895cee 100644 --- a/documentation/toaster-manual/reference.rst +++ b/documentation/toaster-manual/reference.rst | |||
@@ -9,8 +9,8 @@ concepts and have some basic command reference material available. This | |||
9 | final chapter provides conceptual information on layer sources, | 9 | final chapter provides conceptual information on layer sources, |
10 | releases, and JSON configuration files. Also provided is a quick look at | 10 | releases, and JSON configuration files. Also provided is a quick look at |
11 | some useful ``manage.py`` commands that are Toaster-specific. | 11 | some useful ``manage.py`` commands that are Toaster-specific. |
12 | Information on ``manage.py`` commands does exist across the Web and the | 12 | Information on ``manage.py`` commands is available across the Web and |
13 | information in this manual by no means attempts to provide a command | 13 | this manual by no means attempts to provide a command |
14 | comprehensive reference. | 14 | comprehensive reference. |
15 | 15 | ||
16 | Layer Source | 16 | Layer Source |
@@ -28,13 +28,11 @@ at :oe_layerindex:`/`. You can find the code for this | |||
28 | layer index's web application at :yocto_git:`/layerindex-web/`. | 28 | layer index's web application at :yocto_git:`/layerindex-web/`. |
29 | 29 | ||
30 | When you tie a layer source into Toaster, it can query the layer source | 30 | When you tie a layer source into Toaster, it can query the layer source |
31 | through a | 31 | through a :wikipedia:`REST <Representational_state_transfer>` |
32 | `REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__ | ||
33 | API, store the information about the layers in the Toaster database, and | 32 | API, store the information about the layers in the Toaster database, and |
34 | then show the information to users. Users are then able to view that | 33 | then show the information to users. Users are then able to view that |
35 | information and build layers from Toaster itself without worrying about | 34 | information and build layers from Toaster itself without having to |
36 | cloning or editing the BitBake layers configuration file | 35 | clone or edit the BitBake layers configuration file ``bblayers.conf``. |
37 | ``bblayers.conf``. | ||
38 | 36 | ||
39 | Tying a layer source into Toaster is convenient when you have many | 37 | Tying a layer source into Toaster is convenient when you have many |
40 | custom layers that need to be built on a regular basis by a community of | 38 | custom layers that need to be built on a regular basis by a community of |
@@ -67,7 +65,7 @@ layers. | |||
67 | For general information on layers, see the | 65 | For general information on layers, see the |
68 | ":ref:`overview-manual/yp-intro:the yocto project layer model`" | 66 | ":ref:`overview-manual/yp-intro:the yocto project layer model`" |
69 | section in the Yocto Project Overview and Concepts Manual. For information on how | 67 | section in the Yocto Project Overview and Concepts Manual. For information on how |
70 | to create layers, see the ":ref:`dev-manual/common-tasks:understanding and creating layers`" | 68 | to create layers, see the ":ref:`dev-manual/layers:understanding and creating layers`" |
71 | section in the Yocto Project Development Tasks Manual. | 69 | section in the Yocto Project Development Tasks Manual. |
72 | 70 | ||
73 | Configuring Toaster to Hook Into Your Layer Index | 71 | Configuring Toaster to Hook Into Your Layer Index |
@@ -187,20 +185,20 @@ Configuring the Workflow | |||
187 | ------------------------ | 185 | ------------------------ |
188 | 186 | ||
189 | The ``bldcontrol/management/commands/checksettings.py`` file controls | 187 | The ``bldcontrol/management/commands/checksettings.py`` file controls |
190 | workflow configuration. The following steps outline the process to | 188 | workflow configuration. Here is the process to |
191 | initially populate this database. | 189 | initially populate this database. |
192 | 190 | ||
193 | 1. The default project settings are set from | 191 | #. The default project settings are set from |
194 | ``orm/fixtures/settings.xml``. | 192 | ``orm/fixtures/settings.xml``. |
195 | 193 | ||
196 | 2. The default project distro and layers are added from | 194 | #. The default project distro and layers are added from |
197 | ``orm/fixtures/poky.xml`` if poky is installed. If poky is not | 195 | ``orm/fixtures/poky.xml`` if poky is installed. If poky is not |
198 | installed, they are added from ``orm/fixtures/oe-core.xml``. | 196 | installed, they are added from ``orm/fixtures/oe-core.xml``. |
199 | 197 | ||
200 | 3. If the ``orm/fixtures/custom.xml`` file exists, then its values are | 198 | #. If the ``orm/fixtures/custom.xml`` file exists, then its values are |
201 | added. | 199 | added. |
202 | 200 | ||
203 | 4. The layer index is then scanned and added to the database. | 201 | #. The layer index is then scanned and added to the database. |
204 | 202 | ||
205 | Once these steps complete, Toaster is set up and ready to use. | 203 | Once these steps complete, Toaster is set up and ready to use. |
206 | 204 | ||
@@ -208,7 +206,7 @@ Customizing Pre-Set Data | |||
208 | ------------------------ | 206 | ------------------------ |
209 | 207 | ||
210 | The pre-set data for Toaster is easily customizable. You can create the | 208 | The pre-set data for Toaster is easily customizable. You can create the |
211 | ``orm/fixtures/custom.xml`` file to customize the values that go into to | 209 | ``orm/fixtures/custom.xml`` file to customize the values that go into |
212 | the database. Customization is additive, and can either extend or | 210 | the database. Customization is additive, and can either extend or |
213 | completely replace the existing values. | 211 | completely replace the existing values. |
214 | 212 | ||
@@ -238,7 +236,7 @@ The following example sets "name" to "CUSTOM_XML_ONLY" and its value to | |||
238 | Understanding Fixture File Format | 236 | Understanding Fixture File Format |
239 | --------------------------------- | 237 | --------------------------------- |
240 | 238 | ||
241 | The following is an overview of the file format used by the | 239 | Here is an overview of the file format used by the |
242 | ``oe-core.xml``, ``poky.xml``, and ``custom.xml`` files. | 240 | ``oe-core.xml``, ``poky.xml``, and ``custom.xml`` files. |
243 | 241 | ||
244 | The following subsections describe each of the sections in the fixture | 242 | The following subsections describe each of the sections in the fixture |
@@ -297,7 +295,7 @@ The following defines the releases when you create a new project: | |||
297 | <field type="CharField" name="description">Yocto Project &DISTRO; "&DISTRO_NAME;"</field> | 295 | <field type="CharField" name="description">Yocto Project &DISTRO; "&DISTRO_NAME;"</field> |
298 | <field rel="ManyToOneRel" to="orm.bitbakeversion" name="bitbake_version">1</field> | 296 | <field rel="ManyToOneRel" to="orm.bitbakeversion" name="bitbake_version">1</field> |
299 | <field type="CharField" name="branch_name">&DISTRO_NAME_NO_CAP;</field> | 297 | <field type="CharField" name="branch_name">&DISTRO_NAME_NO_CAP;</field> |
300 | <field type="TextField" name="helptext">Toaster will run your builds using the tip of the <a href="http://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP;">Yocto Project &DISTRO_NAME; branch</a>.</field> | 298 | <field type="TextField" name="helptext">Toaster will run your builds using the tip of the <a href="https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP;">Yocto Project &DISTRO_NAME; branch</a>.</field> |
301 | </object> | 299 | </object> |
302 | 300 | ||
303 | The "pk" value must match the above respective BitBake version record. | 301 | The "pk" value must match the above respective BitBake version record. |
@@ -334,9 +332,9 @@ that includes the layer. In general all releases include the layer. | |||
334 | <field type="CharField" name="name">openembedded-core</field> | 332 | <field type="CharField" name="name">openembedded-core</field> |
335 | <field type="CharField" name="layer_index_url"></field> | 333 | <field type="CharField" name="layer_index_url"></field> |
336 | <field type="CharField" name="vcs_url">git://git.yoctoproject.org/poky</field> | 334 | <field type="CharField" name="vcs_url">git://git.yoctoproject.org/poky</field> |
337 | <field type="CharField" name="vcs_web_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky</field> | 335 | <field type="CharField" name="vcs_web_url">https://git.yoctoproject.org/cgit/cgit.cgi/poky</field> |
338 | <field type="CharField" name="vcs_web_tree_base_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field> | 336 | <field type="CharField" name="vcs_web_tree_base_url">https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field> |
339 | <field type="CharField" name="vcs_web_file_base_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field> | 337 | <field type="CharField" name="vcs_web_file_base_url">https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field> |
340 | </object> | 338 | </object> |
341 | <object model="orm.layer_version" pk="1"> | 339 | <object model="orm.layer_version" pk="1"> |
342 | <field rel="ManyToOneRel" to="orm.layer" name="layer">1</field> | 340 | <field rel="ManyToOneRel" to="orm.layer" name="layer">1</field> |
@@ -370,8 +368,8 @@ Remote Toaster Monitoring | |||
370 | Toaster has an API that allows remote management applications to | 368 | Toaster has an API that allows remote management applications to |
371 | directly query the state of the Toaster server and its builds in a | 369 | directly query the state of the Toaster server and its builds in a |
372 | machine-to-machine manner. This API uses the | 370 | machine-to-machine manner. This API uses the |
373 | `REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__ | 371 | :wikipedia:`REST <Representational_state_transfer>` interface and the |
374 | interface and the transfer of JSON files. For example, you might monitor | 372 | transfer of JSON files. For example, you might monitor |
375 | a build inside a container through well supported known HTTP ports in | 373 | a build inside a container through well supported known HTTP ports in |
376 | order to easily access a Toaster server inside the container. In this | 374 | order to easily access a Toaster server inside the container. In this |
377 | example, when you use this direct JSON API, you avoid having web page | 375 | example, when you use this direct JSON API, you avoid having web page |
@@ -408,7 +406,7 @@ To get the status of pending builds, use the following call:: | |||
408 | Be sure to provide values for host and port. The output is a JSON file that | 406 | Be sure to provide values for host and port. The output is a JSON file that |
409 | itemizes all builds in progress. This file includes the time in seconds since | 407 | itemizes all builds in progress. This file includes the time in seconds since |
410 | each respective build started as well as the progress of the cloning, parsing, | 408 | each respective build started as well as the progress of the cloning, parsing, |
411 | and task execution. The following is sample output for a build in progress: | 409 | and task execution. Here is sample output for a build in progress: |
412 | 410 | ||
413 | .. code-block:: JSON | 411 | .. code-block:: JSON |
414 | 412 | ||
@@ -441,8 +439,8 @@ call:: | |||
441 | http://host:port/toastergui/api/builds | 439 | http://host:port/toastergui/api/builds |
442 | 440 | ||
443 | Be sure to provide values for host and port. The output is a JSON file that | 441 | Be sure to provide values for host and port. The output is a JSON file that |
444 | itemizes all complete builds, and includes build summary information. The | 442 | itemizes all complete builds, and includes build summary information. Here |
445 | following is sample output for a completed build: | 443 | is sample output for a completed build: |
446 | 444 | ||
447 | .. code-block:: JSON | 445 | .. code-block:: JSON |
448 | 446 | ||
@@ -480,7 +478,7 @@ Completed query. See the ":ref:`toaster-manual/reference:checking status of buil | |||
480 | section for more information. | 478 | section for more information. |
481 | 479 | ||
482 | The output is a JSON file that itemizes the specific build and includes | 480 | The output is a JSON file that itemizes the specific build and includes |
483 | build summary information. The following is sample output for a specific | 481 | build summary information. Here is sample output for a specific |
484 | build: | 482 | build: |
485 | 483 | ||
486 | .. code-block:: JSON | 484 | .. code-block:: JSON |
@@ -509,7 +507,7 @@ Useful Commands | |||
509 | =============== | 507 | =============== |
510 | 508 | ||
511 | In addition to the web user interface and the scripts that start and | 509 | In addition to the web user interface and the scripts that start and |
512 | stop Toaster, command-line commands exist through the ``manage.py`` | 510 | stop Toaster, command-line commands are available through the ``manage.py`` |
513 | management script. You can find general documentation on ``manage.py`` | 511 | management script. You can find general documentation on ``manage.py`` |
514 | at the | 512 | at the |
515 | `Django <https://docs.djangoproject.com/en/2.2/topics/settings/>`__ | 513 | `Django <https://docs.djangoproject.com/en/2.2/topics/settings/>`__ |
@@ -523,14 +521,13 @@ tasks. You can locate these commands in the | |||
523 | 521 | ||
524 | - When using ``manage.py`` commands given a default configuration, | 522 | - When using ``manage.py`` commands given a default configuration, |
525 | you must be sure that your working directory is set to the | 523 | you must be sure that your working directory is set to the |
526 | :term:`Build Directory`. Using | 524 | :term:`Build Directory`. Using ``manage.py`` commands from the |
527 | ``manage.py`` commands from the Build Directory allows Toaster to | 525 | :term:`Build Directory` allows Toaster to find the ``toaster.sqlite`` |
528 | find the ``toaster.sqlite`` file, which is located in the Build | 526 | file, which is located in the :term:`Build Directory`. |
529 | Directory. | ||
530 | 527 | ||
531 | - For non-default database configurations, it is possible that you | 528 | - For non-default database configurations, it is possible that you |
532 | can use ``manage.py`` commands from a directory other than the | 529 | can use ``manage.py`` commands from a directory other than the |
533 | Build Directory. To do so, the ``toastermain/settings.py`` file | 530 | :term:`Build Directory`. To do so, the ``toastermain/settings.py`` file |
534 | must be configured to point to the correct database backend. | 531 | must be configured to point to the correct database backend. |
535 | 532 | ||
536 | ``buildslist`` | 533 | ``buildslist`` |
@@ -550,11 +547,11 @@ database. | |||
550 | You need to run the ``buildslist`` command first to identify existing | 547 | You need to run the ``buildslist`` command first to identify existing |
551 | builds in the database before using the | 548 | builds in the database before using the |
552 | :ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an | 549 | :ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an |
553 | example that assumes default repository and build directory names: | 550 | example that assumes default repository and :term:`Build Directory` names: |
554 | 551 | ||
555 | .. code-block:: shell | 552 | .. code-block:: shell |
556 | 553 | ||
557 | $ cd ~/poky/build | 554 | $ cd poky/build |
558 | $ python ../bitbake/lib/toaster/manage.py buildslist | 555 | $ python ../bitbake/lib/toaster/manage.py buildslist |
559 | 556 | ||
560 | If your Toaster database had only one build, the above | 557 | If your Toaster database had only one build, the above |
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst index ded771e796..a0c27499ba 100644 --- a/documentation/toaster-manual/setup-and-use.rst +++ b/documentation/toaster-manual/setup-and-use.rst | |||
@@ -23,8 +23,8 @@ Once in that directory, source the build environment script:: | |||
23 | 23 | ||
24 | $ source oe-init-build-env | 24 | $ source oe-init-build-env |
25 | 25 | ||
26 | Next, from the build directory (e.g. | 26 | Next, from the :term:`Build Directory` (e.g. ``poky/build``), start Toaster |
27 | ``poky/build``), start Toaster using this command:: | 27 | using this command:: |
28 | 28 | ||
29 | $ source toaster start | 29 | $ source toaster start |
30 | 30 | ||
@@ -124,14 +124,14 @@ causes Toaster to create and use ``$TOASTER_DIR./_toaster_clones``. | |||
124 | The Build Directory | 124 | The Build Directory |
125 | =================== | 125 | =================== |
126 | 126 | ||
127 | Toaster creates a build directory within your Source Directory (e.g. | 127 | Toaster creates a :term:`Build Directory` within your Source Directory (e.g. |
128 | ``poky``) to execute the builds. | 128 | ``poky``) to execute the builds. |
129 | 129 | ||
130 | Alternatively, if you would like all of your Toaster related files and | 130 | Alternatively, if you would like all of your Toaster related files and |
131 | directories to be in a particular location, you can set the | 131 | directories to be in a particular location, you can set the |
132 | ``TOASTER_DIR`` environment variable, which takes precedence over your | 132 | ``TOASTER_DIR`` environment variable, which takes precedence over your |
133 | current working directory. Setting this environment variable causes | 133 | current working directory. Setting this environment variable causes |
134 | Toaster to use ``$TOASTER_DIR/build`` as the build directory. | 134 | Toaster to use ``$TOASTER_DIR/build`` as the :term:`Build Directory`. |
135 | 135 | ||
136 | Creating a Django Superuser | 136 | Creating a Django Superuser |
137 | =========================== | 137 | =========================== |
@@ -152,10 +152,10 @@ superuser by following these steps: | |||
152 | $ export PATH=$PATH:$HOME/.local/bin | 152 | $ export PATH=$PATH:$HOME/.local/bin |
153 | 153 | ||
154 | #. From the directory containing the Toaster database, which by default | 154 | #. From the directory containing the Toaster database, which by default |
155 | is the :term:`Build Directory`, | 155 | is the :term:`Build Directory`, invoke the ``createsuperuser`` command from |
156 | invoke the ``createsuperuser`` command from ``manage.py``:: | 156 | ``manage.py``:: |
157 | 157 | ||
158 | $ cd ~/poky/build | 158 | $ cd poky/build |
159 | $ ../bitbake/lib/toaster/manage.py createsuperuser | 159 | $ ../bitbake/lib/toaster/manage.py createsuperuser |
160 | 160 | ||
161 | #. Django prompts you for the username, which you need to provide. | 161 | #. Django prompts you for the username, which you need to provide. |
@@ -179,7 +179,7 @@ example, if you are running Toaster locally, use the following URL:: | |||
179 | http://127.0.0.1:8000/admin | 179 | http://127.0.0.1:8000/admin |
180 | 180 | ||
181 | You can use the Django administration interface to set Toaster configuration | 181 | You can use the Django administration interface to set Toaster configuration |
182 | parameters such as the build directory, layer sources, default variable | 182 | parameters such as the :term:`Build Directory`, layer sources, default variable |
183 | values, and BitBake versions. | 183 | values, and BitBake versions. |
184 | 184 | ||
185 | Setting Up a Production Instance of Toaster | 185 | Setting Up a Production Instance of Toaster |
@@ -211,7 +211,7 @@ Be sure you meet the following requirements: | |||
211 | 211 | ||
212 | - If you are using Ubuntu, run the following:: | 212 | - If you are using Ubuntu, run the following:: |
213 | 213 | ||
214 | $ sudo apt-get install apache2 libapache2-mod-wsgi-py3 mysql-server python3-pip libmysqlclient-dev | 214 | $ sudo apt install apache2 libapache2-mod-wsgi-py3 mysql-server python3-pip libmysqlclient-dev |
215 | 215 | ||
216 | - If you are using Fedora or a RedHat distribution, run the | 216 | - If you are using Fedora or a RedHat distribution, run the |
217 | following:: | 217 | following:: |
@@ -239,7 +239,7 @@ Perform the following steps to install Toaster: | |||
239 | $ git clone git://git.yoctoproject.org/poky | 239 | $ git clone git://git.yoctoproject.org/poky |
240 | $ git checkout &DISTRO_NAME_NO_CAP; | 240 | $ git checkout &DISTRO_NAME_NO_CAP; |
241 | 241 | ||
242 | #. Install Toaster dependencies using the --user flag which keeps the | 242 | #. Install Toaster dependencies using the ``--user`` flag which keeps the |
243 | Python packages isolated from your system-provided packages:: | 243 | Python packages isolated from your system-provided packages:: |
244 | 244 | ||
245 | $ cd /var/www/toaster/ | 245 | $ cd /var/www/toaster/ |
@@ -311,14 +311,13 @@ Perform the following steps to install Toaster: | |||
311 | migrations). The next line sets the Toaster root directory | 311 | migrations). The next line sets the Toaster root directory |
312 | ``TOASTER_DIR`` and the location of the Toaster configuration file | 312 | ``TOASTER_DIR`` and the location of the Toaster configuration file |
313 | ``TOASTER_CONF``, which is relative to ``TOASTER_DIR``. The | 313 | ``TOASTER_CONF``, which is relative to ``TOASTER_DIR``. The |
314 | ``TEMPLATECONF`` value reflects the contents of | 314 | :term:`TEMPLATECONF` value reflects the contents of |
315 | ``poky/.templateconf``, and by default, should include the string | 315 | ``poky/.templateconf``, and by default, should include the string |
316 | "poky". For more information on the Toaster configuration file, see | 316 | "poky". For more information on the Toaster configuration file, see |
317 | the ":ref:`toaster-manual/reference:Configuring Toaster`" section. | 317 | the ":ref:`toaster-manual/reference:Configuring Toaster`" section. |
318 | 318 | ||
319 | This line also runs the ``checksettings`` command, which configures | 319 | This line also runs the ``checksettings`` command, which configures |
320 | the location of the Toaster :term:`Build Directory`. | 320 | the location of the Toaster :term:`Build Directory`. The Toaster |
321 | The Toaster | ||
322 | root directory ``TOASTER_DIR`` determines where the Toaster build | 321 | root directory ``TOASTER_DIR`` determines where the Toaster build |
323 | directory is created on the file system. In the example above, | 322 | directory is created on the file system. In the example above, |
324 | ``TOASTER_DIR`` is set as follows:: | 323 | ``TOASTER_DIR`` is set as follows:: |
@@ -326,7 +325,7 @@ Perform the following steps to install Toaster: | |||
326 | /var/www/toaster/poky | 325 | /var/www/toaster/poky |
327 | 326 | ||
328 | 327 | ||
329 | This setting causes the Toaster build directory to be:: | 328 | This setting causes the Toaster :term:`Build Directory` to be:: |
330 | 329 | ||
331 | /var/www/toaster/poky/build | 330 | /var/www/toaster/poky/build |
332 | 331 | ||
@@ -362,11 +361,11 @@ Perform the following steps to install Toaster: | |||
362 | 361 | ||
363 | /etc/httpd/conf.d/toaster.conf | 362 | /etc/httpd/conf.d/toaster.conf |
364 | 363 | ||
365 | If you are using OpenSUSE, put it here:: | 364 | If you are using openSUSE, put it here:: |
366 | 365 | ||
367 | /etc/apache2/conf.d/toaster.conf | 366 | /etc/apache2/conf.d/toaster.conf |
368 | 367 | ||
369 | Following is a sample Apache configuration for Toaster you can follow: | 368 | Here is a sample Apache configuration for Toaster you can follow: |
370 | 369 | ||
371 | .. code-block:: apache | 370 | .. code-block:: apache |
372 | 371 | ||
@@ -380,13 +379,13 @@ Perform the following steps to install Toaster: | |||
380 | Require all granted | 379 | Require all granted |
381 | </IfModule> | 380 | </IfModule> |
382 | </Directory> | 381 | </Directory> |
383 | 382 | ||
384 | <Directory /var/www/toaster/poky/bitbake/lib/toaster/toastermain> | 383 | <Directory /var/www/toaster/poky/bitbake/lib/toaster/toastermain> |
385 | <Files "wsgi.py"> | 384 | <Files "wsgi.py"> |
386 | Require all granted | 385 | Require all granted |
387 | </Files> | 386 | </Files> |
388 | </Directory> | 387 | </Directory> |
389 | 388 | ||
390 | WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/.local/lib/python3.4/site-packages | 389 | WSGIDaemonProcess toaster_wsgi python-path=/var/www/toaster/poky/bitbake/lib/toaster:/var/www/toaster/.local/lib/python3.4/site-packages |
391 | WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py" | 390 | WSGIScriptAlias / "/var/www/toaster/poky/bitbake/lib/toaster/toastermain/wsgi.py" |
392 | <Location /> | 391 | <Location /> |
@@ -402,7 +401,7 @@ Perform the following steps to install Toaster: | |||
402 | $ chmod +x bitbake/lib/toaster/toastermain/wsgi.py | 401 | $ chmod +x bitbake/lib/toaster/toastermain/wsgi.py |
403 | 402 | ||
404 | Finally, restart Apache to make sure all new configuration is loaded. For Ubuntu, | 403 | Finally, restart Apache to make sure all new configuration is loaded. For Ubuntu, |
405 | Debian, and OpenSUSE use:: | 404 | Debian, and openSUSE use:: |
406 | 405 | ||
407 | $ sudo service apache2 restart | 406 | $ sudo service apache2 restart |
408 | 407 | ||
@@ -417,13 +416,13 @@ Perform the following steps to install Toaster: | |||
417 | 416 | ||
418 | [Unit] | 417 | [Unit] |
419 | Description=Toaster runbuilds | 418 | Description=Toaster runbuilds |
420 | 419 | ||
421 | [Service] | 420 | [Service] |
422 | Type=forking User=toaster | 421 | Type=forking User=toaster |
423 | ExecStart=/usr/bin/screen -d -m -S runbuilds /var/www/toaster/poky/bitbake/lib/toaster/runbuilds-service.sh start | 422 | ExecStart=/usr/bin/screen -d -m -S runbuilds /var/www/toaster/poky/bitbake/lib/toaster/runbuilds-service.sh start |
424 | ExecStop=/usr/bin/screen -S runbuilds -X quit | 423 | ExecStop=/usr/bin/screen -S runbuilds -X quit |
425 | WorkingDirectory=/var/www/toaster/poky | 424 | WorkingDirectory=/var/www/toaster/poky |
426 | 425 | ||
427 | [Install] | 426 | [Install] |
428 | WantedBy=multi-user.target | 427 | WantedBy=multi-user.target |
429 | 428 | ||
@@ -433,11 +432,11 @@ Perform the following steps to install Toaster: | |||
433 | up executable permissions:: | 432 | up executable permissions:: |
434 | 433 | ||
435 | #!/bin/bash | 434 | #!/bin/bash |
436 | 435 | ||
437 | #export http_proxy=http://proxy.host.com:8080 | 436 | #export http_proxy=http://proxy.host.com:8080 |
438 | #export https_proxy=http://proxy.host.com:8080 | 437 | #export https_proxy=http://proxy.host.com:8080 |
439 | #export GIT_PROXY_COMMAND=$HOME/bin/gitproxy | 438 | #export GIT_PROXY_COMMAND=$HOME/bin/gitproxy |
440 | cd ~/poky/ | 439 | cd poky/ |
441 | source ./oe-init-build-env build | 440 | source ./oe-init-build-env build |
442 | source ../bitbake/bin/toaster $1 noweb | 441 | source ../bitbake/bin/toaster $1 noweb |
443 | [ "$1" == 'start' ] && /bin/bash | 442 | [ "$1" == 'start' ] && /bin/bash |
@@ -496,7 +495,7 @@ The Toaster web interface allows you to do the following: | |||
496 | Toaster Web Interface Videos | 495 | Toaster Web Interface Videos |
497 | ---------------------------- | 496 | ---------------------------- |
498 | 497 | ||
499 | Following are several videos that show how to use the Toaster GUI: | 498 | Here are several videos that show how to use the Toaster GUI: |
500 | 499 | ||
501 | - *Build Configuration:* This | 500 | - *Build Configuration:* This |
502 | `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and | 501 | `video <https://www.youtube.com/watch?v=qYgDZ8YzV6w>`__ overviews and |
@@ -625,7 +624,7 @@ To specify ``bash`` 3.2.48 as the version to build, enter | |||
625 | :scale: 75% | 624 | :scale: 75% |
626 | 625 | ||
627 | After clicking the "Add variable" button, the settings for | 626 | After clicking the "Add variable" button, the settings for |
628 | ``PREFERRED_VERSION`` are added to the bottom of the BitBake variables | 627 | :term:`PREFERRED_VERSION` are added to the bottom of the BitBake variables |
629 | list. With these settings, the OpenEmbedded build system builds the | 628 | list. With these settings, the OpenEmbedded build system builds the |
630 | desired version of the recipe rather than the default version: | 629 | desired version of the recipe rather than the default version: |
631 | 630 | ||
diff --git a/documentation/toaster-manual/start.rst b/documentation/toaster-manual/start.rst index c687a82531..2d6474852a 100644 --- a/documentation/toaster-manual/start.rst +++ b/documentation/toaster-manual/start.rst | |||
@@ -18,7 +18,7 @@ to run the Yocto Project. To do this, follow the instructions in the | |||
18 | the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might | 18 | the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might |
19 | also need to do an additional install of pip3. :: | 19 | also need to do an additional install of pip3. :: |
20 | 20 | ||
21 | $ sudo apt-get install python3-pip | 21 | $ sudo apt install python3-pip |
22 | 22 | ||
23 | Establishing Toaster System Dependencies | 23 | Establishing Toaster System Dependencies |
24 | ======================================== | 24 | ======================================== |
@@ -40,7 +40,7 @@ command:: | |||
40 | $ pip3 install --user -r bitbake/toaster-requirements.txt | 40 | $ pip3 install --user -r bitbake/toaster-requirements.txt |
41 | 41 | ||
42 | The previous command installs the necessary Toaster modules into a local | 42 | The previous command installs the necessary Toaster modules into a local |
43 | python 3 cache in your ``$HOME`` directory. The caches is actually | 43 | Python 3 cache in your ``$HOME`` directory. The caches is actually |
44 | located in ``$HOME/.local``. To see what packages have been installed | 44 | located in ``$HOME/.local``. To see what packages have been installed |
45 | into your ``$HOME`` directory, do the following:: | 45 | into your ``$HOME`` directory, do the following:: |
46 | 46 | ||