Skip to content

Clean up rustdocs and add new checkpatch checks

Hridesh MG lkml rust-for-linux 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v6 Latest4 patches 4 repliesIn review

Patches in v6 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/4rust: make section names pluralrust/kernel/init.rs rust/kernel/list/arc.rs rust/kernel/sync/arc.rs +1 more+4 -40 replies
2/4checkpatch: warn on known non-plural rust doc headersscripts/checkpatch.pl+13 -00 replies
3/4rust: kernel: clean up empty `///` linesrust/kernel/block/mq/request.rs rust/kernel/rbtree.rs+0 -21 reply
4/4checkpatch: warn on empty rust doc commentsscripts/checkpatch.pl+9 -03 replies

Reviews trailers per patch

2 of 4 patches have a Reviewed-by or Acked-by.

PatchTrevor GrossAlice RyhlMiguel Ojeda
1/4
2/4
3/4R-b R-b
4/4A-b

Trailers given in replies are filled; those carried in the patches from earlier versions are outlined with dashes. Scroll the table sideways for all 3 reviewers.

Read the v6 thread

Cover letter [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/[email protected]/
[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(-)
Signature · 1 line
2.46.1