Alan Maguire
32526908fe
kunit: update documentation to describe debugfs representation
...
Documentation should describe debugfs layout and semantics.
Signed-off-by: Alan Maguire <alan.maguire@oracle.com >
Reviewed-by: Brendan Higgins <brendanhiggins@google.com >
Reviewed-by: Frank Rowand <frank.rowand@sony.com >
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org >
2020-03-26 14:09:16 -06:00
Brendan Higgins
e20d8e81a0
Documentation: kunit: fixed sphinx error in code block
...
Fix a missing newline in a code block that was causing a warning:
Documentation/dev-tools/kunit/usage.rst:553: WARNING: Error in "code-block" directive:
maximum 1 argument(s) allowed, 3 supplied.
.. code-block:: bash
modprobe example-test
Signed-off-by: Brendan Higgins <brendanhiggins@google.com >
Reviewed-by: Alan Maguire <alan.maguire@oracle.com >
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org >
2020-02-10 17:16:42 -07:00
Alan Maguire
6ae2bfd3df
kunit: update documentation to describe module-based build
...
Documentation should describe how to build kunit and tests as
modules.
Co-developed-by: Knut Omang <knut.omang@oracle.com >
Signed-off-by: Knut Omang <knut.omang@oracle.com >
Signed-off-by: Alan Maguire <alan.maguire@oracle.com >
Reviewed-by: Stephen Boyd <swboyd@chromium.org >
Reviewed-by: Brendan Higgins <brendanhiggins@google.com >
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org >
2020-01-09 16:44:10 -07:00
Brendan Higgins
e7d7ad0e41
Documentation: kunit: fix typos and gramatical errors
...
Fix typos and gramatical errors in the Getting Started and Usage guide
for KUnit.
Reported-by: Randy Dunlap <rdunlap@infradead.org >
Link: https://patchwork.kernel.org/patch/11156481/
Reported-by: Rinat Ibragimov <ibragimovrinat@mail.ru >
Link: https://github.com/google/kunit-docs/issues/1
Signed-off-by: Brendan Higgins <brendanhiggins@google.com >
Reviewed-by: David Gow <davidgow@google.com >
Acked-by: Randy Dunlap <rdunlap@infradead.org >
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org >
2019-12-09 11:21:22 -07:00
Brendan Higgins
c23a283b53
Documentation: kunit: add documentation for KUnit
...
Add documentation for KUnit, the Linux kernel unit testing framework.
- Add intro and usage guide for KUnit
- Add API reference
Signed-off-by: Felix Guo <felixguoxiuping@gmail.com >
Signed-off-by: Brendan Higgins <brendanhiggins@google.com >
Cc: Jonathan Corbet <corbet@lwn.net >
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org >
Reviewed-by: Logan Gunthorpe <logang@deltatee.com >
Reviewed-by: Stephen Boyd <sboyd@kernel.org >
Signed-off-by: Shuah Khan <skhan@linuxfoundation.org >
2019-09-30 17:35:01 -06:00
