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>
This commit is contained in:
Nicolas Dechesne
2020-07-24 17:41:37 +02:00
committed by Richard Purdie
parent 7b87ca796a
commit 4bf6fc5281
6 changed files with 18 additions and 18 deletions

View File

@@ -1260,7 +1260,7 @@ the "`Yocto Project Variables
Glossary <&YOCTO_DOCS_REF_URL;#ref-variables-glos>`__" in the Yocto
Project Reference Manual.
- ```PREFERRED_PROVIDER_virtual/xserver`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER>`__:
- :term:`PREFERRED_PROVIDER_virtual/xserver <PREFERRED_PROVIDER>`:
The recipe that provides "virtual/xserver" when more than one
provider is found. In this case, the recipe that provides
"virtual/xserver" is "xserver-xorg", which exists in
@@ -1334,13 +1334,13 @@ Project Reference Manual.
Defines a serial console (TTY) to enable using getty. In this case,
the baud rate is "115200" and the device name is "ttyO0".
- ```PREFERRED_PROVIDER_virtual/kernel`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_PROVIDER>`__:
- :term:`PREFERRED_PROVIDER_virtual/kernel <PREFERRED_PROVIDER>`:
Specifies the recipe that provides "virtual/kernel" when more than
one provider is found. In this case, the recipe that provides
"virtual/kernel" is "linux-yocto", which exists in the layer's
``recipes-kernel/linux`` directory.
- ```PREFERRED_VERSION_linux-yocto`` <&YOCTO_DOCS_REF_URL;#var-PREFERRED_VERSION>`__:
- :term:`PREFERRED_VERSION_linux-yocto <PREFERRED_VERSION>`:
Defines the version of the recipe used to build the kernel, which is
"5.0" in this case.
@@ -1372,7 +1372,7 @@ Project Reference Manual.
u-boot.inc
include file.
- ```UBOOT_*`` <&YOCTO_DOCS_REF_URL;#var-UBOOT_ENTRYPOINT>`__: Defines
- :term:`UBOOT_* <UBOOT_ENTRYPOINT>`: Defines
various U-Boot configurations needed to build a U-Boot image. In this
example, a U-Boot image is required to boot the BeagleBone device.
See the following variables for more information:

View File

@@ -4206,18 +4206,18 @@ If you have multiple CPUs, you might try increasing the default values
to gain more speed. See the descriptions in the glossary for each
variable for more information:
- ```BB_NUMBER_THREADS``: <&YOCTO_DOCS_REF_URL;#var-BB_NUMBER_THREADS>`__
- :term:`BB_NUMBER_THREADS`:
The maximum number of threads BitBake simultaneously executes.
- ```BB_NUMBER_PARSE_THREADS``: <&YOCTO_DOCS_BB_URL;#var-BB_NUMBER_PARSE_THREADS>`__
The number of threads BitBake uses during parsing.
- ```PARALLEL_MAKE``: <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKE>`__ Extra
- :term:`PARALLEL_MAKE`: Extra
options passed to the ``make`` command during the
:ref:`ref-tasks-compile` task in
order to specify parallel compilation on the local build host.
- ```PARALLEL_MAKEINST``: <&YOCTO_DOCS_REF_URL;#var-PARALLEL_MAKEINST>`__
- :term:`PARALLEL_MAKEINST`:
Extra options passed to the ``make`` command during the
:ref:`ref-tasks-install` task in
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
the built library.
The :term:`PACKAGES` and
```FILES_*`` <&YOCTO_DOCS_REF_URL;#var-FILES>`__ variables in the
:term:`FILES_* <FILES>` variables in the
``meta/conf/bitbake.conf`` configuration file define how files installed
by the ``do_install`` task are packaged. By default, the ``PACKAGES``
variable includes ``${PN}-staticdev``, which represents all static
@@ -7290,8 +7290,8 @@ Finally, for those recipes fetched from a version control system (e.g.,
Git), a file exists that lists source revisions that are specified in
the recipe and lists the actual revisions used during the build. Listed
and actual revisions might differ when
```SRCREV`` <&YOCTO_DOCS_REF_URL;#var-SRCREV>`__ is set to
${```AUTOREV`` <&YOCTO_DOCS_REF_URL;#var-AUTOREV>`__}. Here is an
:term:`SRCREV` is set to
${:term:`AUTOREV`}. Here is an
example assuming
``buildhistory/packages/qemux86-poky-linux/linux-yocto/latest_srcrev``):
# SRCREV_machine = "38cd560d5022ed2dbd1ab0dca9642e47c98a0aa1"

View File

@@ -1548,7 +1548,7 @@ Typically, you will need to set the following variables:
- :term:`DESCRIPTION`
- ```LICENSE*`` <&YOCTO_DOCS_REF_URL;#var-LICENSE>`__
- :term:`LICENSE* <LICENSE>`
- :term:`SRC_URI`

View File

@@ -1366,10 +1366,10 @@ release notes
Kernel Module Autoloading
-------------------------
The ```module_autoload_*`` <#var-module_autoload>`__ variable is now
The :term:`module_autoload_* <module_autoload>` variable is now
deprecated and a new
:term:`KERNEL_MODULE_AUTOLOAD` variable
should be used instead. Also, ```module_conf_*`` <#var-module_conf>`__
should be used instead. Also, :term:`module_conf_* <module_conf>`
must now be used in conjunction with a new
:term:`KERNEL_MODULE_PROBECONF` variable.
The new variables no longer require you to specify the module name as

View File

@@ -377,12 +377,12 @@ information.
Stages (copies) a subset of the files installed by the
:ref:`ref-tasks-install` task into the appropriate
sysroot. For information on how to access these files from other
recipes, see the ```STAGING_DIR*`` <#var-STAGING_DIR_HOST>`__ variables.
recipes, see the :term:`STAGING_DIR* <STAGING_DIR_HOST>` variables.
Directories that would typically not be needed by other recipes at build
time (e.g. ``/etc``) are not copied by default.
For information on what directories are copied by default, see the
```SYSROOT_DIRS*`` <#var-SYSROOT_DIRS>`__ variables. You can change
:term:`SYSROOT_DIRS* <SYSROOT_DIRS>` variables. You can change
these variables inside your recipe if you need to make additional (or
fewer) directories available to other recipes at build time.
@@ -451,7 +451,7 @@ section for information on checking the upgrade status of a recipe.
To build the ``checkpkg`` task, use the ``bitbake`` command with the
"-c" option and task name: $ bitbake core-image-minimal -c checkpkg By
default, the results are stored in ```$LOG_DIR`` <#var-LOG_DIR>`__ (e.g.
default, the results are stored in :term:`$LOG_DIR <LOG_DIR>` (e.g.
``$BUILD_DIR/tmp/log``).
.. _ref-tasks-checkuri:

View File

@@ -1473,7 +1473,7 @@ system and gives an overview of their function and contents.
assignment: DEPENDS = "bar" The practical effect of the previous
assignment is that all files installed by bar will be available in
the appropriate staging sysroot, given by the
```STAGING_DIR*`` <#var-STAGING_DIR>`__ variables, by the time the
:term:`STAGING_DIR* <STAGING_DIR>` variables, by the time the
:ref:`ref-tasks-configure` task for ``foo`` runs.
This mechanism is implemented by having ``do_configure`` depend on
the :ref:`ref-tasks-populate_sysroot` task of
@@ -3599,7 +3599,7 @@ system and gives an overview of their function and contents.
expects to find ``module_conf_``\ modname values that specify
configuration for each of the modules. For information on how to
provide those module configurations, see the
```module_conf_*`` <#var-module_conf>`__ variable.
:term:`module_conf_* <module_conf>` variable.
KERNEL_PATH
The location of the kernel sources. This variable is set to the value