All of lore.kernel.org
 help / color / mirror / Atom feed
From: Hridesh MG <hridesh699@gmail.com>
To: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org
Cc: "Andreas Hindborg" <a.hindborg@kernel.org>,
	"Boqun Feng" <boqun.feng@gmail.com>,
	"Miguel Ojeda" <ojeda@kernel.org>,
	"Alex Gaynor" <alex.gaynor@gmail.com>,
	"Gary Guo" <gary@garyguo.net>,
	"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
	"Benno Lossin" <benno.lossin@proton.me>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Andy Whitcroft" <apw@canonical.com>,
	"Joe Perches" <joe@perches.com>,
	"Dwaipayan Ray" <dwaipayanray1@gmail.com>,
	"Lukas Bulwahn" <lukas.bulwahn@gmail.com>,
	"Hridesh MG" <hridesh699@gmail.com>,
	"Jens Axboe" <axboe@kernel.dk>,
	"Wedson Almeida Filho" <walmeida@microsoft.com>,
	"Valentin Obst" <kernel@valentinobst.de>,
	"Patrick Miller" <paddymills@proton.me>,
	"Alex Mantel" <alexmantel93@mailbox.org>,
	"Matt Gilbride" <mattgilbride@google.com>,
	"Aswin Unnikrishnan" <aswinunni01@gmail.com>,
	"Martin Rodriguez Reboredo" <yakoyoku@gmail.com>,
	"FUJITA Tomonori" <fujita.tomonori@gmail.com>
Subject: [PATCH v6 0/4]  Clean up rustdocs and add new checkpatch checks
Date: Tue, 15 Oct 2024 21:21:35 +0530	[thread overview]
Message-ID: <cover.1728818976.git.hridesh699@gmail.com> (raw)

Clean up the rustdocs as suggested by two issues[1][2]. The first issue
is to convert all rustdoc headers to plural in order to maintain
consistency and avoid situations where further additions to the doc
could render the grammar incorrect. The second issue aims to remove
consecutive empty rustdoc lines.

Also add two new checks (patches 2 and 4) to checkpatch to detect any
future occurrences of the above two issues and optionally fix them using
--fix.

This patchset is a merger of two different patchsets [3] and [4] with a
few improvements made on top of them which are listed on their
individual changelogs.

[1]: https://github.com/Rust-for-Linux/linux/issues/1110
[2]: https://github.com/Rust-for-Linux/linux/issues/1109

[3]: https://lore.kernel.org/rust-for-linux/20241002022749.390836-1-paddymills@proton.me/
[4]: https://lore.kernel.org/rust-for-linux/dbb63b5698aa507bbe3dec54b4458a3f151899d3.1727606659.git.hridesh699@gmail.com/

Hridesh MG (2):
  rust: kernel: clean up empty `///` lines
  checkpatch: warn on empty rust doc comments

Patrick Miller (2):
  rust: make section names plural
  checkpatch: warn on known non-plural rust doc headers

 rust/kernel/block/mq/request.rs |  1 -
 rust/kernel/init.rs             |  2 +-
 rust/kernel/list/arc.rs         |  2 +-
 rust/kernel/rbtree.rs           |  1 -
 rust/kernel/sync/arc.rs         |  2 +-
 rust/macros/lib.rs              |  2 +-
 scripts/checkpatch.pl           | 22 ++++++++++++++++++++++
 7 files changed, 26 insertions(+), 6 deletions(-)

-- 
2.46.1


             reply	other threads:[~2024-10-15 15:51 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-15 15:51 Hridesh MG [this message]
2024-10-15 15:51 ` [PATCH v6 1/4] rust: make section names plural Hridesh MG
2024-10-15 15:51 ` [PATCH v6 2/4] checkpatch: warn on known non-plural rust doc headers Hridesh MG
2024-10-15 15:51 ` [PATCH v6 3/4] rust: kernel: clean up empty `///` lines Hridesh MG
2025-05-26 16:26   ` Miguel Ojeda
2024-10-15 15:51 ` [PATCH v6 4/4] checkpatch: warn on empty rust doc comments Hridesh MG
2024-10-29  6:11   ` Hridesh MG
2024-10-29 20:32     ` Miguel Ojeda
2024-11-21 16:54       ` Hridesh MG

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=cover.1728818976.git.hridesh699@gmail.com \
    --to=hridesh699@gmail.com \
    --cc=a.hindborg@kernel.org \
    --cc=alex.gaynor@gmail.com \
    --cc=alexmantel93@mailbox.org \
    --cc=aliceryhl@google.com \
    --cc=apw@canonical.com \
    --cc=aswinunni01@gmail.com \
    --cc=axboe@kernel.dk \
    --cc=benno.lossin@proton.me \
    --cc=bjorn3_gh@protonmail.com \
    --cc=boqun.feng@gmail.com \
    --cc=dwaipayanray1@gmail.com \
    --cc=fujita.tomonori@gmail.com \
    --cc=gary@garyguo.net \
    --cc=joe@perches.com \
    --cc=kernel@valentinobst.de \
    --cc=linux-kernel@vger.kernel.org \
    --cc=lukas.bulwahn@gmail.com \
    --cc=mattgilbride@google.com \
    --cc=ojeda@kernel.org \
    --cc=paddymills@proton.me \
    --cc=rust-for-linux@vger.kernel.org \
    --cc=tmgross@umich.edu \
    --cc=walmeida@microsoft.com \
    --cc=yakoyoku@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.