Re: [PATCH v2 0/3] docs: submit-checklist: structure by category

Jonathan Corbet
2024-03-03T16:00:10Z

Lukas Bulwahn <lukas.bulwahn@gmail.com> writes:

> 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(-)

So I've applied the first two patches, since there doesn't seem to be
any disagreement over those. Once we figure out how we want the
autonumbering to be done, that can go in as well.

Thanks,

jon