summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorNicolas Dechesne <nicolas.dechesne@linaro.org>2020-07-24 17:41:37 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:33 +0100
commit4bf6fc5281d1976ad7113c91a93995406cfab429 (patch)
tree66733a6e0ca50aa985257e2236160e805ebc0a74 /documentation
parent7b87ca796a97628b2e83e7b43f2a9a9a81039972 (diff)
downloadpoky-4bf6fc5281d1976ad7113c91a93995406cfab429.tar.gz
sphinx: fix custom term links
Some term links have custom 'text', and require manual update, since they were not caught by the generic Python regexp. (From yocto-docs rev: 519355ba9daf7630e8d477b2f6f511be51fd8b2e) 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/bsp-guide/bsp.rst8
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.rst12
-rw-r--r--documentation/kernel-dev/kernel-dev-common.rst2
-rw-r--r--documentation/ref-manual/migration.rst4
-rw-r--r--documentation/ref-manual/ref-tasks.rst6
-rw-r--r--documentation/ref-manual/ref-variables.rst4
6 files changed, 18 insertions, 18 deletions
diff --git a/documentation/bsp-guide/bsp.rst b/documentation/bsp-guide/bsp.rst
index 4517604a2a..e06b1259f0 100644
--- a/documentation/bsp-guide/bsp.rst
+++ b/documentation/bsp-guide/bsp.rst
@@ -1260,7 +1260,7 @@ the "`Yocto Project Variables
1260Glossary <&YOCTO_DOCS_REF_URL;#ref-variables-glos>`__" in the Yocto 1260Glossary <&YOCTO_DOCS_REF_URL;#ref-variables-glos>`__" in the Yocto
1261Project Reference Manual. 1261Project Reference Manual.
1262 1262
1263- ```PREFERRED_PROVIDER_virtual/xserver`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER>`__: 1263- :term:`PREFERRED_PROVIDER_virtual/xserver <PREFERRED_PROVIDER>`:
1264 The recipe that provides "virtual/xserver" when more than one 1264 The recipe that provides "virtual/xserver" when more than one
1265 provider is found. In this case, the recipe that provides 1265 provider is found. In this case, the recipe that provides
1266 "virtual/xserver" is "xserver-xorg", which exists in 1266 "virtual/xserver" is "xserver-xorg", which exists in
@@ -1334,13 +1334,13 @@ Project Reference Manual.
1334 Defines a serial console (TTY) to enable using getty. In this case, 1334 Defines a serial console (TTY) to enable using getty. In this case,
1335 the baud rate is "115200" and the device name is "ttyO0". 1335 the baud rate is "115200" and the device name is "ttyO0".
1336 1336
1337- ```PREFERRED_PROVIDER_virtual/kernel`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER>`__: 1337- :term:`PREFERRED_PROVIDER_virtual/kernel <PREFERRED_PROVIDER>`:
1338 Specifies the recipe that provides "virtual/kernel" when more than 1338 Specifies the recipe that provides "virtual/kernel" when more than
1339 one provider is found. In this case, the recipe that provides 1339 one provider is found. In this case, the recipe that provides
1340 "virtual/kernel" is "linux-yocto", which exists in the layer's 1340 "virtual/kernel" is "linux-yocto", which exists in the layer's
1341 ``recipes-kernel/linux`` directory. 1341 ``recipes-kernel/linux`` directory.
1342 1342
1343- ```PREFERRED_VERSION_linux-yocto`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_VERSION>`__: 1343- :term:`PREFERRED_VERSION_linux-yocto <PREFERRED_VERSION>`:
1344 Defines the version of the recipe used to build the kernel, which is 1344 Defines the version of the recipe used to build the kernel, which is
1345 "5.0" in this case. 1345 "5.0" in this case.
1346 1346
@@ -1372,7 +1372,7 @@ Project Reference Manual.
1372 u-boot.inc 1372 u-boot.inc
1373 include file. 1373 include file.
1374 1374
1375- ```UBOOT_*`` <&YOCTO_DOCS_REF_URL;#var-UBOOT_ENTRYPOINT>`__: Defines 1375- :term:`UBOOT_* <UBOOT_ENTRYPOINT>`: Defines
1376 various U-Boot configurations needed to build a U-Boot image. In this 1376 various U-Boot configurations needed to build a U-Boot image. In this
1377 example, a U-Boot image is required to boot the BeagleBone device. 1377 example, a U-Boot image is required to boot the BeagleBone device.
1378 See the following variables for more information: 1378 See the following variables for more information:
diff --git a/documentation/dev-manual/dev-manual-common-tasks.rst b/documentation/dev-manual/dev-manual-common-tasks.rst
index ae26172f6c..e1fe881437 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.rst
+++ b/documentation/dev-manual/dev-manual-common-tasks.rst
@@ -4206,18 +4206,18 @@ If you have multiple CPUs, you might try increasing the default values
4206to gain more speed. See the descriptions in the glossary for each 4206to gain more speed. See the descriptions in the glossary for each
4207variable for more information: 4207variable for more information:
4208 4208
4209- ```BB_NUMBER_THREADS``: <&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS>`__ 4209- :term:`BB_NUMBER_THREADS`:
4210 The maximum number of threads BitBake simultaneously executes. 4210 The maximum number of threads BitBake simultaneously executes.
4211 4211
4212- ```BB_NUMBER_PARSE_THREADS``: <&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS>`__ 4212- ```BB_NUMBER_PARSE_THREADS``: <&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS>`__
4213 The number of threads BitBake uses during parsing. 4213 The number of threads BitBake uses during parsing.
4214 4214
4215- ```PARALLEL_MAKE``: <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE>`__ Extra 4215- :term:`PARALLEL_MAKE`: Extra
4216 options passed to the ``make`` command during the 4216 options passed to the ``make`` command during the
4217 :ref:`ref-tasks-compile` task in 4217 :ref:`ref-tasks-compile` task in
4218 order to specify parallel compilation on the local build host. 4218 order to specify parallel compilation on the local build host.
4219 4219
4220- ```PARALLEL_MAKEINST``: <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST>`__ 4220- :term:`PARALLEL_MAKEINST`:
4221 Extra options passed to the ``make`` command during the 4221 Extra options passed to the ``make`` command during the
4222 :ref:`ref-tasks-install` task in 4222 :ref:`ref-tasks-install` task in
4223 order to specify parallel installation on the local build host. 4223 order to specify parallel installation on the local build host.
@@ -4329,7 +4329,7 @@ can control which static library files (``*.a`` files) get included in
4329the built library. 4329the built library.
4330 4330
4331The :term:`PACKAGES` and 4331The :term:`PACKAGES` and
4332```FILES_*`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__ variables in the 4332:term:`FILES_* <FILES>` variables in the
4333``meta/conf/bitbake.conf`` configuration file define how files installed 4333``meta/conf/bitbake.conf`` configuration file define how files installed
4334by the ``do_install`` task are packaged. By default, the ``PACKAGES`` 4334by the ``do_install`` task are packaged. By default, the ``PACKAGES``
4335variable includes ``${PN}-staticdev``, which represents all static 4335variable includes ``${PN}-staticdev``, which represents all static
@@ -7290,8 +7290,8 @@ Finally, for those recipes fetched from a version control system (e.g.,
7290Git), a file exists that lists source revisions that are specified in 7290Git), a file exists that lists source revisions that are specified in
7291the recipe and lists the actual revisions used during the build. Listed 7291the recipe and lists the actual revisions used during the build. Listed
7292and actual revisions might differ when 7292and actual revisions might differ when
7293```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__ is set to 7293:term:`SRCREV` is set to
7294${```AUTOREV`` <&YOCTO_DOCS_REF_URL;#var-AUTOREV>`__}. Here is an 7294${:term:`AUTOREV`}. Here is an
7295example assuming 7295example assuming
7296``buildhistory/packages/qemux86-poky-linux/linux-yocto/latest_srcrev``): 7296``buildhistory/packages/qemux86-poky-linux/linux-yocto/latest_srcrev``):
7297# SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1" 7297# SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1"
diff --git a/documentation/kernel-dev/kernel-dev-common.rst b/documentation/kernel-dev/kernel-dev-common.rst
index b5f794e733..f264cea159 100644
--- a/documentation/kernel-dev/kernel-dev-common.rst
+++ b/documentation/kernel-dev/kernel-dev-common.rst
@@ -1548,7 +1548,7 @@ Typically, you will need to set the following variables:
1548 1548
1549- :term:`DESCRIPTION` 1549- :term:`DESCRIPTION`
1550 1550
1551- ```LICENSE*`` <&YOCTO_DOCS_REF_URL;#var-LICENSE>`__ 1551- :term:`LICENSE* <LICENSE>`
1552 1552
1553- :term:`SRC_URI` 1553- :term:`SRC_URI`
1554 1554
diff --git a/documentation/ref-manual/migration.rst b/documentation/ref-manual/migration.rst
index b8d27f3325..1d4d53647f 100644
--- a/documentation/ref-manual/migration.rst
+++ b/documentation/ref-manual/migration.rst
@@ -1366,10 +1366,10 @@ release notes
1366Kernel Module Autoloading 1366Kernel Module Autoloading
1367------------------------- 1367-------------------------
1368 1368
1369The ```module_autoload_*`` <#var-module_autoload>`__ variable is now 1369The :term:`module_autoload_* <module_autoload>` variable is now
1370deprecated and a new 1370deprecated and a new
1371:term:`KERNEL_MODULE_AUTOLOAD` variable 1371:term:`KERNEL_MODULE_AUTOLOAD` variable
1372should be used instead. Also, ```module_conf_*`` <#var-module_conf>`__ 1372should be used instead. Also, :term:`module_conf_* <module_conf>`
1373must now be used in conjunction with a new 1373must now be used in conjunction with a new
1374:term:`KERNEL_MODULE_PROBECONF` variable. 1374:term:`KERNEL_MODULE_PROBECONF` variable.
1375The new variables no longer require you to specify the module name as 1375The new variables no longer require you to specify the module name as
diff --git a/documentation/ref-manual/ref-tasks.rst b/documentation/ref-manual/ref-tasks.rst
index aa7c0df552..f3c698ba98 100644
--- a/documentation/ref-manual/ref-tasks.rst
+++ b/documentation/ref-manual/ref-tasks.rst
@@ -377,12 +377,12 @@ information.
377Stages (copies) a subset of the files installed by the 377Stages (copies) a subset of the files installed by the
378:ref:`ref-tasks-install` task into the appropriate 378:ref:`ref-tasks-install` task into the appropriate
379sysroot. For information on how to access these files from other 379sysroot. For information on how to access these files from other
380recipes, see the ```STAGING_DIR*`` <#var-STAGING_DIR_HOST>`__ variables. 380recipes, see the :term:`STAGING_DIR* <STAGING_DIR_HOST>` variables.
381Directories that would typically not be needed by other recipes at build 381Directories that would typically not be needed by other recipes at build
382time (e.g. ``/etc``) are not copied by default. 382time (e.g. ``/etc``) are not copied by default.
383 383
384For information on what directories are copied by default, see the 384For information on what directories are copied by default, see the
385```SYSROOT_DIRS*`` <#var-SYSROOT_DIRS>`__ variables. You can change 385:term:`SYSROOT_DIRS* <SYSROOT_DIRS>` variables. You can change
386these variables inside your recipe if you need to make additional (or 386these variables inside your recipe if you need to make additional (or
387fewer) directories available to other recipes at build time. 387fewer) directories available to other recipes at build time.
388 388
@@ -451,7 +451,7 @@ section for information on checking the upgrade status of a recipe.
451 451
452To build the ``checkpkg`` task, use the ``bitbake`` command with the 452To build the ``checkpkg`` task, use the ``bitbake`` command with the
453"-c" option and task name: $ bitbake core-image-minimal -c checkpkg By 453"-c" option and task name: $ bitbake core-image-minimal -c checkpkg By
454default, the results are stored in ```$LOG_DIR`` <#var-LOG_DIR>`__ (e.g. 454default, the results are stored in :term:`$LOG_DIR <LOG_DIR>` (e.g.
455``$BUILD_DIR/tmp/log``). 455``$BUILD_DIR/tmp/log``).
456 456
457.. _ref-tasks-checkuri: 457.. _ref-tasks-checkuri:
diff --git a/documentation/ref-manual/ref-variables.rst b/documentation/ref-manual/ref-variables.rst
index 3eae836fd6..473b672b76 100644
--- a/documentation/ref-manual/ref-variables.rst
+++ b/documentation/ref-manual/ref-variables.rst
@@ -1473,7 +1473,7 @@ system and gives an overview of their function and contents.
1473 assignment: DEPENDS = "bar" The practical effect of the previous 1473 assignment: DEPENDS = "bar" The practical effect of the previous
1474 assignment is that all files installed by bar will be available in 1474 assignment is that all files installed by bar will be available in
1475 the appropriate staging sysroot, given by the 1475 the appropriate staging sysroot, given by the
1476 ```STAGING_DIR*`` <#var-STAGING_DIR>`__ variables, by the time the 1476 :term:`STAGING_DIR* <STAGING_DIR>` variables, by the time the
1477 :ref:`ref-tasks-configure` task for ``foo`` runs. 1477 :ref:`ref-tasks-configure` task for ``foo`` runs.
1478 This mechanism is implemented by having ``do_configure`` depend on 1478 This mechanism is implemented by having ``do_configure`` depend on
1479 the :ref:`ref-tasks-populate_sysroot` task of 1479 the :ref:`ref-tasks-populate_sysroot` task of
@@ -3599,7 +3599,7 @@ system and gives an overview of their function and contents.
3599 expects to find ``module_conf_``\ modname values that specify 3599 expects to find ``module_conf_``\ modname values that specify
3600 configuration for each of the modules. For information on how to 3600 configuration for each of the modules. For information on how to
3601 provide those module configurations, see the 3601 provide those module configurations, see the
3602 ```module_conf_*`` <#var-module_conf>`__ variable. 3602 :term:`module_conf_* <module_conf>` variable.
3603 3603
3604 KERNEL_PATH 3604 KERNEL_PATH
3605 The location of the kernel sources. This variable is set to the value 3605 The location of the kernel sources. This variable is set to the value