linux-kernel.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Zipeng Zhang <zhangzipeng0@foxmail.com>
To: corbet@lwn.net
Cc: ojeda@kernel.org, alex.gaynor@gmail.com, wedsonaf@gmail.com,
	boqun.feng@gmail.com, gary@garyguo.net, bjorn3_gh@protonmail.com,
	nathan@kernel.org, ndesaulniers@google.com, trix@redhat.com,
	masahiroy@kernel.org, codeagain@codeagain.dev,
	linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
	rust-for-linux@vger.kernel.org, llvm@lists.linux.dev,
	Zipeng Zhang <zhangzipeng0@foxmail.com>
Subject: [PATCH] Documentation/process/changes: Escape --options to fix Sphinx output
Date: Thu, 20 Apr 2023 18:21:31 +0800	[thread overview]
Message-ID: <tencent_CB1A298D31FD221496FF657CD7EF406E6605@qq.com> (raw)

Add an escape character to resolve the problem of
"--version" being displayed as "–version".

Without such escaping, -- is rendered as – (en dash).

Signed-off-by: Zipeng Zhang <zhangzipeng0@foxmail.com>
---
 Documentation/process/changes.rst | 38 +++++++++++++++----------------
 1 file changed, 19 insertions(+), 19 deletions(-)

diff --git a/Documentation/process/changes.rst b/Documentation/process/changes.rst
index ef540865ad22..2d2747e1964a 100644
--- a/Documentation/process/changes.rst
+++ b/Documentation/process/changes.rst
@@ -29,17 +29,17 @@ you probably needn't concern yourself with pcmciautils.
 ====================== ===============  ========================================
         Program        Minimal version       Command to check the version
 ====================== ===============  ========================================
-GNU C                  5.1              gcc --version
-Clang/LLVM (optional)  11.0.0           clang --version
-Rust (optional)        1.62.0           rustc --version
-bindgen (optional)     0.56.0           bindgen --version
-GNU make               3.82             make --version
-bash                   4.2              bash --version
+GNU C                  5.1              gcc \--version
+Clang/LLVM (optional)  11.0.0           clang \--version
+Rust (optional)        1.62.0           rustc \--version
+bindgen (optional)     0.56.0           bindgen \--version
+GNU make               3.82             make \--version
+bash                   4.2              bash \--version
 binutils               2.25             ld -v
-flex                   2.5.35           flex --version
-bison                  2.0              bison --version
-pahole                 1.16             pahole --version
-util-linux             2.10o            fdformat --version
+flex                   2.5.35           flex \--version
+bison                  2.0              bison \--version
+pahole                 1.16             pahole \--version
+util-linux             2.10o            fdformat \--version
 kmod                   13               depmod -V
 e2fsprogs              1.41.4           e2fsck -V
 jfsutils               1.1.3            fsck.jfs -V
@@ -49,17 +49,17 @@ 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
-udev                   081              udevd --version
-grub                   0.93             grub --version || grub-install --version
-mcelog                 0.6              mcelog --version
+PPP                    2.4.0            pppd \--version
+nfs-utils              1.0.5            showmount \--version
+procps                 3.2.0            ps \--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.7              sphinx-build --version
-cpio                   any              cpio --version
+bc                     1.06.95          bc \--version
+Sphinx\ [#f1]_         1.7              sphinx-build \--version
+cpio                   any              cpio \--version
 ====================== ===============  ========================================
 
 .. [#f1] Sphinx is needed only to build the Kernel documentation
-- 
2.39.2


             reply	other threads:[~2023-04-20 14:42 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-04-20 10:21 Zipeng Zhang [this message]
2023-04-20 13:51 ` [PATCH] Documentation/process/changes: Escape --options to fix Sphinx output Jonathan Corbet
2023-04-20 15:40   ` Jonathan Corbet
2023-04-20 17:16     ` Miguel Ojeda
2023-04-22  3:39     ` Akira Yokosawa
2023-04-23 15:55       ` Jonathan Corbet

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=tencent_CB1A298D31FD221496FF657CD7EF406E6605@qq.com \
    --to=zhangzipeng0@foxmail.com \
    --cc=alex.gaynor@gmail.com \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=codeagain@codeagain.dev \
    --cc=corbet@lwn.net \
    --cc=gary@garyguo.net \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=llvm@lists.linux.dev \
    --cc=masahiroy@kernel.org \
    --cc=nathan@kernel.org \
    --cc=ndesaulniers@google.com \
    --cc=ojeda@kernel.org \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=trix@redhat.com \
    --cc=wedsonaf@gmail.com \
    /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).