linux-kernel - [PATCH v2 1/2] rust: io: remove square brackets from pci::Bar reference

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: <20260105213726.73000-1-mt@markoturk.info>
Date: Mon, 5 Jan 2026 22:37:42 +0100
From: Marko Turk <mt@...koturk.info>
To: dakr@...nel.org, dirk.behme@...bosch.com, linux-pci@...r.kernel.org,
	linux-kernel@...r.kernel.org, rust-for-linux@...r.kernel.org,
	mt@...koturk.info
Cc: linux-pci@...r.kernel.org, linux-kernel@...r.kernel.org,
	rust-for-linux@...r.kernel.org, Marko Turk <mt@...koturk.info>
Subject: [PATCH v2 1/2] rust: io: remove square brackets from pci::Bar
 reference

Remove square brackets since this section is not a part of doc-comment
so the reference will not be converted to a link in the generated docs.

Fixes: ce30d94e6855 ("rust: add `io::{Io, IoRaw}` base types")
Suggested-by: Danilo Krummrich <dakr@...nel.org>
Signed-off-by: Marko Turk <mt@...koturk.info>
---
Changes since v1:
 - pci::Bar is re-exported so no need to change this to pci::io::Bar
 - instead removed the square brackets as suggested by Danilo

Link to v1: https://lore.kernel.org/lkml/20260103143119.96095-1-mt@markoturk.info/

 rust/kernel/io.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/rust/kernel/io.rs b/rust/kernel/io.rs
index 98e8b84e68d1..a97eb44a9a87 100644
--- a/rust/kernel/io.rs
+++ b/rust/kernel/io.rs
@@ -87,7 +87,7 @@ pub fn maxsize(&self) -> usize {
 /// };
 /// use core::ops::Deref;
 ///
-/// // See also [`pci::Bar`] for a real example.
+/// // See also `pci::Bar` for a real example.
 /// struct IoMem<const SIZE: usize>(IoRaw<SIZE>);
 ///
 /// impl<const SIZE: usize> IoMem<SIZE> {
-- 
2.51.0