From: Peter Novak Date: Sun, 30 Nov 2025 21:12:33 +0000 (+0100) Subject: rust: use consistent backtick formatting for NULL in docs X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7f87c7a003125d5af5ec7abbbc0ac21b4a4661ae;p=thirdparty%2Fkernel%2Flinux.git rust: use consistent backtick formatting for NULL in docs Some doc comments use `NULL` while others use plain NULL. Make it consistent by adding backticks everywhere, matching the majority of existing usage. Signed-off-by: Peter Novak Acked-by: Stephen Boyd Acked-by: David Gow Reviewed-by: Alexandre Courbot Acked-by: Danilo Krummrich Link: https://patch.msgid.link/20251130211233.367946-1-seimun018r@gmail.com [ Reworded slightly. - Miguel ] Signed-off-by: Miguel Ojeda --- diff --git a/rust/kernel/clk.rs b/rust/kernel/clk.rs index c1cfaeaa36a22..db3464e2df324 100644 --- a/rust/kernel/clk.rs +++ b/rust/kernel/clk.rs @@ -94,7 +94,7 @@ mod common_clk { /// # Invariants /// /// A [`Clk`] instance holds either a pointer to a valid [`struct clk`] created by the C - /// portion of the kernel or a NULL pointer. + /// portion of the kernel or a `NULL` pointer. /// /// Instances of this type are reference-counted. Calling [`Clk::get`] ensures that the /// allocation remains valid for the lifetime of the [`Clk`]. diff --git a/rust/kernel/debugfs/entry.rs b/rust/kernel/debugfs/entry.rs index 706cb7f73d6c0..a30bf8f296791 100644 --- a/rust/kernel/debugfs/entry.rs +++ b/rust/kernel/debugfs/entry.rs @@ -148,7 +148,7 @@ impl Entry<'_> { /// # Guarantees /// /// Due to the type invariant, the value returned from this function will always be an error - /// code, NULL, or a live DebugFS directory. If it is live, it will remain live at least as + /// code, `NULL`, or a live DebugFS directory. If it is live, it will remain live at least as /// long as this entry lives. pub(crate) fn as_ptr(&self) -> *mut bindings::dentry { self.entry diff --git a/rust/kernel/kunit.rs b/rust/kernel/kunit.rs index 21aef6c97325b..4ccc8fc4a8006 100644 --- a/rust/kernel/kunit.rs +++ b/rust/kernel/kunit.rs @@ -190,7 +190,7 @@ pub fn is_test_result_ok(t: impl TestResult) -> bool { /// Represents an individual test case. /// -/// The [`kunit_unsafe_test_suite!`] macro expects a NULL-terminated list of valid test cases. +/// The [`kunit_unsafe_test_suite!`] macro expects a `NULL`-terminated list of valid test cases. /// Use [`kunit_case_null`] to generate such a delimiter. #[doc(hidden)] pub const fn kunit_case( @@ -212,9 +212,9 @@ pub const fn kunit_case( } } -/// Represents the NULL test case delimiter. +/// Represents the `NULL` test case delimiter. /// -/// The [`kunit_unsafe_test_suite!`] macro expects a NULL-terminated list of test cases. This +/// The [`kunit_unsafe_test_suite!`] macro expects a `NULL`-terminated list of test cases. This /// function returns such a delimiter. #[doc(hidden)] pub const fn kunit_case_null() -> kernel::bindings::kunit_case { @@ -237,7 +237,7 @@ pub const fn kunit_case_null() -> kernel::bindings::kunit_case { /// /// # Safety /// -/// `test_cases` must be a NULL terminated array of valid test cases, +/// `test_cases` must be a `NULL` terminated array of valid test cases, /// whose lifetime is at least that of the test suite (i.e., static). /// /// # Examples diff --git a/rust/macros/lib.rs b/rust/macros/lib.rs index b38002151871a..f26775285dc5a 100644 --- a/rust/macros/lib.rs +++ b/rust/macros/lib.rs @@ -154,7 +154,7 @@ pub fn module(ts: TokenStream) -> TokenStream { /// case the default implementation will never be executed. The reason for this /// is that the functions will be called through function pointers installed in /// C side vtables. When an optional method is not implemented on a `#[vtable]` -/// trait, a NULL entry is installed in the vtable. Thus the default +/// trait, a `NULL` entry is installed in the vtable. Thus the default /// implementation is never called. Since these traits are not designed to be /// used on the Rust side, it should not be possible to call the default /// implementation. This is done to ensure that we call the vtable methods