Commit 562cc3cd authored by Dirk Behme's avatar Dirk Behme Committed by Miguel Ojeda
Browse files

docs: rust: Add error handling sections 



Add error handling sections to the documentation and use it
to link to the existing code documentation. This will allow
to extend that documentation, use intra-doc links and test
the examples.

Suggested-by: default avatarMiguel Ojeda <ojeda@kernel.org>
Link: https://lore.kernel.org/rust-for-linux/CANiq72keOdXy0LFKk9SzYWwSjiD710v=hQO4xi+5E4xNALa6cA@mail.gmail.com/


Signed-off-by: default avatarDirk Behme <dirk.behme@de.bosch.com>
Link: https://lore.kernel.org/r/20250115062552.1970768-1-dirk.behme@de.bosch.com


[ Slightly tweaked wording. - Miguel ]
Signed-off-by: default avatarMiguel Ojeda <ojeda@kernel.org>
parent 52ae96f5

Documentation/rust/coding-guidelines.rst

+8 −0
Original line number Diff line number Diff line
@@ -373,3 +373,11 @@ triggered due to non-local changes (such as ``dead_code``). 
For more information about diagnostics in Rust, please see:



	https://doc.rust-lang.org/stable/reference/attributes/diagnostics.html



Error handling

--------------



For some background and guidelines about Rust for Linux specific error handling,

please see:



	https://rust.docs.kernel.org/kernel/error/type.Result.html#error-codes-in-c-and-rust

Documentation/rust/testing.rst

+7 −0
Original line number Diff line number Diff line
@@ -123,6 +123,13 @@ A current limitation is that KUnit does not support assertions in other tasks. 
Thus, we presently simply print an error to the kernel log if an assertion

actually failed. Additionally, doctests are not run for nonpublic functions.



Since these tests are examples, i.e. they are part of the documentation, they

should generally be written like "real code". Thus, for example, instead of

using ``unwrap()`` or ``expect()``, use the ``?`` operator. For more background,

please see:



	https://rust.docs.kernel.org/kernel/error/type.Result.html#error-codes-in-c-and-rust



The ``#[test]`` tests

---------------------