In the world of programming languages, Rust is widely recognized for its emphasis on safety and reliability. However, developers may need to resort to using the “UNSAFE” keyword at times, particularly when working with the Linux core. To facilitate the handling of such code, a new documentation standard has been put forward.
Benno Lossin proposed an update that aims to establish a universal security standard for Rust in the Linux kernel. He stresses the importance of documenting unsafe code within the kernel to ensure its correctness. Currently, there is no consistent method for writing such documentation, leading to confusion among code authors and readers.
To address this issue and enhance documentation quality, the new standard proposes a unified approach. Given the complexity of creating a standard for all scenarios, the suggestion is to start with a more specific guideline. Lossin anticipates that this initiative will spark further discussions and aid in determining the optimal way to document code in the kernel.
The initial release of the security standard encompasses components like review processes, code samples, safety prerequisites, rationale, and more, with plans for additional elements in the future. Those interested in delving deeper into the proposed changes and preliminary documentation can access the information provided.