From: carlodelos90 <carlodelos90@gmail.com>
To: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org, carlodelos90 <carlodelos90@gmail.com>
Subject: [PATCH] docs: Fix backticks in README instructions
Date: Wed, 22 Jan 2025 00:02:13 +0100 [thread overview]
Message-ID: <20250121230213.10701-1-carlodelos90@gmail.com> (raw)
The commands 'make pdfdocs' and make 'htmldocs' were formatted with backticks. which caused confusion in some contexts, like GitHub. However, using tripple backticks is not universally compatible.
This patch replaces backticks with normal quotes to ensure clarity and compatibility across all rendering contexts.
Signed-off-by: Carlo K <carlodelos90@gmail.com>
---
README | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/README b/README
index fd903645e6de..c1d280c622e9 100644
--- a/README
+++ b/README
@@ -5,8 +5,8 @@ There are several guides for kernel developers and users. These guides can
be rendered in a number of formats, like HTML and PDF. Please read
Documentation/admin-guide/README.rst first.
-In order to build the documentation, use ``make htmldocs`` or
-``make pdfdocs``. The formatted documentation can also be read online at:
+In order to build the documentation, use "make htmldocs" or
+"make pdfdocs". The formatted documentation can also be read online at:
https://www.kernel.org/doc/html/latest/
--
2.39.5 (Apple Git-154)
next reply other threads:[~2025-01-21 23:02 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-21 23:02 carlodelos90 [this message]
2025-01-22 9:26 ` [PATCH] docs: Fix backticks in README instructions Akira Yokosawa
2025-01-22 16:54 ` Jonathan Corbet
-- strict thread matches above, loose matches on Subject: below --
2025-01-21 0:30 carlodelos90
2025-01-21 3:43 ` Akira Yokosawa
2025-01-21 19:14 ` 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=20250121230213.10701-1-carlodelos90@gmail.com \
--to=carlodelos90@gmail.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
/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