Re: [PATCH] Documentation: Provide guidelines for kernel development tools

From: Miguel Ojeda

Date: Tue Oct 28 2025 - 11:29:28 EST


Hi Dave,

Some more nits and suggestions below...

On Mon, Oct 27, 2025 at 9:13 PM Dave Hansen <dave.hansen@xxxxxxxxxxxxxxx> wrote:
>
> Cc: Miguel Ojeda <miguel.ojeda.sandonis@xxxxxxxxx>

No big deal either way, but for the commit you could use ojeda@xxxxxxxxxx

> + - Spelling and grammar fix ups, like rephrasing to imperative voice

Some bullet points have periods at the end, others don't.

> + - Reformatting, like running scripts/Lindent.

You could perhaps add

Lindent, ``clang-format`` or ``rustfmt``

or similar (the Rust one is particularly relevant because we enforce
that one treewide unlike the C one).

> + - “checkpatch.pl --fix” output, or any tool suggested fix.

We should use a code span for this one.

Also, should it be "tool-suggested", i.e. with a hyphen? (not a native speaker)

> + - coccinelle scripts

Coccinelle

> + - ChatGPT generated a new function in your patch to sort list entries.
> + - A .c file in the patch was originally generated by Gemini but cleaned
> + up by hand.

Like Jon, it also crossed my mind using just LLM here or perhaps
mentioning "open" models. On the other hand, it is clear commercial
models are getting used already, e.g. Gemini is in the commit log
already and Claude is in the mailing list.

I hope that helps -- thanks for sending this!

Cheers,
Miguel