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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <2025060238-vanilla-cardboard-eb74@gregkh>
Date: Mon, 2 Jun 2025 13:59:17 +0200
From: Greg KH <gregkh@...uxfoundation.org>
To: Sai Vishnu <saivishnu725@...il.com>
Cc: rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org,
	Miguel Ojeda <ojeda@...nel.org>, alex.gaynor@...il.com,
	boqun.feng@...il.com, gary@...yguo.net, bjorn3_gh@...tonmail.com,
	Benno Lossin <lossin@...nel.org>, a.hindborg@...nel.org,
	aliceryhl@...gle.com, tmgross@...ch.edu, dakr@...nel.org,
	daniel.almeida@...labora.com, me@...enk.dev
Subject: Re: [PATCH v3] rust: doc: Clean up formatting in io.rs

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