diff options
| author | Nicolas Dechesne <nicolas.dechesne@linaro.org> | 2020-07-30 18:19:08 +0200 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-09-16 18:14:07 +0100 |
| commit | 9dfd6e1aa11886e16b63d9418e1de7c7faf00132 (patch) | |
| tree | 66edaab86a1b0e753ac9cd05d5df0b28e40b8ef2 /bitbake/doc | |
| parent | b232a4b50411344ee0e41e0d35ad596cfe81308c (diff) | |
| download | poky-9dfd6e1aa11886e16b63d9418e1de7c7faf00132.tar.gz | |
bitbake: sphinx: fixes all remaining warnings
This patch fixes a handful of remaining warnings reported by Sphinx.
(Bitbake rev: 35fdc18549607e195d424f554e8d4b74e87fd245)
Signed-off-by: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake/doc')
3 files changed, 11 insertions, 11 deletions
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst index 5edf97eaa9..3d3c9b48c2 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-hello.rst | |||
| @@ -287,7 +287,7 @@ Following is the complete "Hello World" example. | |||
| 287 | $ mkdir conf Move to the ``conf`` directory and create a | 287 | $ mkdir conf Move to the ``conf`` directory and create a |
| 288 | ``layer.conf`` file that has the following: BBPATH .= | 288 | ``layer.conf`` file that has the following: BBPATH .= |
| 289 | ":${:term:`LAYERDIR`}" :term:`BBFILES` | 289 | ":${:term:`LAYERDIR`}" :term:`BBFILES` |
| 290 | += "${LAYERDIR}/*.bb" | 290 | += "${LAYERDIR}/\*.bb" |
| 291 | :term:`BBFILE_COLLECTIONS` += "mylayer" | 291 | :term:`BBFILE_COLLECTIONS` += "mylayer" |
| 292 | `BBFILE_PATTERN_mylayer <#var-bb-BBFILE_PATTERN>`__ := | 292 | `BBFILE_PATTERN_mylayer <#var-bb-BBFILE_PATTERN>`__ := |
| 293 | "^${LAYERDIR_RE}/" For information on these variables, click the | 293 | "^${LAYERDIR_RE}/" For information on these variables, click the |
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst index c0eb118eb5..c98b3a9e7f 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | |||
| @@ -973,7 +973,7 @@ Tasks | |||
| 973 | Tasks are BitBake execution units that make up the steps that BitBake | 973 | Tasks are BitBake execution units that make up the steps that BitBake |
| 974 | can run for a given recipe. Tasks are only supported in recipes and | 974 | can run for a given recipe. Tasks are only supported in recipes and |
| 975 | classes (i.e. in ``.bb`` files and files included or inherited from | 975 | classes (i.e. in ``.bb`` files and files included or inherited from |
| 976 | ``.bb`` files). By convention, tasks have names that start with "do_". | 976 | ``.bb`` files). By convention, tasks have names that start with "do\_". |
| 977 | 977 | ||
| 978 | Promoting a Function to a Task | 978 | Promoting a Function to a Task |
| 979 | ------------------------------ | 979 | ------------------------------ |
| @@ -987,8 +987,8 @@ task and declare some dependencies: python do_printdate () { import time | |||
| 987 | print time.strftime('%Y%m%d', time.gmtime()) } addtask printdate after | 987 | print time.strftime('%Y%m%d', time.gmtime()) } addtask printdate after |
| 988 | do_fetch before do_build The first argument to ``addtask`` is the name | 988 | do_fetch before do_build The first argument to ``addtask`` is the name |
| 989 | of the function to promote to a task. If the name does not start with | 989 | of the function to promote to a task. If the name does not start with |
| 990 | "do_", "do_" is implicitly added, which enforces the convention that all | 990 | "do\_", "do\_" is implicitly added, which enforces the convention that all |
| 991 | task names start with "do_". | 991 | task names start with "do\_". |
| 992 | 992 | ||
| 993 | In the previous example, the ``do_printdate`` task becomes a dependency | 993 | In the previous example, the ``do_printdate`` task becomes a dependency |
| 994 | of the ``do_build`` task, which is the default task (i.e. the task run | 994 | of the ``do_build`` task, which is the default task (i.e. the task run |
| @@ -1030,7 +1030,7 @@ Additionally, the ``do_printdate`` task becomes dependent upon the | |||
| 1030 | -c | 1030 | -c |
| 1031 | NBSP | 1031 | NBSP |
| 1032 | task | 1032 | task |
| 1033 | command, you can omit the "do_" prefix as part of the task name. | 1033 | command, you can omit the "do\_" prefix as part of the task name. |
| 1034 | 1034 | ||
| 1035 | You might wonder about the practical effects of using ``addtask`` | 1035 | You might wonder about the practical effects of using ``addtask`` |
| 1036 | without specifying any dependencies as is done in the following example: | 1036 | without specifying any dependencies as is done in the following example: |
| @@ -1714,10 +1714,10 @@ Support for wildcard use in variables varies depending on the context in | |||
| 1714 | which it is used. For example, some variables and file names allow | 1714 | which it is used. For example, some variables and file names allow |
| 1715 | limited use of wildcards through the "``%``" and "``*``" characters. | 1715 | limited use of wildcards through the "``%``" and "``*``" characters. |
| 1716 | Other variables or names support Python's | 1716 | Other variables or names support Python's |
| 1717 | ```glob`https://docs.python.org/3/library/glob.html syntax, | 1717 | `glob <https://docs.python.org/3/library/glob.html>`_ syntax, |
| 1718 | ```fnmatch`https://docs.python.org/3/library/fnmatch.html#module-fnmatch | 1718 | `fnmatch <https://docs.python.org/3/library/fnmatch.html#module-fnmatch>`_ |
| 1719 | syntax, or | 1719 | syntax, or |
| 1720 | ```Regular Expression (re)`https://docs.python.org/3/library/re.html#re | 1720 | `Regular Expression (re) <https://docs.python.org/3/library/re.html#re>`_ |
| 1721 | syntax. | 1721 | syntax. |
| 1722 | 1722 | ||
| 1723 | For variables that have wildcard suport, the documentation describes | 1723 | For variables that have wildcard suport, the documentation describes |
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index d5c07e4aa9..04a69482b9 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | |||
| @@ -51,7 +51,7 @@ overview of their function and contents. | |||
| 51 | - Limited support for the "``*``" wildcard character for matching | 51 | - Limited support for the "``*``" wildcard character for matching |
| 52 | against the beginning of host names exists. For example, the | 52 | against the beginning of host names exists. For example, the |
| 53 | following setting matches ``git.gnu.org``, ``ftp.gnu.org``, and | 53 | following setting matches ``git.gnu.org``, ``ftp.gnu.org``, and |
| 54 | ``foo.git.gnu.org``. BB_ALLOWED_NETWORKS = "*.gnu.org" | 54 | ``foo.git.gnu.org``. BB_ALLOWED_NETWORKS = "\*.gnu.org" |
| 55 | 55 | ||
| 56 | .. note:: | 56 | .. note:: |
| 57 | 57 | ||
| @@ -368,7 +368,7 @@ overview of their function and contents. | |||
| 368 | 368 | ||
| 369 | BB_RUNTASK | 369 | BB_RUNTASK |
| 370 | Contains the name of the currently executing task. The value includes | 370 | Contains the name of the currently executing task. The value includes |
| 371 | the "do_" prefix. For example, if the currently executing task is | 371 | the "do\_" prefix. For example, if the currently executing task is |
| 372 | ``do_config``, the value is "do_config". | 372 | ``do_config``, the value is "do_config". |
| 373 | 373 | ||
| 374 | BB_SCHEDULER | 374 | BB_SCHEDULER |
| @@ -617,7 +617,7 @@ overview of their function and contents. | |||
| 617 | software. | 617 | software. |
| 618 | 618 | ||
| 619 | When specifying recipe files, you can pattern match using Python's | 619 | When specifying recipe files, you can pattern match using Python's |
| 620 | ```glob`https://docs.python.org/3/library/glob.html syntax. | 620 | `glob <https://docs.python.org/3/library/glob.html>`_ syntax. |
| 621 | For details on the syntax, see the documentation by following the | 621 | For details on the syntax, see the documentation by following the |
| 622 | previous link. | 622 | previous link. |
| 623 | 623 | ||
