Messages in this thread Patch in this message | | | From | Trevor Gross <> | Subject | [RFC PATCH 2/2] rust: bindings: add warning about configuration dependence | Date | Thu, 3 Aug 2023 05:34:18 -0400 |
| |
Add a note stating that binding documentation may differ from a user's configuration, to make users aware that published documentation may not always match a specific setup.
Signed-off-by: Trevor Gross <tmgross@umich.edu> --- rust/bindings/lib.rs | 3 +++ 1 file changed, 3 insertions(+)
diff --git a/rust/bindings/lib.rs b/rust/bindings/lib.rs index 9bcbea04dac3..869632c2341c 100644 --- a/rust/bindings/lib.rs +++ b/rust/bindings/lib.rs @@ -7,6 +7,9 @@ //! This crate may not be directly used. If you need a kernel C API that is //! not ported or wrapped in the `kernel` crate, then do so first instead of //! using this crate. +//! +//! Note that this module is heavily configuration-dependent, published versions +//! of documentation may not accurately reflect local configuration. #![no_std] // See <https://github.com/rust-lang/rust-bindgen/issues/1651>. -- 2.34.1
| |