linux-kernel - [PATCH 3/3] rust: net: phy: follow usual comment conventions

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

Message-ID: <20251110122223.1677654-3-ojeda@kernel.org>
Date: Mon, 10 Nov 2025 13:22:23 +0100
From: Miguel Ojeda <ojeda@...nel.org>
To: FUJITA Tomonori <fujita.tomonori@...il.com>,
	Miguel Ojeda <ojeda@...nel.org>,
	Alex Gaynor <alex.gaynor@...il.com>
Cc: Trevor Gross <tmgross@...ch.edu>,
	netdev@...r.kernel.org,
	rust-for-linux@...r.kernel.org,
	Boqun Feng <boqun.feng@...il.com>,
	Gary Guo <gary@...yguo.net>,
	Björn Roy Baron <bjorn3_gh@...tonmail.com>,
	Benno Lossin <lossin@...nel.org>,
	Andreas Hindborg <a.hindborg@...nel.org>,
	Alice Ryhl <aliceryhl@...gle.com>,
	Danilo Krummrich <dakr@...nel.org>,
	linux-kernel@...r.kernel.org,
	patches@...ts.linux.dev
Subject: [PATCH 3/3] rust: net: phy: follow usual comment conventions

Examples should aim to follow the usual conventions, which makes
documentation more consistent with code and itself, and it should also
help newcomers learn them more easily.

Thus change the comments to follow them.

Link: https://docs.kernel.org/rust/coding-guidelines.html#comments
Signed-off-by: Miguel Ojeda <ojeda@...nel.org>
---
 rust/kernel/net/phy/reg.rs | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/rust/kernel/net/phy/reg.rs b/rust/kernel/net/phy/reg.rs
index 165bbff93e53..5a7b808915f9 100644
--- a/rust/kernel/net/phy/reg.rs
+++ b/rust/kernel/net/phy/reg.rs
@@ -36,9 +36,9 @@ pub trait Sealed {}
 /// #     }, //
 /// # };
 /// fn link_change_notify(dev: &mut Device) {
-///     // read C22 BMCR register
+///     // Read C22 BMCR register.
 ///     dev.read(C22::BMCR);
-///     // read C45 PMA/PMD control 1 register
+///     // Read C45 PMA/PMD control 1 register.
 ///     dev.read(C45::new(Mmd::PMAPMD, 0));
 ///
 ///     // Checks the link status as reported by registers in the C22 namespace
-- 
2.51.2