Re: [docs] [PATCH] contributor-guide/submit-changes: encourage patch version changelogs

Antonin Godard
2025-03-24T08:03:31Z

Hi Trevor,

On Fri Mar 21, 2025 at 5:51 PM CET, Trevor Woerner wrote:
[...]
>> > + ---
>> > + changes in v4:
>> > + - provide a clearer commit message
>> > + - fix spelling mistakes
>> > +
>> > + changes in v3:
>> > + - replace func() to use other_func() instead
>> > +
>> > + changes in v2:
>> > + - added
>>
>> "added return value check for func"?
>> to give a more concrete example
>
> It's not uncommon for the v1 series to have N patches, and the v2 series to
> have >N patches; in which case one or more patches were added in v2. This
> isn't a really bad commit log where the author forgets to say what they added,
> it's a message saying "this patch was added in v2".

Oh ok, I didn't understand what you wanted to show when reading the example. I
think for the sake of the example we could be a little more verbose, and write
something like: "added patch ' ' to the series". Again,
it's just to give clear examples to users of what this changelog could contain.
What do you think?

>> I think it would also be nice to also instrict to give the link to the previous
>> patch but that might go a bit too far if done manually each time.
>
> That's not something I've seen often, but it could be community-specific.

Actually, b4 is doing this for me automatically. :)

Thanks,
Antonin

--
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering