From: Akira Yokosawa <akiyks@gmail.com>
To: carlodelos90@gmail.com
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Akira Yokosawa <akiyks@gmail.com>,
Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH] docs: Fix backticks in README instructions
Date: Wed, 22 Jan 2025 18:26:02 +0900 [thread overview]
Message-ID: <e7acb5c7-58f6-4b06-a339-83825780b71f@gmail.com> (raw)
In-Reply-To: <20250121230213.10701-1-carlodelos90@gmail.com>
[+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@gmail.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
next prev parent reply other threads:[~2025-01-22 9:26 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-01-21 23:02 [PATCH] docs: Fix backticks in README instructions carlodelos90
2025-01-22 9:26 ` Akira Yokosawa [this message]
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=e7acb5c7-58f6-4b06-a339-83825780b71f@gmail.com \
--to=akiyks@gmail.com \
--cc=carlodelos90@gmail.com \
--cc=corbet@lwn.net \
--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