diff options
author | Quentin Schulz <foss@0leil.net> | 2021-05-27 20:41:17 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-06-19 16:54:01 +0100 |
commit | 7d3f57cfd2e4322bcd96d67d330124f221a9aedd (patch) | |
tree | 5d07321b7c8bc59bb7fcc0372fab8b7a1966cf06 /documentation/sdk-manual/appendix-customizing.rst | |
parent | 7a9b74e9d2a5cf3b1fb3ac7565c50eae6e0d4632 (diff) | |
download | poky-7d3f57cfd2e4322bcd96d67d330124f221a9aedd.tar.gz |
docs: replace ``FOO`` by :term:`FOO` where possible
If a variable has a glossary entry and some rST files write about those
variables, it's better to point to the glossary entry instead of just
highlighting it by surrounding it with two tick quotes.
This was automated by the following python script:
"""
import re
from pathlib import Path
with open('objects.inv.txt', 'r') as f:
objects = f.readlines()
with open('bitbake-objects.inv.txt', 'r') as f:
objects = objects + f.readlines()
re_term = re.compile(r'variables.html#term-([A-Z_0-9]*)')
terms = []
for obj in objects:
match = re_term.search(obj)
if match and match.group(1):
terms.append(match.group(1))
for rst in Path('.').rglob('*.rst'):
with open(rst, 'r') as f:
content = "".joing(f.readlines())
for term in terms:
content = re.sub(r'``({})``(?!.*\s*[~-]+)'.format(term), r':term:`\1`', content)
with open(rst, 'w') as f:
f.write(content)
"""
(From yocto-docs rev: ba49d9babfcb84bc5c26a68c8c3880a1d9c236d3)
Signed-off-by: Quentin Schulz <foss@0leil.net>
Reviewed-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/appendix-customizing.rst')
-rw-r--r-- | documentation/sdk-manual/appendix-customizing.rst | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst index c122fb5836..8c635d1662 100644 --- a/documentation/sdk-manual/appendix-customizing.rst +++ b/documentation/sdk-manual/appendix-customizing.rst | |||
@@ -35,13 +35,13 @@ build system applies them against ``local.conf`` and ``auto.conf``: | |||
35 | - Variables listed in | 35 | - Variables listed in |
36 | :term:`SDK_LOCAL_CONF_WHITELIST` | 36 | :term:`SDK_LOCAL_CONF_WHITELIST` |
37 | are included. Including a variable in the value of | 37 | are included. Including a variable in the value of |
38 | ``SDK_LOCAL_CONF_WHITELIST`` overrides either of the previous two | 38 | :term:`SDK_LOCAL_CONF_WHITELIST` overrides either of the previous two |
39 | filters. The default value is blank. | 39 | filters. The default value is blank. |
40 | 40 | ||
41 | - Classes inherited globally with | 41 | - Classes inherited globally with |
42 | :term:`INHERIT` that are listed in | 42 | :term:`INHERIT` that are listed in |
43 | :term:`SDK_INHERIT_BLACKLIST` | 43 | :term:`SDK_INHERIT_BLACKLIST` |
44 | are disabled. Using ``SDK_INHERIT_BLACKLIST`` to disable these | 44 | are disabled. Using :term:`SDK_INHERIT_BLACKLIST` to disable these |
45 | classes is the typical method to disable classes that are problematic | 45 | classes is the typical method to disable classes that are problematic |
46 | or unnecessary in the SDK context. The default value blacklists the | 46 | or unnecessary in the SDK context. The default value blacklists the |
47 | :ref:`buildhistory <ref-classes-buildhistory>` | 47 | :ref:`buildhistory <ref-classes-buildhistory>` |
@@ -95,7 +95,7 @@ adjustments: | |||
95 | 95 | ||
96 | - Disable the tasks if they are added by a class and you do not need | 96 | - Disable the tasks if they are added by a class and you do not need |
97 | the functionality the class provides in the extensible SDK. To | 97 | the functionality the class provides in the extensible SDK. To |
98 | disable the tasks, add the class to the ``SDK_INHERIT_BLACKLIST`` | 98 | disable the tasks, add the class to the :term:`SDK_INHERIT_BLACKLIST` |
99 | variable as described in the previous section. | 99 | variable as described in the previous section. |
100 | 100 | ||
101 | - Generally, you want to have a shared state mirror set up so users of | 101 | - Generally, you want to have a shared state mirror set up so users of |
@@ -142,12 +142,12 @@ section. | |||
142 | 142 | ||
143 | By default, this title is derived from | 143 | By default, this title is derived from |
144 | :term:`DISTRO_NAME` when it is | 144 | :term:`DISTRO_NAME` when it is |
145 | set. If the ``DISTRO_NAME`` variable is not set, the title is derived | 145 | set. If the :term:`DISTRO_NAME` variable is not set, the title is derived |
146 | from the :term:`DISTRO` variable. | 146 | from the :term:`DISTRO` variable. |
147 | 147 | ||
148 | The | 148 | The |
149 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` | 149 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` |
150 | class defines the default value of the ``SDK_TITLE`` variable as | 150 | class defines the default value of the :term:`SDK_TITLE` variable as |
151 | follows:: | 151 | follows:: |
152 | 152 | ||
153 | SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" | 153 | SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" |
@@ -158,7 +158,7 @@ creates an SDK installer title that applies across your distribution. As | |||
158 | an example, assume you have your own layer for your distribution named | 158 | an example, assume you have your own layer for your distribution named |
159 | "meta-mydistro" and you are using the same type of file hierarchy as | 159 | "meta-mydistro" and you are using the same type of file hierarchy as |
160 | does the default "poky" distribution. If so, you could update the | 160 | does the default "poky" distribution. If so, you could update the |
161 | ``SDK_TITLE`` variable in the | 161 | :term:`SDK_TITLE` variable in the |
162 | ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following | 162 | ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following |
163 | form:: | 163 | form:: |
164 | 164 | ||
@@ -220,7 +220,7 @@ class as follows:: | |||
220 | 220 | ||
221 | You can | 221 | You can |
222 | change this default installation directory by specifically setting the | 222 | change this default installation directory by specifically setting the |
223 | ``SDKEXTPATH`` variable. | 223 | :term:`SDKEXTPATH` variable. |
224 | 224 | ||
225 | While there are several ways of setting this variable, | 225 | While there are several ways of setting this variable, |
226 | the method that makes the most sense is to set the variable in your | 226 | the method that makes the most sense is to set the variable in your |
@@ -229,7 +229,7 @@ default directory that applies across your distribution. As an example, | |||
229 | assume you have your own layer for your distribution named | 229 | assume you have your own layer for your distribution named |
230 | "meta-mydistro" and you are using the same type of file hierarchy as | 230 | "meta-mydistro" and you are using the same type of file hierarchy as |
231 | does the default "poky" distribution. If so, you could update the | 231 | does the default "poky" distribution. If so, you could update the |
232 | ``SDKEXTPATH`` variable in the | 232 | :term:`SDKEXTPATH` variable in the |
233 | ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following | 233 | ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following |
234 | form:: | 234 | form:: |
235 | 235 | ||
@@ -284,11 +284,11 @@ source, you need to do a number of things: | |||
284 | 284 | ||
285 | SDK_LOCAL_CONF_WHITELIST = "SSTATE_MIRRORS" | 285 | SDK_LOCAL_CONF_WHITELIST = "SSTATE_MIRRORS" |
286 | 286 | ||
287 | - Alternatively, if you just want to set the ``SSTATE_MIRRORS`` | 287 | - Alternatively, if you just want to set the :term:`SSTATE_MIRRORS` |
288 | variable's value for the SDK alone, create a | 288 | variable's value for the SDK alone, create a |
289 | ``conf/sdk-extra.conf`` file either in your | 289 | ``conf/sdk-extra.conf`` file either in your |
290 | :term:`Build Directory` or within any | 290 | :term:`Build Directory` or within any |
291 | layer and put your ``SSTATE_MIRRORS`` setting within that file. | 291 | layer and put your :term:`SSTATE_MIRRORS` setting within that file. |
292 | 292 | ||
293 | .. note:: | 293 | .. note:: |
294 | 294 | ||
@@ -333,7 +333,7 @@ following:: | |||
333 | 333 | ||
334 | See the :term:`SDK_INCLUDE_PKGDATA` variable for additional information. | 334 | See the :term:`SDK_INCLUDE_PKGDATA` variable for additional information. |
335 | 335 | ||
336 | Setting the ``SDK_INCLUDE_PKGDATA`` variable as shown causes the "world" | 336 | Setting the :term:`SDK_INCLUDE_PKGDATA` variable as shown causes the "world" |
337 | target to be built so that information for all of the recipes included | 337 | target to be built so that information for all of the recipes included |
338 | within it are available. Having these recipes available increases build | 338 | within it are available. Having these recipes available increases build |
339 | time significantly and increases the size of the SDK installer by 30-80 | 339 | time significantly and increases the size of the SDK installer by 30-80 |
@@ -358,7 +358,7 @@ You can explicitly control whether or not to include the toolchain when | |||
358 | you build an SDK by setting the | 358 | you build an SDK by setting the |
359 | :term:`SDK_INCLUDE_TOOLCHAIN` | 359 | :term:`SDK_INCLUDE_TOOLCHAIN` |
360 | variable to "1". In particular, it is useful to include the toolchain | 360 | variable to "1". In particular, it is useful to include the toolchain |
361 | when you have set ``SDK_EXT_TYPE`` to "minimal", which by default, | 361 | when you have set :term:`SDK_EXT_TYPE` to "minimal", which by default, |
362 | excludes the toolchain. Also, it is helpful if you are building a small | 362 | excludes the toolchain. Also, it is helpful if you are building a small |
363 | SDK for use with an IDE or some other tool where you do not want to take | 363 | SDK for use with an IDE or some other tool where you do not want to take |
364 | extra steps to install a toolchain. | 364 | extra steps to install a toolchain. |