linux-kernel - [PATCH] docs: Fix backticks in README instructions

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20250121230213.10701-1-carlodelos90@gmail.com>
Date: Wed, 22 Jan 2025 00:02:13 +0100
From: carlodelos90 <carlodelos90@...il.com>
To: linux-doc@...r.kernel.org
Cc: linux-kernel@...r.kernel.org,
	carlodelos90 <carlodelos90@...il.com>
Subject: [PATCH] docs: Fix backticks in README instructions

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@...il.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)