diff options
Diffstat (limited to 'documentation/toaster-manual')
| -rw-r--r-- | documentation/toaster-manual/intro.rst | 7 | ||||
| -rw-r--r-- | documentation/toaster-manual/reference.rst | 28 | ||||
| -rw-r--r-- | documentation/toaster-manual/setup-and-use.rst | 27 | ||||
| -rw-r--r-- | documentation/toaster-manual/start.rst | 2 |
4 files changed, 31 insertions, 33 deletions
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. - See performance information such as build time, task time, CPU usage, and disk I/O. -For an overview of Toaster shipped with the Yocto Project &DISTRO; -Release, see the "`Toaster - Yocto Project -2.2 <https://youtu.be/BlXdOYLgPxA>`__" video. +For an overview of Toaster, see this +`introduction video <https://youtu.be/BlXdOYLgPxA>`__. Installation Options ==================== @@ -92,6 +91,7 @@ suited for a single user developing on a single build host. .. image:: figures/simple-configuration.png :align: center + :width: 70% Toaster as a hosted service is suited for multiple users developing 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: .. image:: figures/hosted-service.png :align: center + :width: 50% diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst index 1bb9f98cca..755b895cee 100644 --- a/documentation/toaster-manual/reference.rst +++ b/documentation/toaster-manual/reference.rst @@ -28,8 +28,7 @@ at :oe_layerindex:`/`. You can find the code for this layer index's web application at :yocto_git:`/layerindex-web/`. When you tie a layer source into Toaster, it can query the layer source -through a -`REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__ +through a :wikipedia:`REST <Representational_state_transfer>` API, store the information about the layers in the Toaster database, and then show the information to users. Users are then able to view that information and build layers from Toaster itself without having to @@ -66,7 +65,7 @@ layers. For general information on layers, see the ":ref:`overview-manual/yp-intro:the yocto project layer model`" section in the Yocto Project Overview and Concepts Manual. For information on how -to create layers, see the ":ref:`dev-manual/common-tasks:understanding and creating layers`" +to create layers, see the ":ref:`dev-manual/layers:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. Configuring Toaster to Hook Into Your Layer Index @@ -189,17 +188,17 @@ The ``bldcontrol/management/commands/checksettings.py`` file controls workflow configuration. Here is the process to initially populate this database. -1. The default project settings are set from +#. The default project settings are set from ``orm/fixtures/settings.xml``. -2. The default project distro and layers are added from +#. The default project distro and layers are added from ``orm/fixtures/poky.xml`` if poky is installed. If poky is not installed, they are added from ``orm/fixtures/oe-core.xml``. -3. If the ``orm/fixtures/custom.xml`` file exists, then its values are +#. If the ``orm/fixtures/custom.xml`` file exists, then its values are added. -4. The layer index is then scanned and added to the database. +#. The layer index is then scanned and added to the database. Once these steps complete, Toaster is set up and ready to use. @@ -369,8 +368,8 @@ Remote Toaster Monitoring Toaster has an API that allows remote management applications to directly query the state of the Toaster server and its builds in a machine-to-machine manner. This API uses the -`REST <https://en.wikipedia.org/wiki/Representational_state_transfer>`__ -interface and the transfer of JSON files. For example, you might monitor +:wikipedia:`REST <Representational_state_transfer>` interface and the +transfer of JSON files. For example, you might monitor a build inside a container through well supported known HTTP ports in order to easily access a Toaster server inside the container. In this example, when you use this direct JSON API, you avoid having web page @@ -522,14 +521,13 @@ tasks. You can locate these commands in the - When using ``manage.py`` commands given a default configuration, you must be sure that your working directory is set to the - :term:`Build Directory`. Using - ``manage.py`` commands from the Build Directory allows Toaster to - find the ``toaster.sqlite`` file, which is located in the Build - Directory. + :term:`Build Directory`. Using ``manage.py`` commands from the + :term:`Build Directory` allows Toaster to find the ``toaster.sqlite`` + file, which is located in the :term:`Build Directory`. - For non-default database configurations, it is possible that you can use ``manage.py`` commands from a directory other than the - Build Directory. To do so, the ``toastermain/settings.py`` file + :term:`Build Directory`. To do so, the ``toastermain/settings.py`` file must be configured to point to the correct database backend. ``buildslist`` @@ -549,7 +547,7 @@ database. You need to run the ``buildslist`` command first to identify existing builds in the database before using the :ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an -example that assumes default repository and build directory names: +example that assumes default repository and :term:`Build Directory` names: .. code-block:: shell diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst index 0da8326926..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 @@ -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 diff --git a/documentation/toaster-manual/start.rst b/documentation/toaster-manual/start.rst index cab5d1f673..2d6474852a 100644 --- a/documentation/toaster-manual/start.rst +++ b/documentation/toaster-manual/start.rst @@ -40,7 +40,7 @@ command:: $ pip3 install --user -r bitbake/toaster-requirements.txt The previous command installs the necessary Toaster modules into a local -python 3 cache in your ``$HOME`` directory. The caches is actually +Python 3 cache in your ``$HOME`` directory. The caches is actually located in ``$HOME/.local``. To see what packages have been installed into your ``$HOME`` directory, do the following:: |