linux-kernel - Re: [PATCH] docs: rust: clean up empty `\\\` lines and improve rustdoc formatting

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: <CANiq72mS6_PCqfhTtKvAgE=S8gSj44_v9kG3AK_txxdsMo0PdQ@mail.gmail.com>
Date: Tue, 10 Sep 2024 13:10:50 +0200
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Benno Lossin <benno.lossin@...ton.me>
Cc: hridesh <hridesh699@...il.com>, linux-block@...r.kernel.org, 
	rust-for-linux@...r.kernel.org, linux-kernel@...r.kernel.org, 
	Andreas Hindborg <a.hindborg@...sung.com>, Boqun Feng <boqun.feng@...il.com>, 
	Miguel Ojeda <ojeda@...nel.org>, Alex Gaynor <alex.gaynor@...il.com>, 
	Wedson Almeida Filho <wedsonaf@...il.com>, Gary Guo <gary@...yguo.net>, 
	Björn Roy Baron <bjorn3_gh@...tonmail.com>, 
	Alice Ryhl <aliceryhl@...gle.com>, Trevor Gross <tmgross@...ch.edu>, Jens Axboe <axboe@...nel.dk>, 
	Matt Gilbride <mattgilbride@...gle.com>, Shuah Khan <skhan@...uxfoundation.org>
Subject: Re: [PATCH] docs: rust: clean up empty `\\\` lines and improve
 rustdoc formatting

On Mon, Sep 9, 2024 at 9:22 PM Benno Lossin <benno.lossin@...ton.me> wrote:
>
> I don't know if the commit title should start with `docs`, maybe we want
> to do `rust: docs` when changing rustdocs? (This is a question to the
> other Rust reviewers)
>
> I think the title doesn't need to mention the exact cleanup, just
> something along the lines "clean up docs" should suffice.

Yeah, "docs" would be better for Documentation/ bits.

I think something like this would be ideal:

   rust: kernel: clean up empty `\\\` lines

> Instead of adding these backslashes, I personally would prefer if we

Yeah, we have another patch on the list for that, so I would remove it
from this one.

Thanks!

Cheers,
Miguel