summaryrefslogtreecommitdiffstats
path: root/documentation/toaster-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-10-27 15:09:08 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-10-28 15:48:03 +0100
commitb44fbe5b1b425b8a8c23e4f0ba80583944ab303a (patch)
tree5e1787b385f95ffaf7fa2cf5507ff2a91ef39d07 /documentation/toaster-manual
parent50458d923826ae96deaf799fa7ee1e0584cb57ff (diff)
downloadpoky-b44fbe5b1b425b8a8c23e4f0ba80583944ab303a.tar.gz
manuals: use references to the "Build Directory" term
Replace instances of "Build Directory" and "build directory" (when applicable) by :term:`Build Directory` as already done in most places. Doing this, fix the indentation of the paragraphs with this term. (From yocto-docs rev: dce50679242d39f133e0cde5c8483b5e69f3eb54) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/toaster-manual')
-rw-r--r--documentation/toaster-manual/reference.rst11
-rw-r--r--documentation/toaster-manual/setup-and-use.rst19
2 files changed, 14 insertions, 16 deletions
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst
index 1bb9f98cca..b181d12d86 100644
--- a/documentation/toaster-manual/reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -522,14 +522,13 @@ tasks. You can locate these commands in the
522 522
523 - When using ``manage.py`` commands given a default configuration, 523 - When using ``manage.py`` commands given a default configuration,
524 you must be sure that your working directory is set to the 524 you must be sure that your working directory is set to the
525 :term:`Build Directory`. Using 525 :term:`Build Directory`. Using ``manage.py`` commands from the
526 ``manage.py`` commands from the Build Directory allows Toaster to 526 :term:`Build Directory` allows Toaster to find the ``toaster.sqlite``
527 find the ``toaster.sqlite`` file, which is located in the Build 527 file, which is located in the :term:`Build Directory`.
528 Directory.
529 528
530 - For non-default database configurations, it is possible that you 529 - For non-default database configurations, it is possible that you
531 can use ``manage.py`` commands from a directory other than the 530 can use ``manage.py`` commands from a directory other than the
532 Build Directory. To do so, the ``toastermain/settings.py`` file 531 :term:`Build Directory`. To do so, the ``toastermain/settings.py`` file
533 must be configured to point to the correct database backend. 532 must be configured to point to the correct database backend.
534 533
535``buildslist`` 534``buildslist``
@@ -549,7 +548,7 @@ database.
549You need to run the ``buildslist`` command first to identify existing 548You need to run the ``buildslist`` command first to identify existing
550builds in the database before using the 549builds in the database before using the
551:ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an 550:ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an
552example that assumes default repository and build directory names: 551example that assumes default repository and :term:`Build Directory` names:
553 552
554.. code-block:: shell 553.. code-block:: shell
555 554
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst
index 72a15b5f2d..c5521edda1 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
26Next, from the build directory (e.g. 26Next, from the :term:`Build Directory` (e.g. ``poky/build``), start Toaster
27``poky/build``), start Toaster using this command:: 27using 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``.
124The Build Directory 124The Build Directory
125=================== 125===================
126 126
127Toaster creates a build directory within your Source Directory (e.g. 127Toaster 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
130Alternatively, if you would like all of your Toaster related files and 130Alternatively, if you would like all of your Toaster related files and
131directories to be in a particular location, you can set the 131directories 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
133current working directory. Setting this environment variable causes 133current working directory. Setting this environment variable causes
134Toaster to use ``$TOASTER_DIR/build`` as the build directory. 134Toaster to use ``$TOASTER_DIR/build`` as the :term:`Build Directory`.
135 135
136Creating a Django Superuser 136Creating a Django Superuser
137=========================== 137===========================
@@ -152,8 +152,8 @@ 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
@@ -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
181You can use the Django administration interface to set Toaster configuration 181You can use the Django administration interface to set Toaster configuration
182parameters such as the build directory, layer sources, default variable 182parameters such as the :term:`Build Directory`, layer sources, default variable
183values, and BitBake versions. 183values, and BitBake versions.
184 184
185Setting Up a Production Instance of Toaster 185Setting Up a Production Instance of Toaster
@@ -317,8 +317,7 @@ Perform the following steps to install Toaster:
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