Description
The Revocable
type in rust/kernel/revocable.rs
is missing an # Invariants
section documenting that the value inside of data
is valid if and only if is_available
is true. This should be properly documented and then used in the appropriate places. Please also document the required usage of RCU.
This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (including generating the documentation if changed, running the Rust doctests if changed, etc.), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and to add a Suggested-by:
tag, and a Link:
tag to this issue. Please see https://docs.kernel.org/process/submitting-patches.html and https://rust-for-linux.com/contributing for details.