summaryrefslogtreecommitdiffstats
path: root/documentation
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 /documentation
parent9e35603c1244777e278f57c9634d1a5727cf799f (diff)
downloadpoky-c684a7a6d50754d577e0ff68a6fb6ed493b8f93e.tar.gz
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>
Diffstat (limited to 'documentation')
-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
345to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto 345to use the Extensible SDK, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
346Project Application Development and the Extensible Software Development 346Project Application Development and the Extensible Software Development
347Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use 347Kit (eSDK) manual. If you want to work on the kernel, see the :doc:`/kernel-dev/index`. If you are going to use
348Toaster, see the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" 348Toaster, see the ":doc:`/toaster-manual/setup-and-use`"
349section in the Toaster User Manual. 349section in the Toaster User Manual.
350 350
351Setting Up to Use CROss PlatformS (CROPS) 351Setting Up to Use CROss PlatformS (CROPS)
@@ -445,7 +445,7 @@ section. If you are going to use the Extensible SDK container, see the
445":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto 445":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
446Project Application Development and the Extensible Software Development 446Project Application Development and the Extensible Software Development
447Kit (eSDK) manual. If you are going to use the Toaster container, see 447Kit (eSDK) manual. If you are going to use the Toaster container, see
448the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" 448the ":doc:`/toaster-manual/setup-and-use`"
449section in the Toaster User Manual. 449section in the Toaster User Manual.
450 450
451Setting Up to Use Windows Subsystem For Linux (WSLv2) 451Setting 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
560Extensible SDK container, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto 560Extensible SDK container, see the ":doc:`/sdk-manual/sdk-extensible`" Chapter in the Yocto
561Project Application Development and the Extensible Software Development 561Project Application Development and the Extensible Software Development
562Kit (eSDK) manual. If you are going to use the Toaster container, see 562Kit (eSDK) manual. If you are going to use the Toaster container, see
563the ":doc:`/toaster-manual/toaster-manual-setup-and-use`" 563the ":doc:`/toaster-manual/setup-and-use`"
564section in the Toaster User Manual. 564section in the Toaster User Manual.
565 565
566Locating Yocto Project Source Files 566Locating 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:
217- *Hob GTK+-based UI*: Removed because it is unmaintained and based on 217- *Hob GTK+-based UI*: Removed because it is unmaintained and based on
218 the outdated GTK+ 2 library. The Toaster web-based UI is much more 218 the outdated GTK+ 2 library. The Toaster web-based UI is much more
219 capable and is actively maintained. See the 219 capable and is actively maintained. See the
220 ":ref:`toaster-manual/toaster-manual-setup-and-use:using the toaster web interface`" 220 ":ref:`toaster-manual/setup-and-use:using the toaster web interface`"
221 section in the Toaster User Manual for more information on this 221 section in the Toaster User Manual for more information on this
222 interface. 222 interface.
223 223
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
10 :caption: Table of Contents 10 :caption: Table of Contents
11 :numbered: 11 :numbered:
12 12
13 toaster-manual-intro 13 intro
14 toaster-manual-start 14 start
15 toaster-manual-setup-and-use 15 setup-and-use
16 toaster-manual-reference 16 reference
17 history 17 history
18 18
19.. include:: /boilerplate.rst 19.. 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.
25 interface, you can: 25 interface, you can:
26 26
27 - Browse layers listed in the various 27 - Browse layers listed in the various
28 :ref:`layer sources <toaster-manual/toaster-manual-reference:layer source>` 28 :ref:`layer sources <toaster-manual/reference:layer source>`
29 that are available in your project (e.g. the OpenEmbedded Layer Index at 29 that are available in your project (e.g. the OpenEmbedded Layer Index at
30 http://layers.openembedded.org/layerindex/). 30 http://layers.openembedded.org/layerindex/).
31 31
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::
476 476
477Be sure to provide values for 477Be sure to provide values for
478host, port, and ID. You can find the value for ID from the Builds 478host, port, and ID. You can find the value for ID from the Builds
479Completed query. See the ":ref:`toaster-manual/toaster-manual-reference:checking status of builds completed`" 479Completed query. See the ":ref:`toaster-manual/reference:checking status of builds completed`"
480section for more information. 480section for more information.
481 481
482The output is a JSON file that itemizes the specific build and includes 482The output is a JSON file that itemizes the specific build and includes
@@ -549,7 +549,7 @@ database.
549 549
550You need to run the ``buildslist`` command first to identify existing 550You need to run the ``buildslist`` command first to identify existing
551builds in the database before using the 551builds in the database before using the
552:ref:`toaster-manual/toaster-manual-reference:\`\`builddelete\`\`` command. Here is an 552:ref:`toaster-manual/reference:\`\`builddelete\`\`` command. Here is an
553example that assumes default repository and build directory names: 553example that assumes default repository and build directory names:
554 554
555.. code-block:: shell 555.. code-block:: shell
@@ -558,7 +558,7 @@ example that assumes default repository and build directory names:
558 $ python ../bitbake/lib/toaster/manage.py buildslist 558 $ python ../bitbake/lib/toaster/manage.py buildslist
559 559
560If your Toaster database had only one build, the above 560If your Toaster database had only one build, the above
561:ref:`toaster-manual/toaster-manual-reference:\`\`buildslist\`\`` 561:ref:`toaster-manual/reference:\`\`buildslist\`\``
562command would return something like the following:: 562command would return something like the following::
563 563
564 1: qemux86 poky core-image-minimal 564 1: qemux86 poky core-image-minimal
@@ -579,7 +579,7 @@ the database.
579 579
580Prior to running the ``builddelete`` command, you need to get the ID 580Prior to running the ``builddelete`` command, you need to get the ID
581associated with builds by using the 581associated with builds by using the
582:ref:`toaster-manual/toaster-manual-reference:\`\`buildslist\`\`` command. 582:ref:`toaster-manual/reference:\`\`buildslist\`\`` command.
583 583
584``perf`` 584``perf``
585-------- 585--------
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
10====================================== 10======================================
11 11
12Once you have set up the Yocto Project and installed the Toaster system 12Once you have set up the Yocto Project and installed the Toaster system
13dependencies as described in the ":ref:`toaster-manual/toaster-manual-start:Preparing to Use 13dependencies as described in the ":ref:`toaster-manual/start:Preparing to Use
14Toaster`" chapter, you are ready to start 14Toaster`" chapter, you are ready to start
15Toaster. 15Toaster.
16 16
@@ -30,7 +30,7 @@ Next, from the build directory (e.g.
30 30
31You can now run your builds from the command line, or with Toaster 31You can now run your builds from the command line, or with Toaster
32as explained in section 32as explained in section
33":ref:`toaster-manual/toaster-manual-setup-and-use:using the toaster web interface`". 33":ref:`toaster-manual/setup-and-use:using the toaster web interface`".
34 34
35To access the Toaster web interface, open your favorite browser and 35To access the Toaster web interface, open your favorite browser and
36enter the following:: 36enter the following::
@@ -200,7 +200,7 @@ Be sure you meet the following requirements:
200 200
201 You must comply with all Apache, ``mod-wsgi``, and Mysql requirements. 201 You must comply with all Apache, ``mod-wsgi``, and Mysql requirements.
202 202
203- Have all the build requirements as described in the ":ref:`toaster-manual/toaster-manual-start:Preparing to 203- Have all the build requirements as described in the ":ref:`toaster-manual/start:Preparing to
204 Use Toaster`" chapter. 204 Use Toaster`" chapter.
205 205
206- Have an Apache webserver. 206- Have an Apache webserver.
@@ -314,7 +314,7 @@ Perform the following steps to install Toaster:
314 ``TEMPLATECONF`` value reflects the contents of 314 ``TEMPLATECONF`` value reflects the contents of
315 ``poky/.templateconf``, and by default, should include the string 315 ``poky/.templateconf``, and by default, should include the string
316 "poky". For more information on the Toaster configuration file, see 316 "poky". For more information on the Toaster configuration file, see
317 the ":ref:`toaster-manual/toaster-manual-reference:Configuring Toaster`" section. 317 the ":ref:`toaster-manual/reference:Configuring Toaster`" section.
318 318
319 This line also runs the ``checksettings`` command, which configures 319 This line also runs the ``checksettings`` command, which configures
320 the location of the Toaster :term:`Build Directory`. 320 the location of the Toaster :term:`Build Directory`.
@@ -544,7 +544,7 @@ Additional Information About the Local Yocto Project Release
544 544
545This section only applies if you have set up Toaster for local 545This section only applies if you have set up Toaster for local
546development, as explained in the 546development, as explained in the
547":ref:`toaster-manual/toaster-manual-setup-and-use:starting toaster for local development`" 547":ref:`toaster-manual/setup-and-use:starting toaster for local development`"
548section. 548section.
549 549
550When you create a project in Toaster, you will be asked to provide a 550When 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