diff options
Diffstat (limited to 'documentation/toaster-manual/reference.rst')
| -rw-r--r-- | documentation/toaster-manual/reference.rst | 42 |
1 files changed, 20 insertions, 22 deletions
diff --git a/documentation/toaster-manual/reference.rst b/documentation/toaster-manual/reference.rst index 988a262188..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 final chapter provides conceptual information on layer sources, releases, and JSON configuration files. Also provided is a quick look at some useful ``manage.py`` commands that are Toaster-specific. -Information on ``manage.py`` commands does exist across the Web and the -information in this manual by no means attempts to provide a command +Information on ``manage.py`` commands is available across the Web and +this manual by no means attempts to provide a command comprehensive reference. Layer Source @@ -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. @@ -296,7 +295,7 @@ The following defines the releases when you create a new project: <field type="CharField" name="description">Yocto Project &DISTRO; "&DISTRO_NAME;"</field> <field rel="ManyToOneRel" to="orm.bitbakeversion" name="bitbake_version">1</field> <field type="CharField" name="branch_name">&DISTRO_NAME_NO_CAP;</field> - <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> + <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> </object> The "pk" value must match the above respective BitBake version record. @@ -333,9 +332,9 @@ that includes the layer. In general all releases include the layer. <field type="CharField" name="name">openembedded-core</field> <field type="CharField" name="layer_index_url"></field> <field type="CharField" name="vcs_url">git://git.yoctoproject.org/poky</field> - <field type="CharField" name="vcs_web_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky</field> - <field type="CharField" name="vcs_web_tree_base_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field> - <field type="CharField" name="vcs_web_file_base_url">http://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field> + <field type="CharField" name="vcs_web_url">https://git.yoctoproject.org/cgit/cgit.cgi/poky</field> + <field type="CharField" name="vcs_web_tree_base_url">https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field> + <field type="CharField" name="vcs_web_file_base_url">https://git.yoctoproject.org/cgit/cgit.cgi/poky/tree/%path%?h=%branch%</field> </object> <object model="orm.layer_version" pk="1"> <field rel="ManyToOneRel" to="orm.layer" name="layer">1</field> @@ -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 @@ -508,7 +507,7 @@ Useful Commands =============== In addition to the web user interface and the scripts that start and -stop Toaster, command-line commands exist through the ``manage.py`` +stop Toaster, command-line commands are available through the ``manage.py`` management script. You can find general documentation on ``manage.py`` at the `Django <https://docs.djangoproject.com/en/2.2/topics/settings/>`__ @@ -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 |