]> git.ipfire.org Git - thirdparty/kernel/linux.git/commit
rust: num: bounded: clean __new documentation and comments
authorShivam Kalra <shivamklr@cock.li>
Fri, 23 Jan 2026 13:21:13 +0000 (18:51 +0530)
committerMiguel Ojeda <ojeda@kernel.org>
Mon, 26 Jan 2026 01:53:16 +0000 (02:53 +0100)
commit5016cae970d7d59d62aa4f6f11455a9e9630dd1c
treede98946739edb4aced3c0e505ec80893b37148ab
parente440bc5c190cd0e5f148b2892aeb1f4bbbf54507
rust: num: bounded: clean __new documentation and comments

Following commit 3a1ec424dd9c ("rust: num: bounded: mark __new as
unsafe"), remove the redundant paragraph in the documentation of __new now
that the Safety section explicitly covers the requirement.

Additionally, add an INVARIANT comment inside the function body where
the Bounded instance is actually constructed to document that the type
invariant is upheld.

Suggested-by: Miguel Ojeda <ojeda@kernel.org>
Link: https://lore.kernel.org/rust-for-linux/CANiq72mUCUh72BWP4eD1PTDpwdb1ML+Xgfom-Ys6thJooqQPwQ@mail.gmail.com/
Signed-off-by: Shivam Kalra <shivamklr@cock.li>
Acked-by: Alexandre Courbot <acourbot@nvidia.com>
Link: https://patch.msgid.link/20260123132132.53854-1-shivamklr@cock.li
[ Reworded slightly. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/kernel/num/bounded.rs