diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-03-28 17:37:44 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-03-31 11:46:03 +0100 |
commit | 325c23cd0f80456111ce886af141501a8a74282c (patch) | |
tree | 31096b4dead9592103a6add952c8f57b372e8285 /documentation | |
parent | ecab5f36555d50ac35eaafd3b56a9a67086be77e (diff) | |
download | poky-325c23cd0f80456111ce886af141501a8a74282c.tar.gz |
manuals: fix quoting of double dashes
Otherwise rendered as "en" dashes by sphinx, for example:
git pull –rebase
instead of
git pull --rebase
Readers could confuse them with normal dashes.
Exception: replace by \-\- in italic text (*text*)
as Sphinx cannot nest italic and quoted text.
For consistency, also update quoting in strings in the same code hunks.
(From yocto-docs rev: 4e7ce372e37f76148f623a5295a15e08bc2603ff)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r-- | documentation/migration-guides/migration-2.1.rst | 6 | ||||
-rw-r--r-- | documentation/migration-guides/migration-2.3.rst | 2 | ||||
-rw-r--r-- | documentation/migration-guides/release-notes-3.4.rst | 6 | ||||
-rw-r--r-- | documentation/overview-manual/development-environment.rst | 4 | ||||
-rw-r--r-- | documentation/profile-manual/usage.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/tasks.rst | 4 | ||||
-rw-r--r-- | documentation/toaster-manual/setup-and-use.rst | 2 |
7 files changed, 13 insertions, 13 deletions
diff --git a/documentation/migration-guides/migration-2.1.rst b/documentation/migration-guides/migration-2.1.rst index eb29694bb5..ae6268d509 100644 --- a/documentation/migration-guides/migration-2.1.rst +++ b/documentation/migration-guides/migration-2.1.rst | |||
@@ -281,7 +281,7 @@ The following changes have been made for the Poky distribution: | |||
281 | using the Poky distribution can easily include to enable the same | 281 | using the Poky distribution can easily include to enable the same |
282 | functionality. | 282 | functionality. |
283 | 283 | ||
284 | Any recipe that needs to opt-out of having the "--disable-static" | 284 | Any recipe that needs to opt-out of having the ``--disable-static`` |
285 | option specified on the configure command line either because it is | 285 | option specified on the configure command line either because it is |
286 | not a supported option for the configure script or because static | 286 | not a supported option for the configure script or because static |
287 | libraries are needed should set the following variable:: | 287 | libraries are needed should set the following variable:: |
@@ -384,9 +384,9 @@ These additional changes exist: | |||
384 | - The | 384 | - The |
385 | :ref:`devtool modify <sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component>` | 385 | :ref:`devtool modify <sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component>` |
386 | command now defaults to extracting the source since that is most | 386 | command now defaults to extracting the source since that is most |
387 | commonly expected. The "-x" or "--extract" options are now no-ops. If | 387 | commonly expected. The ``-x`` or ``--extract`` options are now no-ops. If |
388 | you wish to provide your own existing source tree, you will now need | 388 | you wish to provide your own existing source tree, you will now need |
389 | to specify either the "-n" or "--no-extract" options when running | 389 | to specify either the ``-n`` or ``--no-extract`` options when running |
390 | ``devtool modify``. | 390 | ``devtool modify``. |
391 | 391 | ||
392 | - If the formfactor for a machine is either not supplied or does not | 392 | - If the formfactor for a machine is either not supplied or does not |
diff --git a/documentation/migration-guides/migration-2.3.rst b/documentation/migration-guides/migration-2.3.rst index 59271abbc0..d49ed474ca 100644 --- a/documentation/migration-guides/migration-2.3.rst +++ b/documentation/migration-guides/migration-2.3.rst | |||
@@ -370,7 +370,7 @@ The following changes have been made to Wic: | |||
370 | now the current directory by default instead of the unusual | 370 | now the current directory by default instead of the unusual |
371 | ``/var/tmp/wic``. | 371 | ``/var/tmp/wic``. |
372 | 372 | ||
373 | The "-o" and "--outdir" options remain unchanged and are used to | 373 | The ``-o`` and ``--outdir`` options remain unchanged and are used to |
374 | specify your preferred output directory if you do not want to use the | 374 | specify your preferred output directory if you do not want to use the |
375 | default directory. | 375 | default directory. |
376 | 376 | ||
diff --git a/documentation/migration-guides/release-notes-3.4.rst b/documentation/migration-guides/release-notes-3.4.rst index 927de6dc0c..5a8fb4b5a9 100644 --- a/documentation/migration-guides/release-notes-3.4.rst +++ b/documentation/migration-guides/release-notes-3.4.rst | |||
@@ -60,8 +60,8 @@ New Features / Enhancements in 3.4 | |||
60 | - wic enhancements: | 60 | - wic enhancements: |
61 | 61 | ||
62 | - Added erofs filesystem support | 62 | - Added erofs filesystem support |
63 | - Added --extra-space argument to leave extra space after last partition | 63 | - Added ``--extra-space argument`` to leave extra space after last partition |
64 | - Added --no-fstab-update part option to allow using the stock fstab | 64 | - Added ``--no-fstab-update`` part option to allow using the stock fstab |
65 | - bootimg-efi: added Unified Kernel Image option | 65 | - bootimg-efi: added Unified Kernel Image option |
66 | - bootimg-pcbios: use label provided when formatting a DOS partition | 66 | - bootimg-pcbios: use label provided when formatting a DOS partition |
67 | 67 | ||
@@ -75,7 +75,7 @@ New Features / Enhancements in 3.4 | |||
75 | - BitBake enhancements: | 75 | - BitBake enhancements: |
76 | 76 | ||
77 | - New bitbake-getvar helper command to query a variable value (with history) | 77 | - New bitbake-getvar helper command to query a variable value (with history) |
78 | - bitbake-layers: layerindex-fetch: add --fetchdir parameter | 78 | - bitbake-layers: layerindex-fetch: add ``--fetchdir`` parameter |
79 | - bitbake-layers: show-recipes: add skip reason to output | 79 | - bitbake-layers: show-recipes: add skip reason to output |
80 | - bitbake-diffsigs: sort diff output for consistency | 80 | - bitbake-diffsigs: sort diff output for consistency |
81 | - Allow setting upstream for local hash equivalence server | 81 | - Allow setting upstream for local hash equivalence server |
diff --git a/documentation/overview-manual/development-environment.rst b/documentation/overview-manual/development-environment.rst index 8ffa8c7e3e..19095fc116 100644 --- a/documentation/overview-manual/development-environment.rst +++ b/documentation/overview-manual/development-environment.rst | |||
@@ -550,11 +550,11 @@ descriptions and strategies on how to use these commands: | |||
550 | You need to be in a local branch other than the one you are deleting | 550 | You need to be in a local branch other than the one you are deleting |
551 | in order to delete branch-name. | 551 | in order to delete branch-name. |
552 | 552 | ||
553 | - *git pull --rebase:* Retrieves information from an upstream Git | 553 | - *git pull \-\-rebase*: Retrieves information from an upstream Git |
554 | repository and places it in your local Git repository. You use this | 554 | repository and places it in your local Git repository. You use this |
555 | command to make sure you are synchronized with the repository from | 555 | command to make sure you are synchronized with the repository from |
556 | which you are basing changes (e.g. the "&DISTRO_NAME_NO_CAP;" | 556 | which you are basing changes (e.g. the "&DISTRO_NAME_NO_CAP;" |
557 | branch). The "--rebase" option ensures that any local commits you | 557 | branch). The ``--rebase`` option ensures that any local commits you |
558 | have in your branch are preserved at the top of your local branch. | 558 | have in your branch are preserved at the top of your local branch. |
559 | 559 | ||
560 | - *git push repo-name local-branch:upstream-branch:* Sends | 560 | - *git push repo-name local-branch:upstream-branch:* Sends |
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst index 56f1e66674..fb1553d70d 100644 --- a/documentation/profile-manual/usage.rst +++ b/documentation/profile-manual/usage.rst | |||
@@ -171,7 +171,7 @@ understand what's going on in a way that we can act on in a useful way. | |||
171 | 171 | ||
172 | To dive down into a next level of detail, we can use 'perf record'/'perf | 172 | To dive down into a next level of detail, we can use 'perf record'/'perf |
173 | report' which will collect profiling data and present it to use using an | 173 | report' which will collect profiling data and present it to use using an |
174 | interactive text-based UI (or simply as text if we specify --stdio to | 174 | interactive text-based UI (or simply as text if we specify ``--stdio`` to |
175 | 'perf report'). | 175 | 'perf report'). |
176 | 176 | ||
177 | As our first attempt at profiling this workload, we'll simply run 'perf | 177 | As our first attempt at profiling this workload, we'll simply run 'perf |
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst index b51462b79a..a2b8763e7c 100644 --- a/documentation/ref-manual/tasks.rst +++ b/documentation/ref-manual/tasks.rst | |||
@@ -187,9 +187,9 @@ that either directly or indirectly depend on the installed files (e.g. | |||
187 | 187 | ||
188 | - The ``install`` utility. This utility is the preferred method. | 188 | - The ``install`` utility. This utility is the preferred method. |
189 | 189 | ||
190 | - The ``cp`` command with the "--no-preserve=ownership" option. | 190 | - The ``cp`` command with the ``--no-preserve=ownership`` option. |
191 | 191 | ||
192 | - The ``tar`` command with the "--no-same-owner" option. See the | 192 | - The ``tar`` command with the ``--no-same-owner`` option. See the |
193 | ``bin_package.bbclass`` file in the ``meta/classes`` directory of | 193 | ``bin_package.bbclass`` file in the ``meta/classes`` directory of |
194 | the :term:`Source Directory` for an example. | 194 | the :term:`Source Directory` for an example. |
195 | 195 | ||
diff --git a/documentation/toaster-manual/setup-and-use.rst b/documentation/toaster-manual/setup-and-use.rst index 0da8326926..1e1a314d66 100644 --- a/documentation/toaster-manual/setup-and-use.rst +++ b/documentation/toaster-manual/setup-and-use.rst | |||
@@ -239,7 +239,7 @@ Perform the following steps to install Toaster: | |||
239 | $ git clone git://git.yoctoproject.org/poky | 239 | $ git clone git://git.yoctoproject.org/poky |
240 | $ git checkout &DISTRO_NAME_NO_CAP; | 240 | $ git checkout &DISTRO_NAME_NO_CAP; |
241 | 241 | ||
242 | #. Install Toaster dependencies using the --user flag which keeps the | 242 | #. Install Toaster dependencies using the ``--user`` flag which keeps the |
243 | Python packages isolated from your system-provided packages:: | 243 | Python packages isolated from your system-provided packages:: |
244 | 244 | ||
245 | $ cd /var/www/toaster/ | 245 | $ cd /var/www/toaster/ |