summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-12-09 19:01:55 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-18 10:41:21 +0000
commit6846d4d00bc3a9d4e188ad9c8cfdf6e45cd1ba06 (patch)
tree6a59e9936ac9f2ca063d4fc8a5c4d9ecc9492769 /documentation/ref-manual
parent474e071608c7c1c97e9dafde810aef5630c716e7 (diff)
downloadpoky-6846d4d00bc3a9d4e188ad9c8cfdf6e45cd1ba06.tar.gz
manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc. (From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r--documentation/ref-manual/classes.rst4
-rw-r--r--documentation/ref-manual/system-requirements.rst20
-rw-r--r--documentation/ref-manual/variables.rst12
3 files changed, 18 insertions, 18 deletions
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index de5f108fb1..7f760c5ba4 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -979,11 +979,11 @@ by default (as specified by :term:`IMAGE_BUILDINFO_FILE`).
979This can be useful for manually determining the origin of any given 979This can be useful for manually determining the origin of any given
980image. It writes out two sections: 980image. It writes out two sections:
981 981
9821. `Build Configuration`: a list of variables and their values (specified 982#. `Build Configuration`: a list of variables and their values (specified
983 by :term:`IMAGE_BUILDINFO_VARS`, which defaults to :term:`DISTRO` and 983 by :term:`IMAGE_BUILDINFO_VARS`, which defaults to :term:`DISTRO` and
984 :term:`DISTRO_VERSION`) 984 :term:`DISTRO_VERSION`)
985 985
9862. `Layer Revisions`: the revisions of all of the layers used in the 986#. `Layer Revisions`: the revisions of all of the layers used in the
987 build. 987 build.
988 988
989Additionally, when building an SDK it will write the same contents 989Additionally, when building an SDK it will write the same contents
diff --git a/documentation/ref-manual/system-requirements.rst b/documentation/ref-manual/system-requirements.rst
index 8dab359b69..3f27c03e44 100644
--- a/documentation/ref-manual/system-requirements.rst
+++ b/documentation/ref-manual/system-requirements.rst
@@ -235,7 +235,7 @@ The ``install-buildtools`` script is the easiest of the three methods by
235which you can get these tools. It downloads a pre-built buildtools 235which you can get these tools. It downloads a pre-built buildtools
236installer and automatically installs the tools for you: 236installer and automatically installs the tools for you:
237 237
2381. Execute the ``install-buildtools`` script. Here is an example:: 238#. Execute the ``install-buildtools`` script. Here is an example::
239 239
240 $ cd poky 240 $ cd poky
241 $ scripts/install-buildtools \ 241 $ scripts/install-buildtools \
@@ -268,7 +268,7 @@ installer and automatically installs the tools for you:
268 $ cd poky 268 $ cd poky
269 $ scripts/install-buildtools --make-only 269 $ scripts/install-buildtools --make-only
270 270
2712. Source the tools environment setup script by using a command like the 271#. Source the tools environment setup script by using a command like the
272 following:: 272 following::
273 273
274 $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux 274 $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux
@@ -291,9 +291,9 @@ If you would prefer not to use the ``install-buildtools`` script, you can instea
291download and run a pre-built buildtools installer yourself with the following 291download and run a pre-built buildtools installer yourself with the following
292steps: 292steps:
293 293
2941. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/` 294#. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/`
295 295
2962. Execute the installation script. Here is an example for the 296#. Execute the installation script. Here is an example for the
297 traditional installer:: 297 traditional installer::
298 298
299 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh 299 $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
@@ -310,7 +310,7 @@ steps:
310 installation directory. For example, you could choose the following: 310 installation directory. For example, you could choose the following:
311 ``/home/your-username/buildtools`` 311 ``/home/your-username/buildtools``
312 312
3133. Source the tools environment setup script by using a command like the 313#. Source the tools environment setup script by using a command like the
314 following:: 314 following::
315 315
316 $ source /home/your_username/buildtools/environment-setup-i586-poky-linux 316 $ source /home/your_username/buildtools/environment-setup-i586-poky-linux
@@ -339,11 +339,11 @@ Python (or gcc) requirements.
339Here are the steps to take to build and run your own buildtools 339Here are the steps to take to build and run your own buildtools
340installer: 340installer:
341 341
3421. On the machine that is able to run BitBake, be sure you have set up 342#. On the machine that is able to run BitBake, be sure you have set up
343 your build environment with the setup script 343 your build environment with the setup script
344 (:ref:`structure-core-script`). 344 (:ref:`structure-core-script`).
345 345
3462. Run the BitBake command to build the tarball:: 346#. Run the BitBake command to build the tarball::
347 347
348 $ bitbake buildtools-tarball 348 $ bitbake buildtools-tarball
349 349
@@ -365,10 +365,10 @@ installer:
365 :term:`Build Directory`. The installer file has the string 365 :term:`Build Directory`. The installer file has the string
366 "buildtools" (or "buildtools-extended") in the name. 366 "buildtools" (or "buildtools-extended") in the name.
367 367
3683. Transfer the ``.sh`` file from the build host to the machine that 368#. Transfer the ``.sh`` file from the build host to the machine that
369 does not meet the Git, tar, or Python (or gcc) requirements. 369 does not meet the Git, tar, or Python (or gcc) requirements.
370 370
3714. On the machine that does not meet the requirements, run the ``.sh`` 371#. On the machine that does not meet the requirements, run the ``.sh``
372 file to install the tools. Here is an example for the traditional 372 file to install the tools. Here is an example for the traditional
373 installer:: 373 installer::
374 374
@@ -386,7 +386,7 @@ installer:
386 installation directory. For example, you could choose the following: 386 installation directory. For example, you could choose the following:
387 ``/home/your_username/buildtools`` 387 ``/home/your_username/buildtools``
388 388
3895. Source the tools environment setup script by using a command like the 389#. Source the tools environment setup script by using a command like the
390 following:: 390 following::
391 391
392 $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux 392 $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 499a26f50b..8ed55ad7b3 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -5868,25 +5868,25 @@ system and gives an overview of their function and contents.
5868 omit any argument you like but must retain the separating commas. The 5868 omit any argument you like but must retain the separating commas. The
5869 order is important and specifies the following: 5869 order is important and specifies the following:
5870 5870
5871 1. Extra arguments that should be added to the configure script 5871 #. Extra arguments that should be added to the configure script
5872 argument list (:term:`EXTRA_OECONF` or 5872 argument list (:term:`EXTRA_OECONF` or
5873 :term:`PACKAGECONFIG_CONFARGS`) if 5873 :term:`PACKAGECONFIG_CONFARGS`) if
5874 the feature is enabled. 5874 the feature is enabled.
5875 5875
5876 2. Extra arguments that should be added to :term:`EXTRA_OECONF` or 5876 #. Extra arguments that should be added to :term:`EXTRA_OECONF` or
5877 :term:`PACKAGECONFIG_CONFARGS` if the feature is disabled. 5877 :term:`PACKAGECONFIG_CONFARGS` if the feature is disabled.
5878 5878
5879 3. Additional build dependencies (:term:`DEPENDS`) 5879 #. Additional build dependencies (:term:`DEPENDS`)
5880 that should be added if the feature is enabled. 5880 that should be added if the feature is enabled.
5881 5881
5882 4. Additional runtime dependencies (:term:`RDEPENDS`) 5882 #. Additional runtime dependencies (:term:`RDEPENDS`)
5883 that should be added if the feature is enabled. 5883 that should be added if the feature is enabled.
5884 5884
5885 5. Additional runtime recommendations 5885 #. Additional runtime recommendations
5886 (:term:`RRECOMMENDS`) that should be added if 5886 (:term:`RRECOMMENDS`) that should be added if
5887 the feature is enabled. 5887 the feature is enabled.
5888 5888
5889 6. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG` 5889 #. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG`
5890 settings for this feature. 5890 settings for this feature.
5891 5891
5892 Consider the following :term:`PACKAGECONFIG` block taken from the 5892 Consider the following :term:`PACKAGECONFIG` block taken from the