diff options
Diffstat (limited to 'documentation/toaster-manual/setup-and-use.rst')
| -rw-r--r-- | documentation/toaster-manual/setup-and-use.rst | 31 |
1 files changed, 15 insertions, 16 deletions
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst index 8f0ec94496..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:: $ source oe-init-build-env -Next, from the build directory (e.g. -``poky/build``), start Toaster using this command:: +Next, from the :term:`Build Directory` (e.g. ``poky/build``), start Toaster +using this command:: $ source toaster start @@ -124,14 +124,14 @@ causes Toaster to create and use ``$TOASTER_DIR./_toaster_clones``. The Build Directory =================== -Toaster creates a build directory within your Source Directory (e.g. +Toaster creates a :term:`Build Directory` within your Source Directory (e.g. ``poky``) to execute the builds. Alternatively, if you would like all of your Toaster related files and directories to be in a particular location, you can set the ``TOASTER_DIR`` environment variable, which takes precedence over your current working directory. Setting this environment variable causes -Toaster to use ``$TOASTER_DIR/build`` as the build directory. +Toaster to use ``$TOASTER_DIR/build`` as the :term:`Build Directory`. Creating a Django Superuser =========================== @@ -152,8 +152,8 @@ superuser by following these steps: $ export PATH=$PATH:$HOME/.local/bin #. From the directory containing the Toaster database, which by default - is the :term:`Build Directory`, - invoke the ``createsuperuser`` command from ``manage.py``:: + is the :term:`Build Directory`, invoke the ``createsuperuser`` command from + ``manage.py``:: $ cd poky/build $ ../bitbake/lib/toaster/manage.py createsuperuser @@ -179,7 +179,7 @@ example, if you are running Toaster locally, use the following URL:: http://127.0.0.1:8000/admin You can use the Django administration interface to set Toaster configuration -parameters such as the build directory, layer sources, default variable +parameters such as the :term:`Build Directory`, layer sources, default variable values, and BitBake versions. Setting Up a Production Instance of Toaster @@ -211,7 +211,7 @@ Be sure you meet the following requirements: - If you are using Ubuntu, run the following:: - $ sudo apt-get install apache2 libapache2-mod-wsgi-py3 mysql-server python3-pip libmysqlclient-dev + $ sudo apt install apache2 libapache2-mod-wsgi-py3 mysql-server python3-pip libmysqlclient-dev - If you are using Fedora or a RedHat distribution, run the following:: @@ -239,7 +239,7 @@ Perform the following steps to install Toaster: $ git clone git://git.yoctoproject.org/poky $ git checkout &DISTRO_NAME_NO_CAP; -#. Install Toaster dependencies using the --user flag which keeps the +#. Install Toaster dependencies using the ``--user`` flag which keeps the Python packages isolated from your system-provided packages:: $ cd /var/www/toaster/ @@ -311,14 +311,13 @@ Perform the following steps to install Toaster: migrations). The next line sets the Toaster root directory ``TOASTER_DIR`` and the location of the Toaster configuration file ``TOASTER_CONF``, which is relative to ``TOASTER_DIR``. The - ``TEMPLATECONF`` value reflects the contents of + :term:`TEMPLATECONF` value reflects the contents of ``poky/.templateconf``, and by default, should include the string "poky". For more information on the Toaster configuration file, see the ":ref:`toaster-manual/reference:Configuring Toaster`" section. This line also runs the ``checksettings`` command, which configures - the location of the Toaster :term:`Build Directory`. - The Toaster + the location of the Toaster :term:`Build Directory`. The Toaster root directory ``TOASTER_DIR`` determines where the Toaster build directory is created on the file system. In the example above, ``TOASTER_DIR`` is set as follows:: @@ -326,7 +325,7 @@ Perform the following steps to install Toaster: /var/www/toaster/poky - This setting causes the Toaster build directory to be:: + This setting causes the Toaster :term:`Build Directory` to be:: /var/www/toaster/poky/build @@ -366,7 +365,7 @@ Perform the following steps to install Toaster: /etc/apache2/conf.d/toaster.conf - Following is a sample Apache configuration for Toaster you can follow: + Here is a sample Apache configuration for Toaster you can follow: .. code-block:: apache @@ -496,7 +495,7 @@ The Toaster web interface allows you to do the following: Toaster Web Interface Videos ---------------------------- -Following are several videos that show how to use the Toaster GUI: +Here are several videos that show how to use the Toaster GUI: - *Build Configuration:* This `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 :scale: 75% After clicking the "Add variable" button, the settings for -``PREFERRED_VERSION`` are added to the bottom of the BitBake variables +:term:`PREFERRED_VERSION` are added to the bottom of the BitBake variables list. With these settings, the OpenEmbedded build system builds the desired version of the recipe rather than the default version: |