From: Jani Nikula <jani.nikula@intel.com>
To: Lukas Bulwahn <lukas.bulwahn@gmail.com>,
Jonathan Corbet <corbet@lwn.net>,
workflows@vger.kernel.org, linux-doc@vger.kernel.org
Cc: kernel-janitors@vger.kernel.org, linux-kernel@vger.kernel.org,
Lukas Bulwahn <lukas.bulwahn@gmail.com>
Subject: Re: [PATCH] docs: submit-checklist: structure by category
Date: Mon, 26 Feb 2024 14:48:36 +0200 [thread overview]
Message-ID: <87o7c3mlwb.fsf@intel.com> (raw)
In-Reply-To: <20240226104653.54877-1-lukas.bulwahn@gmail.com>
On Mon, 26 Feb 2024, Lukas Bulwahn <lukas.bulwahn@gmail.com> wrote:
> diff --git a/Documentation/process/submit-checklist.rst b/Documentation/process/submit-checklist.rst
> index b1bc2d37bd0a..7d8dba942fe8 100644
> --- a/Documentation/process/submit-checklist.rst
> +++ b/Documentation/process/submit-checklist.rst
> @@ -11,110 +11,121 @@ These are all above and beyond the documentation that is provided in
> and elsewhere regarding submitting Linux kernel patches.
>
>
> +*Review your code:*
If you're adding subheadings, maybe consider making them actual
subheadings instead of just italicizing them.
The top heading should probably be modified to follow the guidelines in
Documentation/doc-guide/sphinx.rst. This should be a separate change.
> +
> 1) If you use a facility then #include the file that defines/declares
> that facility. Don't depend on other header files pulling in ones
> that you use.
>
> -2) Builds cleanly:
> +2) Check your patch for general style as detailed in
> + :ref:`Documentation/process/coding-style.rst <codingstyle>`.
>
> - a) with applicable or modified ``CONFIG`` options ``=y``, ``=m``, and
> - ``=n``. No ``gcc`` warnings/errors, no linker warnings/errors.
> +3) All memory barriers {e.g., ``barrier()``, ``rmb()``, ``wmb()``} need a
> + comment in the source code that explains the logic of what they are doing
> + and why.
I think we should just remove all the manually updated bullet
numbering. Either make them bulleted lists with "*" or autonumbered
lists with "#.". See [1]. This should be a separate change.
BR,
Jani.
[1] https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#lists-and-quote-like-blocks
--
Jani Nikula, Intel
next prev parent reply other threads:[~2024-02-26 12:48 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-02-26 10:46 [PATCH] docs: submit-checklist: structure by category Lukas Bulwahn
2024-02-26 12:48 ` Jani Nikula [this message]
2024-02-27 7:28 ` Lukas Bulwahn
2024-02-27 0:41 ` Randy Dunlap
2024-02-27 8:04 ` Lukas Bulwahn
2024-02-27 8:57 ` Geert Uytterhoeven
2024-02-27 11:03 ` Lukas Bulwahn
2024-02-27 11:24 ` Geert Uytterhoeven
2024-02-28 21:57 ` Jonathan Corbet
2024-02-28 23:03 ` Randy Dunlap
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=87o7c3mlwb.fsf@intel.com \
--to=jani.nikula@intel.com \
--cc=corbet@lwn.net \
--cc=kernel-janitors@vger.kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=lukas.bulwahn@gmail.com \
--cc=workflows@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;
as well as URLs for NNTP newsgroup(s).