Re: [PATCH v3] rust: doc: Clean up formatting in io.rs

From: Greg KH
Date: Mon Jun 02 2025 - 07:59:40 EST


On Mon, Jun 02, 2025 at 04:41:20PM +0530, Sai Vishnu wrote:
> > below the first --- line
>
> Is it the one below the Signed off by line? To get the complete picture:
> 1. commit title
> 2. commit message
> 3. signed off and other tags
> ---
> 4. The version log or any other necessary comments
> 5. actual diff
> ---
>
> Additionally, I suppose the `base-commit` tag should also be placed in
> 3 (above/below Signed-off-by), as it was added to the very end by
> `git` when generating the patch.

No, that is fine.

> I am sincerely apologizing for taking at least 4 versions for a simple
> fix, but I am trying to figure out how to properly create and send
> patches.
> This clearly explains what you meant:
> https://www.kernel.org/doc/html/latest/process/submitting-patches.html#commentary

Yes, that is what you should be reading.

Also see the thousands of examples of good patches on the mailing lists
for real-world examples.

thanks,

greg k-h