Skip to content

Commit 085cf66

Browse files
committed
rust: macros: hide docs for module! public statics/fns
So that we do not trigger `missing_docs`. Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
1 parent db747ba commit 085cf66

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

rust/macros/module.rs

+6
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@ fn __build_modinfo_string_base(
133133
format!(
134134
"
135135
{cfg}
136+
#[doc(hidden)]
136137
#[link_section = \".modinfo\"]
137138
#[used]
138139
pub static {variable}: [u8; {length}] = *b\"{string}\\0\";
@@ -599,12 +600,14 @@ pub fn module(ts: TokenStream) -> TokenStream {
599600
600601
// Loadable modules need to export the `{{init,cleanup}}_module` identifiers
601602
#[cfg(MODULE)]
603+
#[doc(hidden)]
602604
#[no_mangle]
603605
pub extern \"C\" fn init_module() -> kernel::c_types::c_int {{
604606
__init()
605607
}}
606608
607609
#[cfg(MODULE)]
610+
#[doc(hidden)]
608611
#[no_mangle]
609612
pub extern \"C\" fn cleanup_module() {{
610613
__exit()
@@ -614,6 +617,7 @@ pub fn module(ts: TokenStream) -> TokenStream {
614617
// and the identifiers need to be unique
615618
#[cfg(not(MODULE))]
616619
#[cfg(not(CONFIG_HAVE_ARCH_PREL32_RELOCATIONS))]
620+
#[doc(hidden)]
617621
#[link_section = \"{initcall_section}\"]
618622
#[used]
619623
pub static __{name}_initcall: extern \"C\" fn() -> kernel::c_types::c_int = __{name}_init;
@@ -629,12 +633,14 @@ pub fn module(ts: TokenStream) -> TokenStream {
629633
);
630634
631635
#[cfg(not(MODULE))]
636+
#[doc(hidden)]
632637
#[no_mangle]
633638
pub extern \"C\" fn __{name}_init() -> kernel::c_types::c_int {{
634639
__init()
635640
}}
636641
637642
#[cfg(not(MODULE))]
643+
#[doc(hidden)]
638644
#[no_mangle]
639645
pub extern \"C\" fn __{name}_exit() {{
640646
__exit()

0 commit comments

Comments
 (0)