diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-03-29 08:46:15 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-06-27 14:55:08 +0100 |
commit | d9adf28c10d4a28538e2f90b97dd8949f28815a6 (patch) | |
tree | 7f1958f696697e52fc848cd398fb53f3c650b3a9 /documentation/dev-manual | |
parent | 0d1d3afa8a09e08b65db8eaa2813bc5621d34806 (diff) | |
download | poky-d9adf28c10d4a28538e2f90b97dd8949f28815a6.tar.gz |
manuals: replace hyphens with em dashes
Fix some hyphens being improperly used as em dashes.
See https://www.grammarly.com/blog/hyphens-and-dashes/
Using em dashes may also allow Sphinx to hyphenate
and break lines in the best way.
Note that the first character after an em dash not
supposed to be capitalized, unless a specific
rule applies, typically when what follows is a proper noun.
Fix a few misuses of parentheses in following text.
(From yocto-docs rev: 5918f019f63f6e820b1168f4cc001faa1d1cdc6f)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
-rw-r--r-- | documentation/dev-manual/common-tasks.rst | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index a6c7ba3ce1..01dac39c6f 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
@@ -2306,7 +2306,7 @@ under ``files``) requires a recipe that has the file listed in the | |||
2306 | :term:`SRC_URI` variable. Additionally, you need to manually write the | 2306 | :term:`SRC_URI` variable. Additionally, you need to manually write the |
2307 | ``do_compile`` and ``do_install`` tasks. The :term:`S` variable defines the | 2307 | ``do_compile`` and ``do_install`` tasks. The :term:`S` variable defines the |
2308 | directory containing the source code, which is set to | 2308 | directory containing the source code, which is set to |
2309 | :term:`WORKDIR` in this case - the | 2309 | :term:`WORKDIR` in this case --- the |
2310 | directory BitBake uses for the build. | 2310 | directory BitBake uses for the build. |
2311 | :: | 2311 | :: |
2312 | 2312 | ||
@@ -2780,7 +2780,7 @@ in the BitBake User Manual. | |||
2780 | functionality. The same considerations apply to various system | 2780 | functionality. The same considerations apply to various system |
2781 | utilities (e.g. ``sed``, ``grep``, ``awk``, and so forth) that you | 2781 | utilities (e.g. ``sed``, ``grep``, ``awk``, and so forth) that you |
2782 | might wish to use. If in doubt, you should check with multiple | 2782 | might wish to use. If in doubt, you should check with multiple |
2783 | implementations - including those from BusyBox. | 2783 | implementations --- including those from BusyBox. |
2784 | 2784 | ||
2785 | Adding a New Machine | 2785 | Adding a New Machine |
2786 | ==================== | 2786 | ==================== |
@@ -3348,9 +3348,9 @@ The actual directory depends on several things: | |||
3348 | 3348 | ||
3349 | - :term:`PN`: The recipe name. | 3349 | - :term:`PN`: The recipe name. |
3350 | 3350 | ||
3351 | - :term:`EXTENDPE`: The epoch - (if | 3351 | - :term:`EXTENDPE`: The epoch --- if |
3352 | :term:`PE` is not specified, which is | 3352 | :term:`PE` is not specified, which is |
3353 | usually the case for most recipes, then :term:`EXTENDPE` is blank). | 3353 | usually the case for most recipes, then :term:`EXTENDPE` is blank. |
3354 | 3354 | ||
3355 | - :term:`PV`: The recipe version. | 3355 | - :term:`PV`: The recipe version. |
3356 | 3356 | ||
@@ -6602,7 +6602,7 @@ the following: | |||
6602 | installed into an image. | 6602 | installed into an image. |
6603 | 6603 | ||
6604 | - Binary Package Version: The binary package version is composed of two | 6604 | - Binary Package Version: The binary package version is composed of two |
6605 | components - a version and a revision. | 6605 | components --- a version and a revision. |
6606 | 6606 | ||
6607 | .. note:: | 6607 | .. note:: |
6608 | 6608 | ||
@@ -6939,7 +6939,7 @@ optional arguments:: | |||
6939 | Postinstall script to use for all packages | 6939 | Postinstall script to use for all packages |
6940 | (as a string) | 6940 | (as a string) |
6941 | recursive | 6941 | recursive |
6942 | True to perform a recursive search - default | 6942 | True to perform a recursive search --- default |
6943 | False | 6943 | False |
6944 | hook | 6944 | hook |
6945 | A hook function to be called for every match. | 6945 | A hook function to be called for every match. |
@@ -6960,7 +6960,7 @@ optional arguments:: | |||
6960 | Extra runtime dependencies (RDEPENDS) to be | 6960 | Extra runtime dependencies (RDEPENDS) to be |
6961 | set for all packages. The default value of None | 6961 | set for all packages. The default value of None |
6962 | causes a dependency on the main package | 6962 | causes a dependency on the main package |
6963 | (${PN}) - if you do not want this, pass empty | 6963 | (${PN}) --- if you do not want this, pass empty |
6964 | string '' for this parameter. | 6964 | string '' for this parameter. |
6965 | aux_files_pattern | 6965 | aux_files_pattern |
6966 | Extra item(s) to be added to FILES for each | 6966 | Extra item(s) to be added to FILES for each |
@@ -6986,7 +6986,7 @@ optional arguments:: | |||
6986 | or a list of strings for multiple items. Must | 6986 | or a list of strings for multiple items. Must |
6987 | include %s. | 6987 | include %s. |
6988 | allow_links | 6988 | allow_links |
6989 | True to allow symlinks to be matched - default | 6989 | True to allow symlinks to be matched --- default |
6990 | False | 6990 | False |
6991 | summary | 6991 | summary |
6992 | Summary to set for each package. Must include %s; | 6992 | Summary to set for each package. Must include %s; |
@@ -7431,7 +7431,7 @@ A Package Test (ptest) runs tests against packages built by the | |||
7431 | OpenEmbedded build system on the target machine. A ptest contains at | 7431 | OpenEmbedded build system on the target machine. A ptest contains at |
7432 | least two items: the actual test, and a shell script (``run-ptest``) | 7432 | least two items: the actual test, and a shell script (``run-ptest``) |
7433 | that starts the test. The shell script that starts the test must not | 7433 | that starts the test. The shell script that starts the test must not |
7434 | contain the actual test - the script only starts the test. On the other | 7434 | contain the actual test --- the script only starts the test. On the other |
7435 | hand, the test can be anything from a simple shell script that runs a | 7435 | hand, the test can be anything from a simple shell script that runs a |
7436 | binary and checks the output to an elaborate system of test binaries and | 7436 | binary and checks the output to an elaborate system of test binaries and |
7437 | data files. | 7437 | data files. |
@@ -9132,13 +9132,13 @@ The JSON file must include an object with the test name as keys of an | |||
9132 | object or an array. This object (or array of objects) uses the following | 9132 | object or an array. This object (or array of objects) uses the following |
9133 | data: | 9133 | data: |
9134 | 9134 | ||
9135 | - "pkg" - A mandatory string that is the name of the package to be | 9135 | - "pkg" --- a mandatory string that is the name of the package to be |
9136 | installed. | 9136 | installed. |
9137 | 9137 | ||
9138 | - "rm" - An optional boolean, which defaults to "false", that specifies | 9138 | - "rm" --- an optional boolean, which defaults to "false", that specifies |
9139 | to remove the package after the test. | 9139 | to remove the package after the test. |
9140 | 9140 | ||
9141 | - "extract" - An optional boolean, which defaults to "false", that | 9141 | - "extract" --- an optional boolean, which defaults to "false", that |
9142 | specifies if the package must be extracted from the package format. | 9142 | specifies if the package must be extracted from the package format. |
9143 | When set to "true", the package is not automatically installed into | 9143 | When set to "true", the package is not automatically installed into |
9144 | the DUT. | 9144 | the DUT. |
@@ -9803,7 +9803,7 @@ Logging With Bash | |||
9803 | ~~~~~~~~~~~~~~~~~ | 9803 | ~~~~~~~~~~~~~~~~~ |
9804 | 9804 | ||
9805 | When creating recipes using Bash and inserting code that handles build | 9805 | When creating recipes using Bash and inserting code that handles build |
9806 | logs, you have the same goals - informative with minimal console output. | 9806 | logs, you have the same goals --- informative with minimal console output. |
9807 | The syntax you use for recipes written in Bash is similar to that of | 9807 | The syntax you use for recipes written in Bash is similar to that of |
9808 | recipes written in Python described in the previous section. | 9808 | recipes written in Python described in the previous section. |
9809 | 9809 | ||
@@ -10076,7 +10076,7 @@ to use GDB directly on the remote target to debug applications. These | |||
10076 | constraints arise because GDB needs to load the debugging information | 10076 | constraints arise because GDB needs to load the debugging information |
10077 | and the binaries of the process being debugged. Additionally, GDB needs | 10077 | and the binaries of the process being debugged. Additionally, GDB needs |
10078 | to perform many computations to locate information such as function | 10078 | to perform many computations to locate information such as function |
10079 | names, variable names and values, stack traces and so forth - even | 10079 | names, variable names and values, stack traces and so forth --- even |
10080 | before starting the debugging process. These extra computations place | 10080 | before starting the debugging process. These extra computations place |
10081 | more load on the target system and can alter the characteristics of the | 10081 | more load on the target system and can alter the characteristics of the |
10082 | program being debugged. | 10082 | program being debugged. |
@@ -10653,7 +10653,7 @@ Preparing Changes for Submission | |||
10653 | - If the change addresses a specific bug or issue that is associated | 10653 | - If the change addresses a specific bug or issue that is associated |
10654 | with a bug-tracking ID, include a reference to that ID in your | 10654 | with a bug-tracking ID, include a reference to that ID in your |
10655 | detailed description. For example, the Yocto Project uses a | 10655 | detailed description. For example, the Yocto Project uses a |
10656 | specific convention for bug references - any commit that addresses | 10656 | specific convention for bug references --- any commit that addresses |
10657 | a specific bug should use the following form for the detailed | 10657 | a specific bug should use the following form for the detailed |
10658 | description. Be sure to use the actual bug-tracking ID from | 10658 | description. Be sure to use the actual bug-tracking ID from |
10659 | Bugzilla for bug-id:: | 10659 | Bugzilla for bug-id:: |
@@ -10916,20 +10916,20 @@ follows: | |||
10916 | result in the most straightforward path into the stable branch for the | 10916 | result in the most straightforward path into the stable branch for the |
10917 | fix. | 10917 | fix. |
10918 | 10918 | ||
10919 | a. *If the fix is present in the master branch - Submit a backport request | 10919 | a. *If the fix is present in the master branch --- submit a backport request |
10920 | by email:* You should send an email to the relevant stable branch | 10920 | by email:* You should send an email to the relevant stable branch |
10921 | maintainer and the mailing list with details of the bug or CVE to be | 10921 | maintainer and the mailing list with details of the bug or CVE to be |
10922 | fixed, the commit hash on the master branch that fixes the issue and | 10922 | fixed, the commit hash on the master branch that fixes the issue and |
10923 | the stable branches which you would like this fix to be backported to. | 10923 | the stable branches which you would like this fix to be backported to. |
10924 | 10924 | ||
10925 | b. *If the fix is not present in the master branch - Submit the fix to the | 10925 | b. *If the fix is not present in the master branch --- submit the fix to the |
10926 | master branch first:* This will ensure that the fix passes through the | 10926 | master branch first:* This will ensure that the fix passes through the |
10927 | project's usual patch review and test processes before being accepted. | 10927 | project's usual patch review and test processes before being accepted. |
10928 | It will also ensure that bugs are not left unresolved in the master | 10928 | It will also ensure that bugs are not left unresolved in the master |
10929 | branch itself. Once the fix is accepted in the master branch a backport | 10929 | branch itself. Once the fix is accepted in the master branch a backport |
10930 | request can be submitted as above. | 10930 | request can be submitted as above. |
10931 | 10931 | ||
10932 | c. *If the fix is unsuitable for the master branch - Submit a patch | 10932 | c. *If the fix is unsuitable for the master branch --- submit a patch |
10933 | directly for the stable branch:* This method should be considered as a | 10933 | directly for the stable branch:* This method should be considered as a |
10934 | last resort. It is typically necessary when the master branch is using | 10934 | last resort. It is typically necessary when the master branch is using |
10935 | a newer version of the software which includes an upstream fix for the | 10935 | a newer version of the software which includes an upstream fix for the |
@@ -11260,7 +11260,7 @@ Providing the Source Code | |||
11260 | 11260 | ||
11261 | Compliance activities should begin before you generate the final image. | 11261 | Compliance activities should begin before you generate the final image. |
11262 | The first thing you should look at is the requirement that tops the list | 11262 | The first thing you should look at is the requirement that tops the list |
11263 | for most compliance groups - providing the source. The Yocto Project has | 11263 | for most compliance groups --- providing the source. The Yocto Project has |
11264 | a few ways of meeting this requirement. | 11264 | a few ways of meeting this requirement. |
11265 | 11265 | ||
11266 | One of the easiest ways to meet this requirement is to provide the | 11266 | One of the easiest ways to meet this requirement is to provide the |