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: <bffb09b8-8e9d-471c-871c-2fb3605dc7ed@gmail.com>
Date: Tue, 21 Jan 2025 12:43:59 +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>
Subject: Re: [PATCH] docs: Fix backticks in README instructions

Hello,

carlodelos90 wrote:
> The commands `make pdfdocs` and `make htmldocs` were incorrectly formatted
> with only two backticks, which caused confusion and didn't render properly
> in some contexts.

Do you mean:

... One example is GitHub where top-level README is assumed to be in
the GitHub dialect of Markdown.

???

>                   This change updates the documentation to use triple
> backticks for consistency and clarity.

Obviously, triple backticks don't work in other contexts.

So your "fix" breaks assumption of others.

I think GitHub can render its README pane in reST format if you add a
symlink of README.rst -> README.  No?

> 
> Signed-off-by: carlodelos90 <carlodelos90@...il.com>

Do You normally sign a contract using the name of "carlodelos90"?

Signed-off-by should be regarded as a formal statement that you
have the right to submit a patch.

See "Sign your work - the Developer’s Certificate of Origin"
in Documentation/process/submitting-patches.rst.

In your future submissions, please use your real name for signing off
unless you have a good reason not to do so.

I'm not sure if adding a symlink for the sake of GitHub compatibility
is acceptable or not.  But it looks to me worth an attempt at least.

        Thanks, Akira