summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-12-03 22:38:37 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-12-09 12:21:27 +0000
commitc684a7a6d50754d577e0ff68a6fb6ed493b8f93e (patch)
tree7af73c545d6a28d12645a60e85c2b184283f41b3
parent9e35603c1244777e278f57c9634d1a5727cf799f (diff)
downloadpoky-c684a7a6d50754d577e0ff68a6fb6ed493b8f93e.tar.gz
poky-c684a7a6d50754d577e0ff68a6fb6ed493b8f93e.tar.bz2
poky-c684a7a6d50754d577e0ff68a6fb6ed493b8f93e.zip
toaster-manual: remove 'toaster-manual' from filenames
All filenames duplicate the 'manual name', which is not needed, and make all references longer than they should. Rename all files to be as consise as possible, and fix all references (From yocto-docs rev: b5a1a504caf7ffcaeca787b38bf7f11e341dfb0f) Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-start.rst6
-rw-r--r--documentation/ref-manual/migration-2.1.rst2
-rw-r--r--documentation/toaster-manual/index.rst8
-rw-r--r--documentation/toaster-manual/intro.rst (renamed from documentation/toaster-manual/toaster-manual-intro.rst)2
-rw-r--r--documentation/toaster-manual/reference.rst (renamed from documentation/toaster-manual/toaster-manual-reference.rst)8
-rw-r--r--documentation/toaster-manual/setup-and-use.rst (renamed from documentation/toaster-manual/toaster-manual-setup-and-use.rst)10
-rw-r--r--documentation/toaster-manual/start.rst (renamed from documentation/toaster-manual/toaster-manual-start.rst)0
7 files changed, 18 insertions, 18 deletions
diff --git a/documentation/dev-manual/dev-manual-start.rst b/documentation/dev-manual/dev-manual-start.rst
index d4727a6f6f..75b5d7b5f0 100644
--- a/documentation/dev-manual/dev-manual-start.rst
+++ b/documentation/dev-manual/dev-manual-start.rst
@@ -345,7 +345,7 @@ section. If you are going
to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
Project Application Development and the Extensible Software Development
Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use
-Toaster, see the ":doc:`/toaster-manual/toaster-manual-setup-and-use`"
+Toaster, see the ":doc:`/toaster-manual/setup-and-use`"
section in the Toaster User Manual.
Setting Up to Use CROss PlatformS (CROPS)
@@ -445,7 +445,7 @@ section. If you are going to use the Extensible SDK container, see the
":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
Project Application Development and the Extensible Software Development
Kit (eSDK) manual. If you are going to use the Toaster container, see
-the ":doc:`/toaster-manual/toaster-manual-setup-and-use`"
+the ":doc:`/toaster-manual/setup-and-use`"
section in the Toaster User Manual.
Setting Up to Use Windows Subsystem For Linux (WSLv2)
@@ -560,7 +560,7 @@ you were running on a native Linux machine. If you are going to use the
Extensible SDK container, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
Project Application Development and the Extensible Software Development
Kit (eSDK) manual. If you are going to use the Toaster container, see
-the ":doc:`/toaster-manual/toaster-manual-setup-and-use`"
+the ":doc:`/toaster-manual/setup-and-use`"
section in the Toaster User Manual.
Locating Yocto Project Source Files
diff --git a/documentation/ref-manual/migration-2.1.rst b/documentation/ref-manual/migration-2.1.rst
index 25ee21499c..ada9d2986c 100644
--- a/documentation/ref-manual/migration-2.1.rst
+++ b/documentation/ref-manual/migration-2.1.rst
@@ -217,7 +217,7 @@ The following changes have been made to the build system user interface:
- *Hob GTK+-based UI*: Removed because it is unmaintained and based on
the outdated GTK+ 2 library. The Toaster web-based UI is much more
capable and is actively maintained. See the
- ":ref:`toaster-manual/toaster-manual-setup-and-use:using the toaster web interface`"
+ ":ref:`toaster-manual/setup-and-use:using the toaster web interface`"
section in the Toaster User Manual for more information on this
interface.
diff --git a/documentation/toaster-manual/index.rst b/documentation/toaster-manual/index.rst
index b003f1ceaa..f13ba7b8a1 100644
--- a/documentation/toaster-manual/index.rst
+++ b/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/documentation/toaster-manual/toaster-manual-intro.rst b/documentation/toaster-manual/intro.rst
index e34e7bac44..c78b3f53da 100644
--- a/documentation/toaster-manual/toaster-manual-intro.rst
+++ b/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/documentation/toaster-manual/toaster-manual-reference.rst b/documentation/toaster-manual/reference.rst
index ed0bad11b7..c3f0fef0a2 100644
--- a/documentation/toaster-manual/toaster-manual-reference.rst
+++ b/documentation/toaster-manual/reference.rst
@@ -476,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
@@ -549,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
@@ -558,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
@@ -579,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/documentation/toaster-manual/toaster-manual-setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst
index 6e2ba02531..2cb7884eb9 100644
--- a/documentation/toaster-manual/toaster-manual-setup-and-use.rst
+++ b/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
diff --git a/documentation/toaster-manual/toaster-manual-start.rst b/documentation/toaster-manual/start.rst
index 8883374164..8883374164 100644
--- a/documentation/toaster-manual/toaster-manual-start.rst
+++ b/documentation/toaster-manual/start.rst