linux-kernel - Re: [PATCH v2] docs: rust: fix formatting for kernel::block::mq::Request

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] [day] [month] [year] [list]

Message-ID: <CANiq72mXuDbT4aSH6DTiAK0AWZjSg+qgHH+L0fP8sZaYYSvFHg@mail.gmail.com>
Date: Wed, 23 Oct 2024 00:31:34 +0200
From: Miguel Ojeda <miguel.ojeda.sandonis@...il.com>
To: Francesco Zardi <frazar00@...il.com>
Cc: Miguel Ojeda <ojeda@...nel.org>, Alex Gaynor <alex.gaynor@...il.com>, 
	Wedson Almeida Filho <wedsonaf@...il.com>, Boqun Feng <boqun.feng@...il.com>, Gary Guo <gary@...yguo.net>, 
	Björn Roy Baron <bjorn3_gh@...tonmail.com>, 
	Benno Lossin <benno.lossin@...ton.me>, Andreas Hindborg <a.hindborg@...sung.com>, 
	Alice Ryhl <aliceryhl@...gle.com>, Jens Axboe <axboe@...nel.dk>, rust-for-linux@...r.kernel.org, 
	linux-block@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v2] docs: rust: fix formatting for kernel::block::mq::Request

On Tue, Sep 3, 2024 at 8:00 PM Francesco Zardi <frazar00@...il.com> wrote:
>
> Fix several issues with rustdoc formatting for the
> `kernel::block::mq::Request` module, in particular:
>
> - An ordered list not rendering correctly, fixed by using numbers prefixes
>   instead of letters
>
> - Code snippets formatted as regular text, fixed by wrapping the code with
>   `back-ticks`
>
> - References to types missing intra-doc links, fixed by wrapping the
>   types with [square brackets]
>
> Reported-by: Miguel Ojeda <ojeda@...nel.org>
> Closes: https://github.com/Rust-for-Linux/linux/issues/1108
> Signed-off-by: Francesco Zardi <frazar00@...il.com>

Applied to `rust-next` -- thanks everyone!

    [ Added an extra intra-doc link. Took the chance to add some periods
      for consistency. Reworded slightly. - Miguel ]

Cheers,
Miguel