mirror-linux/rust
Gary Guo 889c8c934d rust: rework `build_assert!` documentation
Add a detailed comparison and recommendation of the three types of
build-time assertion macro as module documentation (and un-hide the module
to render them).

The documentation on the macro themselves are simplified to only cover the
scenarios where they should be used; links to the module documentation is
added instead.

Reviewed-by: Yury Norov <ynorov@nvidia.com>
Signed-off-by: Gary Guo <gary@garyguo.net>
Reviewed-by: Alexandre Courbot <acourbot@nvidia.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Reviewed-by: Danilo Krummrich <dakr@kernel.org>
Link: https://patch.msgid.link/20260319121653.2975748-4-gary@kernel.org
[ Added periods on comments. - Miguel ]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
2026-03-30 02:03:52 +02:00
..
bindings Char/Misc/IIO driver changes for 7.0-rc1 2026-02-17 09:11:04 -08:00
helpers rust: jump_label: add __rust_helper to helpers 2026-03-10 11:29:16 +01:00
kernel rust: rework `build_assert!` documentation 2026-03-30 02:03:52 +02:00
macros Rust changes for v6.20 / v7.0 2026-02-10 11:53:01 -08:00
pin-init Rust fixes for v7.0-rc1 2026-02-22 08:43:31 -08:00
proc-macro2 rust: proc-macro2: rebuild if the version text changes 2026-01-23 10:44:27 +01:00
quote rust: quote: add `README.md` 2025-11-24 17:15:43 +01:00
syn rust: syn: add `README.md` 2025-11-24 17:15:47 +01:00
uapi Char/Misc/IIO/Binder changes for 6.18-rc1 2025-10-04 16:26:32 -07:00
.gitignore
.kunitconfig
Makefile Rust fixes for v7.0-rc1 2026-02-22 08:43:31 -08:00
bindgen_parameters mm: declare VMA flags by bit 2025-11-29 10:41:08 -08:00
build_error.rs
compiler_builtins.rs
exports.c
ffi.rs rust: replace `CStr` with `core::ffi::CStr` 2025-10-22 07:47:27 +02:00