linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>
To: linux-doc@vger.kernel.org
Cc: "Jonathan Neuschäfer" <j.neuschaefer@gmx.net>,
	"Jonathan Corbet" <corbet@lwn.net>,
	"Andi Kleen" <ak@linux.intel.com>,
	"Thomas Gleixner" <tglx@linutronix.de>,
	"Randy Dunlap" <rdunlap@infradead.org>,
	"Darrick J. Wong" <darrick.wong@oracle.com>,
	"Arnd Bergmann" <arnd@arndb.de>,
	"Chang S. Bae" <chang.seok.bae@intel.com>,
	linux-kernel@vger.kernel.org
Subject: [PATCH] docs: process: changes.rst: Escape --version to fix Sphinx output
Date: Sun, 23 Feb 2020 23:22:27 +0100	[thread overview]
Message-ID: <20200223222228.27089-1-j.neuschaefer@gmx.net> (raw)

Without double-backticks, Sphinx wrongly turns "--version" into
"–version" with a Unicode EN DASH (U+2013), that is visually easy to
confuse with a single ASCII dash.

Signed-off-by: Jonathan Neuschäfer <j.neuschaefer@gmx.net>
---
 Documentation/process/changes.rst | 52 +++++++++++++++----------------
 1 file changed, 26 insertions(+), 26 deletions(-)

diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index e47863575917..0aa765736b73 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -29,32 +29,32 @@ you probably needn't concern yourself with pcmciautils.
 ====================== ===============  ========================================
         Program        Minimal version       Command to check the version
 ====================== ===============  ========================================
-GNU C                  4.6              gcc --version
-GNU make               3.81             make --version
-binutils               2.21             ld -v
-flex                   2.5.35           flex --version
-bison                  2.0              bison --version
-util-linux             2.10o            fdformat --version
-kmod                   13               depmod -V
-e2fsprogs              1.41.4           e2fsck -V
-jfsutils               1.1.3            fsck.jfs -V
-reiserfsprogs          3.6.3            reiserfsck -V
-xfsprogs               2.6.0            xfs_db -V
-squashfs-tools         4.0              mksquashfs -version
-btrfs-progs            0.18             btrfsck
-pcmciautils            004              pccardctl -V
-quota-tools            3.09             quota -V
-PPP                    2.4.0            pppd --version
-nfs-utils              1.0.5            showmount --version
-procps                 3.2.0            ps --version
-oprofile               0.9              oprofiled --version
-udev                   081              udevd --version
-grub                   0.93             grub --version || grub-install --version
-mcelog                 0.6              mcelog --version
-iptables               1.4.2            iptables -V
-openssl & libcrypto    1.0.0            openssl version
-bc                     1.06.95          bc --version
-Sphinx\ [#f1]_	       1.3		sphinx-build --version
+GNU C                  4.6              ``gcc --version``
+GNU make               3.81             ``make --version``
+binutils               2.21             ``ld -v``
+flex                   2.5.35           ``flex --version``
+bison                  2.0              ``bison --version``
+util-linux             2.10o            ``fdformat --version``
+kmod                   13               ``depmod -V``
+e2fsprogs              1.41.4           ``e2fsck -V``
+jfsutils               1.1.3            ``fsck.jfs -V``
+reiserfsprogs          3.6.3            ``reiserfsck -V``
+xfsprogs               2.6.0            ``xfs_db -V``
+squashfs-tools         4.0              ``mksquashfs -version``
+btrfs-progs            0.18             ``btrfsck``
+pcmciautils            004              ``pccardctl -V``
+quota-tools            3.09             ``quota -V``
+PPP                    2.4.0            ``pppd --version``
+nfs-utils              1.0.5            ``showmount --version``
+procps                 3.2.0            ``ps --version``
+oprofile               0.9              ``oprofiled --version``
+udev                   081              ``udevd --version``
+grub                   0.93             ``grub --version || grub-install --version``
+mcelog                 0.6              ``mcelog --version``
+iptables               1.4.2            ``iptables -V``
+openssl & libcrypto    1.0.0            ``openssl version``
+bc                     1.06.95          ``bc --version``
+Sphinx\ [#f1]_	       1.3		``sphinx-build --version``
 ====================== ===============  ========================================

 .. [#f1] Sphinx is needed only to build the Kernel documentation
--
2.20.1


             reply	other threads:[~2020-02-23 22:23 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-23 22:22 Jonathan Neuschäfer [this message]
2020-02-24 18:08 ` [PATCH] docs: process: changes.rst: Escape --version to fix Sphinx output Jonathan Corbet
2020-02-24 18:47   ` Jonathan Neuschäfer
2020-02-24 18:52     ` Matthew Wilcox
2020-02-24 18:58       ` Jonathan Corbet
2020-02-24 19:12         ` Matthew Wilcox
2020-02-24 21:08           ` Randy Dunlap
2020-02-24 21:10             ` Matthew Wilcox
2020-02-25  9:15               ` Jani Nikula

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200223222228.27089-1-j.neuschaefer@gmx.net \
    --to=j.neuschaefer@gmx.net \
    --cc=ak@linux.intel.com \
    --cc=arnd@arndb.de \
    --cc=chang.seok.bae@intel.com \
    --cc=corbet@lwn.net \
    --cc=darrick.wong@oracle.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --cc=tglx@linutronix.de \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).