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/migration-guides | |
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/migration-guides')
-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 |
3 files changed, 7 insertions, 7 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 |