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-next>] [day] [month] [year] [list]
Message-ID: <cover.1728818976.git.hridesh699@gmail.com>
Date: Tue, 15 Oct 2024 21:21:35 +0530
From: Hridesh MG <hridesh699@...il.com>
To: rust-for-linux@...r.kernel.org,
	linux-kernel@...r.kernel.org
Cc: Andreas Hindborg <a.hindborg@...nel.org>,
	Boqun Feng <boqun.feng@...il.com>,
	Miguel Ojeda <ojeda@...nel.org>,
	Alex Gaynor <alex.gaynor@...il.com>,
	Gary Guo <gary@...yguo.net>,
	Björn Roy Baron <bjorn3_gh@...tonmail.com>,
	Benno Lossin <benno.lossin@...ton.me>,
	Alice Ryhl <aliceryhl@...gle.com>,
	Trevor Gross <tmgross@...ch.edu>,
	Andy Whitcroft <apw@...onical.com>,
	Joe Perches <joe@...ches.com>,
	Dwaipayan Ray <dwaipayanray1@...il.com>,
	Lukas Bulwahn <lukas.bulwahn@...il.com>,
	Hridesh MG <hridesh699@...il.com>,
	Jens Axboe <axboe@...nel.dk>,
	Wedson Almeida Filho <walmeida@...rosoft.com>,
	Valentin Obst <kernel@...entinobst.de>,
	Patrick Miller <paddymills@...ton.me>,
	Alex Mantel <alexmantel93@...lbox.org>,
	Matt Gilbride <mattgilbride@...gle.com>,
	Aswin Unnikrishnan <aswinunni01@...il.com>,
	Martin Rodriguez Reboredo <yakoyoku@...il.com>,
	FUJITA Tomonori <fujita.tomonori@...il.com>
Subject: [PATCH v6 0/4]  Clean up rustdocs and add new checkpatch checks

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


Powered by blists - more mailing lists

Powered by Openwall GNU/*/Linux Powered by OpenVZ