diff options
| author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-12-08 10:25:59 +0100 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-12-18 10:41:21 +0000 |
| commit | 01e5d22507e57c66452f14610ee8eb3d66ac9d71 (patch) | |
| tree | 7241fa93a3a0d11db32d042e5d70a750132ab0a1 /documentation/ref-manual | |
| parent | 8b812b29c4b13ba028c0d66f73a6599a988486d5 (diff) | |
| download | poky-01e5d22507e57c66452f14610ee8eb3d66ac9d71.tar.gz | |
manuals: fix double colons
Fixing double colons appearing alone on a line, while
they could be put at the end of the previous line.
Sometimes placing a note after the quoted text
to avoid such a situation. It's more natural too
not to have a note between the introduction text
and the quoted section.
(From yocto-docs rev: fb054622f5119444eb947fe580253f37e0d872c6)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
| -rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 7 | ||||
| -rw-r--r-- | documentation/ref-manual/variables.rst | 36 |
2 files changed, 14 insertions, 29 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index c2e1c2c29b..6aa09f6d6f 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
| @@ -385,9 +385,7 @@ want to use it because the dependency on ``cdebconf`` is not easily | |||
| 385 | satisfied. Maintainers can explicit the reason that is shown by adding | 385 | satisfied. Maintainers can explicit the reason that is shown by adding |
| 386 | the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. | 386 | the :term:`RECIPE_NO_UPDATE_REASON` variable to the corresponding recipe. |
| 387 | See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` | 387 | See :yocto_git:`base-passwd.bb </poky/tree/meta/recipes-core/base-passwd/base-passwd_3.5.29.bb>` |
| 388 | for an example. | 388 | for an example:: |
| 389 | |||
| 390 | :: | ||
| 391 | 389 | ||
| 392 | $ devtool check-upgrade-status | 390 | $ devtool check-upgrade-status |
| 393 | ... | 391 | ... |
| @@ -555,8 +553,7 @@ Use the ``devtool undeploy-target`` command to remove deployed build | |||
| 555 | output from the target machine. For the ``devtool undeploy-target`` | 553 | output from the target machine. For the ``devtool undeploy-target`` |
| 556 | command to work, you must have previously used the | 554 | command to work, you must have previously used the |
| 557 | ":ref:`devtool deploy-target <ref-manual/devtool-reference:deploying your software on the target machine>`" | 555 | ":ref:`devtool deploy-target <ref-manual/devtool-reference:deploying your software on the target machine>`" |
| 558 | command. | 556 | command:: |
| 559 | :: | ||
| 560 | 557 | ||
| 561 | $ devtool undeploy-target recipe target | 558 | $ devtool undeploy-target recipe target |
| 562 | 559 | ||
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 99100498b7..3190020aaf 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
| @@ -250,8 +250,7 @@ system and gives an overview of their function and contents. | |||
| 250 | Azure Storage Shared Access Signature, when using the | 250 | Azure Storage Shared Access Signature, when using the |
| 251 | :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` | 251 | :ref:`Azure Storage fetcher (az://) <bitbake:bitbake-user-manual/bitbake-user-manual-fetching:fetchers>` |
| 252 | This variable can be defined to be used by the fetcher to authenticate | 252 | This variable can be defined to be used by the fetcher to authenticate |
| 253 | and gain access to non-public artifacts. | 253 | and gain access to non-public artifacts:: |
| 254 | :: | ||
| 255 | 254 | ||
| 256 | AZ_SAS = ""se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>"" | 255 | AZ_SAS = ""se=2021-01-01&sp=r&sv=2018-11-09&sr=c&skoid=<skoid>&sig=<signature>"" |
| 257 | 256 | ||
| @@ -324,8 +323,7 @@ system and gives an overview of their function and contents. | |||
| 324 | 323 | ||
| 325 | - There is limited support for wildcard matching against the beginning of | 324 | - There is limited support for wildcard matching against the beginning of |
| 326 | host names. For example, the following setting matches | 325 | host names. For example, the following setting matches |
| 327 | ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``. | 326 | ``git.gnu.org``, ``ftp.gnu.org``, and ``foo.git.gnu.org``:: |
| 328 | :: | ||
| 329 | 327 | ||
| 330 | BB_ALLOWED_NETWORKS = "*.gnu.org" | 328 | BB_ALLOWED_NETWORKS = "*.gnu.org" |
| 331 | 329 | ||
| @@ -529,8 +527,7 @@ system and gives an overview of their function and contents. | |||
| 529 | 527 | ||
| 530 | For performance reasons, creating and placing tarballs of these | 528 | For performance reasons, creating and placing tarballs of these |
| 531 | repositories is not the default action by the OpenEmbedded build | 529 | repositories is not the default action by the OpenEmbedded build |
| 532 | system. | 530 | system:: |
| 533 | :: | ||
| 534 | 531 | ||
| 535 | BB_GENERATE_MIRROR_TARBALLS = "1" | 532 | BB_GENERATE_MIRROR_TARBALLS = "1" |
| 536 | 533 | ||
| @@ -3020,8 +3017,7 @@ system and gives an overview of their function and contents. | |||
| 3020 | :term:`IMAGE_LINGUAS` appropriately. | 3017 | :term:`IMAGE_LINGUAS` appropriately. |
| 3021 | 3018 | ||
| 3022 | You can set :term:`GLIBC_GENERATE_LOCALES` in your ``local.conf`` file. | 3019 | You can set :term:`GLIBC_GENERATE_LOCALES` in your ``local.conf`` file. |
| 3023 | By default, all locales are generated. | 3020 | By default, all locales are generated:: |
| 3024 | :: | ||
| 3025 | 3021 | ||
| 3026 | GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" | 3022 | GLIBC_GENERATE_LOCALES = "en_GB.UTF-8 en_US.UTF-8" |
| 3027 | 3023 | ||
| @@ -5889,8 +5885,7 @@ system and gives an overview of their function and contents. | |||
| 5889 | 5885 | ||
| 5890 | Consider the following :term:`PACKAGECONFIG` block taken from the | 5886 | Consider the following :term:`PACKAGECONFIG` block taken from the |
| 5891 | ``librsvg`` recipe. In this example the feature is ``gtk``, which has | 5887 | ``librsvg`` recipe. In this example the feature is ``gtk``, which has |
| 5892 | three arguments that determine the feature's behavior. | 5888 | three arguments that determine the feature's behavior:: |
| 5893 | :: | ||
| 5894 | 5889 | ||
| 5895 | PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3" | 5890 | PACKAGECONFIG[gtk] = "--with-gtk3,--without-gtk3,gtk+3" |
| 5896 | 5891 | ||
| @@ -7821,8 +7816,7 @@ system and gives an overview of their function and contents. | |||
| 7821 | If a mirror uses the same structure as | 7816 | If a mirror uses the same structure as |
| 7822 | :term:`SSTATE_DIR`, you need to add "PATH" at the | 7817 | :term:`SSTATE_DIR`, you need to add "PATH" at the |
| 7823 | end as shown in the examples below. The build system substitutes the | 7818 | end as shown in the examples below. The build system substitutes the |
| 7824 | correct path within the directory structure. | 7819 | correct path within the directory structure:: |
| 7825 | :: | ||
| 7826 | 7820 | ||
| 7827 | SSTATE_MIRRORS ?= "\ | 7821 | SSTATE_MIRRORS ?= "\ |
| 7828 | file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \ | 7822 | file://.* https://someserver.tld/share/sstate/PATH;downloadfilename=PATH \ |
| @@ -8616,8 +8610,7 @@ system and gives an overview of their function and contents. | |||
| 8616 | 8610 | ||
| 8617 | Alternatively, you can | 8611 | Alternatively, you can |
| 8618 | provide the "auto" option to have all applicable tests run against | 8612 | provide the "auto" option to have all applicable tests run against |
| 8619 | the image. | 8613 | the image:: |
| 8620 | :: | ||
| 8621 | 8614 | ||
| 8622 | TEST_SUITES:append = " auto" | 8615 | TEST_SUITES:append = " auto" |
| 8623 | 8616 | ||
| @@ -9115,8 +9108,7 @@ system and gives an overview of their function and contents. | |||
| 9115 | releases are not identified by Git tags, set :term:`UPSTREAM_CHECK_COMMITS` | 9108 | releases are not identified by Git tags, set :term:`UPSTREAM_CHECK_COMMITS` |
| 9116 | to ``1`` in the recipe, and the OpenEmbedded build system | 9109 | to ``1`` in the recipe, and the OpenEmbedded build system |
| 9117 | will compare the latest commit with the one currently specified | 9110 | will compare the latest commit with the one currently specified |
| 9118 | by the recipe (:term:`SRCREV`). | 9111 | by the recipe (:term:`SRCREV`):: |
| 9119 | :: | ||
| 9120 | 9112 | ||
| 9121 | UPSTREAM_CHECK_COMMITS = "1" | 9113 | UPSTREAM_CHECK_COMMITS = "1" |
| 9122 | 9114 | ||
| @@ -9129,8 +9121,7 @@ system and gives an overview of their function and contents. | |||
| 9129 | 9121 | ||
| 9130 | You can use the :term:`UPSTREAM_CHECK_GITTAGREGEX` variable to provide a | 9122 | You can use the :term:`UPSTREAM_CHECK_GITTAGREGEX` variable to provide a |
| 9131 | regular expression to filter only the relevant tags should the | 9123 | regular expression to filter only the relevant tags should the |
| 9132 | default filter not work correctly. | 9124 | default filter not work correctly:: |
| 9133 | :: | ||
| 9134 | 9125 | ||
| 9135 | UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" | 9126 | UPSTREAM_CHECK_GITTAGREGEX = "git_tag_regex" |
| 9136 | 9127 | ||
| @@ -9138,8 +9129,7 @@ system and gives an overview of their function and contents. | |||
| 9138 | Use the :term:`UPSTREAM_CHECK_REGEX` variable to specify a different | 9129 | Use the :term:`UPSTREAM_CHECK_REGEX` variable to specify a different |
| 9139 | regular expression instead of the default one when the package | 9130 | regular expression instead of the default one when the package |
| 9140 | checking system is parsing the page found using | 9131 | checking system is parsing the page found using |
| 9141 | :term:`UPSTREAM_CHECK_URI`. | 9132 | :term:`UPSTREAM_CHECK_URI`:: |
| 9142 | :: | ||
| 9143 | 9133 | ||
| 9144 | UPSTREAM_CHECK_REGEX = "package_regex" | 9134 | UPSTREAM_CHECK_REGEX = "package_regex" |
| 9145 | 9135 | ||
| @@ -9150,8 +9140,7 @@ system and gives an overview of their function and contents. | |||
| 9150 | determined by fetching the directory listing where the tarball is and | 9140 | determined by fetching the directory listing where the tarball is and |
| 9151 | attempting to find a later tarball. When this approach does not work, | 9141 | attempting to find a later tarball. When this approach does not work, |
| 9152 | you can use :term:`UPSTREAM_CHECK_URI` to provide a different URI that | 9142 | you can use :term:`UPSTREAM_CHECK_URI` to provide a different URI that |
| 9153 | contains the link to the latest tarball. | 9143 | contains the link to the latest tarball:: |
| 9154 | :: | ||
| 9155 | 9144 | ||
| 9156 | UPSTREAM_CHECK_URI = "recipe_url" | 9145 | UPSTREAM_CHECK_URI = "recipe_url" |
| 9157 | 9146 | ||
| @@ -9162,8 +9151,7 @@ system and gives an overview of their function and contents. | |||
| 9162 | :term:`UPSTREAM_CHECK_GITTAGREGEX` and :term:`UPSTREAM_CHECK_COMMITS` variables in | 9151 | :term:`UPSTREAM_CHECK_GITTAGREGEX` and :term:`UPSTREAM_CHECK_COMMITS` variables in |
| 9163 | the recipe allows to determine what the latest upstream version is, | 9152 | the recipe allows to determine what the latest upstream version is, |
| 9164 | you can set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` in the recipe | 9153 | you can set :term:`UPSTREAM_VERSION_UNKNOWN` to ``1`` in the recipe |
| 9165 | to acknowledge that the check cannot be performed. | 9154 | to acknowledge that the check cannot be performed:: |
| 9166 | :: | ||
| 9167 | 9155 | ||
| 9168 | UPSTREAM_VERSION_UNKNOWN = "1" | 9156 | UPSTREAM_VERSION_UNKNOWN = "1" |
| 9169 | 9157 | ||
