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>
This commit is contained in:
Michael Opdenacker 2022-03-28 17:37:44 +02:00 committed by Richard Purdie
parent ecab5f3655
commit 325c23cd0f
7 changed files with 13 additions and 13 deletions

View File

@ -281,7 +281,7 @@ The following changes have been made for the Poky distribution:
using the Poky distribution can easily include to enable the same
functionality.
Any recipe that needs to opt-out of having the "--disable-static"
Any recipe that needs to opt-out of having the ``--disable-static``
option specified on the configure command line either because it is
not a supported option for the configure script or because static
libraries are needed should set the following variable::
@ -384,9 +384,9 @@ These additional changes exist:
- The
:ref:`devtool modify <sdk-manual/extensible:use \`\`devtool modify\`\` to modify the source of an existing component>`
command now defaults to extracting the source since that is most
commonly expected. The "-x" or "--extract" options are now no-ops. If
commonly expected. The ``-x`` or ``--extract`` options are now no-ops. If
you wish to provide your own existing source tree, you will now need
to specify either the "-n" or "--no-extract" options when running
to specify either the ``-n`` or ``--no-extract`` options when running
``devtool modify``.
- If the formfactor for a machine is either not supplied or does not

View File

@ -370,7 +370,7 @@ The following changes have been made to Wic:
now the current directory by default instead of the unusual
``/var/tmp/wic``.
The "-o" and "--outdir" options remain unchanged and are used to
The ``-o`` and ``--outdir`` options remain unchanged and are used to
specify your preferred output directory if you do not want to use the
default directory.

View File

@ -60,8 +60,8 @@ New Features / Enhancements in 3.4
- wic enhancements:
- Added erofs filesystem support
- Added --extra-space argument to leave extra space after last partition
- Added --no-fstab-update part option to allow using the stock fstab
- Added ``--extra-space argument`` to leave extra space after last partition
- Added ``--no-fstab-update`` part option to allow using the stock fstab
- bootimg-efi: added Unified Kernel Image option
- bootimg-pcbios: use label provided when formatting a DOS partition
@ -75,7 +75,7 @@ New Features / Enhancements in 3.4
- BitBake enhancements:
- New bitbake-getvar helper command to query a variable value (with history)
- bitbake-layers: layerindex-fetch: add --fetchdir parameter
- bitbake-layers: layerindex-fetch: add ``--fetchdir`` parameter
- bitbake-layers: show-recipes: add skip reason to output
- bitbake-diffsigs: sort diff output for consistency
- Allow setting upstream for local hash equivalence server

View File

@ -550,11 +550,11 @@ descriptions and strategies on how to use these commands:
You need to be in a local branch other than the one you are deleting
in order to delete branch-name.
- *git pull --rebase:* Retrieves information from an upstream Git
- *git pull \-\-rebase*: Retrieves information from an upstream Git
repository and places it in your local Git repository. You use this
command to make sure you are synchronized with the repository from
which you are basing changes (e.g. the "&DISTRO_NAME_NO_CAP;"
branch). The "--rebase" option ensures that any local commits you
branch). The ``--rebase`` option ensures that any local commits you
have in your branch are preserved at the top of your local branch.
- *git push repo-name local-branch:upstream-branch:* Sends

View File

@ -171,7 +171,7 @@ understand what's going on in a way that we can act on in a useful way.
To dive down into a next level of detail, we can use 'perf record'/'perf
report' which will collect profiling data and present it to use using an
interactive text-based UI (or simply as text if we specify --stdio to
interactive text-based UI (or simply as text if we specify ``--stdio`` to
'perf report').
As our first attempt at profiling this workload, we'll simply run 'perf

View File

@ -187,9 +187,9 @@ that either directly or indirectly depend on the installed files (e.g.
- The ``install`` utility. This utility is the preferred method.
- The ``cp`` command with the "--no-preserve=ownership" option.
- The ``cp`` command with the ``--no-preserve=ownership`` option.
- The ``tar`` command with the "--no-same-owner" option. See the
- The ``tar`` command with the ``--no-same-owner`` option. See the
``bin_package.bbclass`` file in the ``meta/classes`` directory of
the :term:`Source Directory` for an example.

View File

@ -239,7 +239,7 @@ Perform the following steps to install Toaster:
$ git clone git://git.yoctoproject.org/poky
$ git checkout &DISTRO_NAME_NO_CAP;
#. Install Toaster dependencies using the --user flag which keeps the
#. Install Toaster dependencies using the ``--user`` flag which keeps the
Python packages isolated from your system-provided packages::
$ cd /var/www/toaster/