All of lore.kernel.org
 help / color / mirror / Atom feed
From: Lukas Bulwahn <lukas.bulwahn@gmail.com>
To: Jonathan Corbet <corbet@lwn.net>,
	Jani Nikula <jani.nikula@intel.com>,
	Randy Dunlap <rdunlap@infradead.org>,
	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: [PATCH v2 0/3] docs: submit-checklist: structure by category
Date: Thu, 29 Feb 2024 04:07:40 +0100	[thread overview]
Message-ID: <20240229030743.9125-1-lukas.bulwahn@gmail.com> (raw)

Dear Jonathan,

this v2 series addresses all review feedback of the patch v1 here:

  https://lore.kernel.org/linux-doc/20240226104653.54877-1-lukas.bulwahn@gmail.com/

Immediate actionable review feedback was:

from Jani Nikula:
  - turn categories into subheadings
  - use common heading adornment
  - change to bullet or autonumbered lists
  - propose those changes as separate additional patches

from Randy Dunlap:
  - if subheadings, drop the colons at the end.
  - acked change to test with linux-next
  - Stephen Rothwell requested item 1 to stay item 1.
  - pointed out swapping the config names in the commit message.

v1 -> v2:
The commit message of patch 1/3 is improved addressing Randy's
feedback on the commit message.
The diff itself of patch 1/3 is unchanged.

Patch 2/3 and 3/3 addresses Jani's and Randy's feedback.

The extended discussion and feedback was:

  - Is the checkstack script worth mentioning or can it be replaced?
  - missing some nowadays more important points.
  - consider getting it coherent with submitting-patches.rst

I have put the extended feedback onto my todo list; for the next
iteration on this document---after cleaning up submitting-patches and
making the howto and submitting-patches more coherent.

I followed Jani's request and created three patches, this might help
in the next/final review---if any further review happens now.

However, I do not think the kernel repository needs to be swamped with
three patches for this 'logically one change' to a single document. So,
I also squashed the three patches back into one patch, sent out as
PATCH v2-squashed:

  https://lore.kernel.org/linux-doc/20240229030146.8418-1-lukas.bulwahn@gmail.com/

Please either pick this patch series or just the PATCH v2-squashed as
you see fit.

Lukas Bulwahn (3):
  docs: submit-checklist: structure by category
  docs: submit-checklist: use subheadings
  docs: submit-checklist: change to autonumbered lists

 Documentation/process/submit-checklist.rst | 163 +++++++++++----------
 1 file changed, 88 insertions(+), 75 deletions(-)

-- 
2.43.2


             reply	other threads:[~2024-02-29  3:07 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-02-29  3:07 Lukas Bulwahn [this message]
2024-02-29  3:07 ` [PATCH v2 1/3] docs: submit-checklist: structure by category Lukas Bulwahn
2024-02-29  3:07 ` [PATCH v2 2/3] docs: submit-checklist: use subheadings Lukas Bulwahn
2024-02-29  6:04   ` Randy Dunlap
2024-02-29  3:07 ` [PATCH v2 3/3] docs: submit-checklist: change to autonumbered lists Lukas Bulwahn
2024-02-29  6:06   ` Randy Dunlap
2024-02-29  7:52   ` Akira Yokosawa
2024-03-03 15:55     ` Jonathan Corbet
2024-03-03 18:19       ` Randy Dunlap
2024-03-04  1:14       ` Akira Yokosawa
2024-02-29 10:25 ` [PATCH v2 0/3] docs: submit-checklist: structure by category Jani Nikula
2024-02-29 10:36   ` Lukas Bulwahn
2024-03-03 16:00 ` 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=20240229030743.9125-1-lukas.bulwahn@gmail.com \
    --to=lukas.bulwahn@gmail.com \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@intel.com \
    --cc=kernel-janitors@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=rdunlap@infradead.org \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.