linux-kernel - Re: [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-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <e7acb5c7-58f6-4b06-a339-83825780b71f@gmail.com>
Date: Wed, 22 Jan 2025 18:26:02 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: carlodelos90@...il.com
Cc: linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 Akira Yokosawa <akiyks@...il.com>, Jonathan Corbet <corbet@....net>
Subject: Re: [PATCH] docs: Fix backticks in README instructions

[+CC: Jon]
Hi,

Not a comment on the patch contents, just nitpicking.

carlodelos90 wrote:
> 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>

I'd suggest you to run scripts/checkpatch.pl on your patch.
It is good in catching issues in patches especially from new contributors.

Besides that, you have failed to denote a patch version.

I'd say [PATCH v2] in the subject of this patch.  Next one will be v3.

As we are in the middle of the merge window, I'd suggest you to take
some time and skim through documents under Documentation/process/,
especially submitting-patches.rst and submit-checklist.rst among others,
before submitting a v3.

Questions are always welcome!

Thanks, Akira