diff options
Diffstat (limited to 'poky/documentation/toaster-manual')
-rw-r--r-- | poky/documentation/toaster-manual/index.rst (renamed from poky/documentation/toaster-manual/toaster-manual.rst) | 8 | ||||
-rw-r--r-- | poky/documentation/toaster-manual/intro.rst (renamed from poky/documentation/toaster-manual/toaster-manual-intro.rst) | 2 | ||||
-rw-r--r-- | poky/documentation/toaster-manual/reference.rst (renamed from poky/documentation/toaster-manual/toaster-manual-reference.rst) | 27 | ||||
-rw-r--r-- | poky/documentation/toaster-manual/setup-and-use.rst (renamed from poky/documentation/toaster-manual/toaster-manual-setup-and-use.rst) | 14 | ||||
-rw-r--r-- | poky/documentation/toaster-manual/start.rst (renamed from poky/documentation/toaster-manual/toaster-manual-start.rst) | 2 |
5 files changed, 25 insertions, 28 deletions
diff --git a/poky/documentation/toaster-manual/toaster-manual.rst b/poky/documentation/toaster-manual/index.rst index b003f1cea..f13ba7b8a 100644 --- a/poky/documentation/toaster-manual/toaster-manual.rst +++ b/poky/documentation/toaster-manual/index.rst @@ -10,10 +10,10 @@ Toaster User Manual :caption: Table of Contents :numbered: - toaster-manual-intro - toaster-manual-start - toaster-manual-setup-and-use - toaster-manual-reference + intro + start + setup-and-use + reference history .. include:: /boilerplate.rst diff --git a/poky/documentation/toaster-manual/toaster-manual-intro.rst b/poky/documentation/toaster-manual/intro.rst index e34e7bac4..c78b3f53d 100644 --- a/poky/documentation/toaster-manual/toaster-manual-intro.rst +++ b/poky/documentation/toaster-manual/intro.rst @@ -25,7 +25,7 @@ extensive information about the build process. interface, you can: - Browse layers listed in the various - :ref:`layer sources <toaster-manual/toaster-manual-reference:layer source>` + :ref:`layer sources <toaster-manual/reference:layer source>` that are available in your project (e.g. the OpenEmbedded Layer Index at http://layers.openembedded.org/layerindex/). diff --git a/poky/documentation/toaster-manual/toaster-manual-reference.rst b/poky/documentation/toaster-manual/reference.rst index 2202d599f..dfe51889e 100644 --- a/poky/documentation/toaster-manual/toaster-manual-reference.rst +++ b/poky/documentation/toaster-manual/reference.rst @@ -25,8 +25,7 @@ A layer index is a web application that contains information about a set of custom layers. A good example of an existing layer index is the OpenEmbedded Layer Index. A public instance of this layer index exists at http://layers.openembedded.org. You can find the code for this -layer index's web application at -http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/. +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 @@ -66,9 +65,9 @@ set up the code for the web application that "hooks" into your set of layers. For general information on layers, see the -":ref:`overview-manual/overview-manual-yp-intro:the yocto project layer model`" +":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/dev-manual-common-tasks:understanding and creating layers`" +to create layers, see the ":ref:`dev-manual/common-tasks:understanding and creating layers`" section in the Yocto Project Development Tasks Manual. Configuring Toaster to Hook Into Your Layer Index @@ -83,9 +82,8 @@ index. In the previous section, the code for the OpenEmbedded Metadata Index (i.e. http://layers.openembedded.org) was referenced. You can use -this code, which is at -http://git.yoctoproject.org/cgit/cgit.cgi/layerindex-web/, as a -base to create your own layer index. +this code, which is at :yocto_git:`/layerindex-web/`, as a base to create +your own layer index. Use the Administration Interface ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ @@ -165,14 +163,13 @@ As shipped, Toaster is configured to work with the following releases: - *Yocto Project &DISTRO; "&DISTRO_NAME;" or OpenEmbedded "&DISTRO_NAME;":* This release causes your Toaster projects to build against the head of the &DISTRO_NAME_NO_CAP; branch at - https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/?h=&DISTRO_NAME_NO_CAP; or - http://git.openembedded.org/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;. + :yocto_git:`/poky/log/?h=&DISTRO_NAME_NO_CAP;` or + :oe_git:`/openembedded-core/commit/?h=&DISTRO_NAME_NO_CAP;`. - *Yocto Project "Master" or OpenEmbedded "Master":* This release causes your Toaster Projects to build against the head of the master branch, which is where active development takes place, at - https://git.yoctoproject.org/cgit/cgit.cgi/poky/log/ or - http://git.openembedded.org/openembedded-core/log/. + :yocto_git:`/poky/log/` or :oe_git:`/openembedded-core/log/`. - *Local Yocto Project or Local OpenEmbedded:* This release causes your Toaster Projects to build against the head of the ``poky`` or @@ -479,7 +476,7 @@ get the status of a specific build, use the following call:: Be sure to provide values for host, port, and ID. You can find the value for ID from the Builds -Completed query. See the ":ref:`toaster-manual/toaster-manual-reference:checking status of builds completed`" +Completed query. See the ":ref:`toaster-manual/reference:checking status of builds completed`" section for more information. The output is a JSON file that itemizes the specific build and includes @@ -552,7 +549,7 @@ database. You need to run the ``buildslist`` command first to identify existing builds in the database before using the -:ref:`toaster-manual/toaster-manual-reference:\`\`builddelete\`\`` command. Here is an +:ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an example that assumes default repository and build directory names: .. code-block:: shell @@ -561,7 +558,7 @@ example that assumes default repository and build directory names: $ python ../bitbake/lib/toaster/manage.py buildslist If your Toaster database had only one build, the above -:ref:`toaster-manual/toaster-manual-reference:\`\`buildslist\`\`` +:ref:`toaster-manual/reference:\`\`buildslist\`\`` command would return something like the following:: 1: qemux86 poky core-image-minimal @@ -582,7 +579,7 @@ the database. Prior to running the ``builddelete`` command, you need to get the ID associated with builds by using the -:ref:`toaster-manual/toaster-manual-reference:\`\`buildslist\`\`` command. +:ref:`toaster-manual/reference:\`\`buildslist\`\`` command. ``perf`` -------- diff --git a/poky/documentation/toaster-manual/toaster-manual-setup-and-use.rst b/poky/documentation/toaster-manual/setup-and-use.rst index b73caac37..2cb7884eb 100644 --- a/poky/documentation/toaster-manual/toaster-manual-setup-and-use.rst +++ b/poky/documentation/toaster-manual/setup-and-use.rst @@ -10,7 +10,7 @@ Starting Toaster for Local Development ====================================== Once you have set up the Yocto Project and installed the Toaster system -dependencies as described in the ":ref:`toaster-manual/toaster-manual-start:Preparing to Use +dependencies as described in the ":ref:`toaster-manual/start:Preparing to Use Toaster`" chapter, you are ready to start Toaster. @@ -30,7 +30,7 @@ Next, from the build directory (e.g. You can now run your builds from the command line, or with Toaster as explained in section -":ref:`toaster-manual/toaster-manual-setup-and-use:using the toaster web interface`". +":ref:`toaster-manual/setup-and-use:using the toaster web interface`". To access the Toaster web interface, open your favorite browser and enter the following:: @@ -200,7 +200,7 @@ Be sure you meet the following requirements: You must comply with all Apache, ``mod-wsgi``, and Mysql requirements. -- Have all the build requirements as described in the ":ref:`toaster-manual/toaster-manual-start:Preparing to +- Have all the build requirements as described in the ":ref:`toaster-manual/start:Preparing to Use Toaster`" chapter. - Have an Apache webserver. @@ -314,7 +314,7 @@ Perform the following steps to install Toaster: ``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/toaster-manual-reference:Configuring Toaster`" section. + 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`. @@ -544,7 +544,7 @@ Additional Information About the Local Yocto Project Release This section only applies if you have set up Toaster for local development, as explained in the -":ref:`toaster-manual/toaster-manual-setup-and-use:starting toaster for local development`" +":ref:`toaster-manual/setup-and-use:starting toaster for local development`" section. When you create a project in Toaster, you will be asked to provide a @@ -561,8 +561,8 @@ the same clone you are using to run Toaster. Unless you manually update this clone, your builds will always use the same Git revision. If you select any of the other release options, Toaster will fetch the -tip of your selected release from the upstream `Yocto Project -repository <https://git.yoctoproject.org>`__ every time you run a build. +tip of your selected release from the upstream :yocto_git:`Yocto Project +repository <>` every time you run a build. Fetching this tip effectively means that if your selected release is updated upstream, the Git revision you are using for your builds will change. If you are doing development locally, you might not want this diff --git a/poky/documentation/toaster-manual/toaster-manual-start.rst b/poky/documentation/toaster-manual/start.rst index 888337416..c687a8253 100644 --- a/poky/documentation/toaster-manual/toaster-manual-start.rst +++ b/poky/documentation/toaster-manual/start.rst @@ -14,7 +14,7 @@ Setting Up the Basic System Requirements Before you can use Toaster, you need to first set up your build system to run the Yocto Project. To do this, follow the instructions in the -":ref:`dev-manual/dev-manual-start:preparing the build host`" section of +":ref:`dev-manual/start:preparing the build host`" section of the Yocto Project Development Tasks Manual. For Ubuntu/Debian, you might also need to do an additional install of pip3. :: |