| Message ID | 20250502215133.1923676-7-ojeda@kernel.org |
|---|---|
| State | New |
| Headers | show |
| Series | Rust KUnit `#[test]` support improvements | expand |
On Sat, 3 May 2025 at 05:52, Miguel Ojeda <ojeda@kernel.org> wrote: > > Now that `rusttest`s are not really used much, clarify the section of > the documentation that describes them. > > In addition, free the section name for the KUnit-based `#[test]`s that > will be added afterwards. To do so, rename the section into `rusttest` > host tests. > > Signed-off-by: Miguel Ojeda <ojeda@kernel.org> > --- Reviewed-by: David Gow <davidgow@google.com> Cheers, -- David > Documentation/rust/testing.rst | 13 +++++++------ > 1 file changed, 7 insertions(+), 6 deletions(-) > > diff --git a/Documentation/rust/testing.rst b/Documentation/rust/testing.rst > index f692494f7b74..6337b83815ab 100644 > --- a/Documentation/rust/testing.rst > +++ b/Documentation/rust/testing.rst > @@ -130,16 +130,17 @@ please see: > > https://rust.docs.kernel.org/kernel/error/type.Result.html#error-codes-in-c-and-rust > > -The ``#[test]`` tests > ---------------------- > +The ``rusttest`` host tests > +--------------------------- > > -Additionally, there are the ``#[test]`` tests. These can be run using the > -``rusttest`` Make target:: > +These are userspace tests that can be built and run in the host (i.e. the one > +that performs the kernel build) using the ``rusttest`` Make target:: > > make LLVM=1 rusttest > > -This requires the kernel ``.config``. It runs the ``#[test]`` tests on the host > -(currently) and thus is fairly limited in what these tests can test. > +This requires the kernel ``.config``. > + > +Currently, they are mostly used for testing the ``macros`` crate's examples. > > The Kselftests > -------------- > -- > 2.49.0 >
diff --git a/Documentation/rust/testing.rst b/Documentation/rust/testing.rst index f692494f7b74..6337b83815ab 100644 --- a/Documentation/rust/testing.rst +++ b/Documentation/rust/testing.rst @@ -130,16 +130,17 @@ please see: https://rust.docs.kernel.org/kernel/error/type.Result.html#error-codes-in-c-and-rust -The ``#[test]`` tests ---------------------- +The ``rusttest`` host tests +--------------------------- -Additionally, there are the ``#[test]`` tests. These can be run using the -``rusttest`` Make target:: +These are userspace tests that can be built and run in the host (i.e. the one +that performs the kernel build) using the ``rusttest`` Make target:: make LLVM=1 rusttest -This requires the kernel ``.config``. It runs the ``#[test]`` tests on the host -(currently) and thus is fairly limited in what these tests can test. +This requires the kernel ``.config``. + +Currently, they are mostly used for testing the ``macros`` crate's examples. The Kselftests --------------
Now that `rusttest`s are not really used much, clarify the section of the documentation that describes them. In addition, free the section name for the KUnit-based `#[test]`s that will be added afterwards. To do so, rename the section into `rusttest` host tests. Signed-off-by: Miguel Ojeda <ojeda@kernel.org> --- Documentation/rust/testing.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-)