linux-toradex.git/Documentation/dev-tools/kunit, branch v5.7-rc6

kunit: update documentation to describe debugfs representation

2020-03-26T20:09:16+00:00

Documentation should describe debugfs layout and semantics.

Signed-off-by: Alan Maguire 
Reviewed-by: Brendan Higgins 
Reviewed-by: Frank Rowand 
Signed-off-by: Shuah Khan

Documentation: kunit: Make the KUnit documentation less UML-specific

2020-03-25T22:39:13+00:00

Remove some of the outmoded "Why KUnit" rationale, and move some
UML-specific information to the kunit_tool page. Also update the Getting
Started guide to mention running tests without the kunit_tool wrapper.

Signed-off-by: David Gow 
Reviewed-by: Frank Rowand 
Acked-by: Shuah Khan 
Reviewed-by: Brendan Higgins 
Signed-off-by: Shuah Khan

Documentation: kunit: fixed sphinx error in code block

2020-02-11T00:16:42+00:00

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 
Reviewed-by: Alan Maguire 
Signed-off-by: Shuah Khan

kunit: update documentation to describe module-based build

2020-01-09T23:44:10+00:00

Documentation should describe how to build kunit and tests as
modules.

Co-developed-by: Knut Omang 
Signed-off-by: Knut Omang 
Signed-off-by: Alan Maguire 
Reviewed-by: Stephen Boyd 
Reviewed-by: Brendan Higgins 
Signed-off-by: Shuah Khan

kunit: Rename 'kunitconfig' to '.kunitconfig'

2019-12-23T17:52:41+00:00

This commit renames 'kunitconfig' to '.kunitconfig' so that it can be
automatically ignored by git and do not disturb people who want to type
'kernel/' by pressing only the 'k' and then 'tab' key.

Signed-off-by: SeongJae Park 
Reviewed-by: Brendan Higgins 
Tested-by: Brendan Higgins 
Signed-off-by: Shuah Khan

docs/kunit/start: Use in-tree 'kunit_defconfig'

2019-12-23T17:52:40+00:00

The kunit doc suggests users to get the default `kunitconfig` from an
external git tree.  However, the file is already located under the
`arch/um/configs/` of the kernel tree.  Because the local file is easier
to access and maintain, this commit updates the doc to use it.

Signed-off-by: SeongJae Park 
Reviewed-by: Brendan Higgins 
Tested-by: Brendan Higgins 
Signed-off-by: Shuah Khan

Documentation: kunit: add documentation for kunit_tool

2019-12-09T18:22:01+00:00

Add documentation for the Python script used to build, run, and collect
results from the kernel known as kunit_tool. kunit_tool
(tools/testing/kunit/kunit.py) was already added in previous commits.

Signed-off-by: Brendan Higgins 
Reviewed-by: David Gow 
Cc: Randy Dunlap 
Acked-by: Randy Dunlap 
Signed-off-by: Shuah Khan

Documentation: kunit: fix typos and gramatical errors

2019-12-09T18:21:22+00:00

Fix typos and gramatical errors in the Getting Started and Usage guide
for KUnit.

Reported-by: Randy Dunlap 
Link: https://patchwork.kernel.org/patch/11156481/
Reported-by: Rinat Ibragimov 
Link: https://github.com/google/kunit-docs/issues/1
Signed-off-by: Brendan Higgins 
Reviewed-by: David Gow 
Acked-by: Randy Dunlap 
Signed-off-by: Shuah Khan

Documentation: kunit: Fix verification command

2019-10-07T23:02:13+00:00

kunit wrapper script ('kunit.py') receives a sub-command (only 'run' for
now) as its argument.  If no sub-command is given, it prints help
message and just quit.  However, an example command in the kunit
documentation for a verification of kunit is missing the sub-command.
This commit fixes the example.

Signed-off-by: SeongJae Park 
Reviewed-by: Brendan Higgins 
Signed-off-by: Shuah Khan

Documentation: kunit: add documentation for KUnit

2019-09-30T23:35:01+00:00

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 
Signed-off-by: Brendan Higgins 
Cc: Jonathan Corbet 
Reviewed-by: Greg Kroah-Hartman 
Reviewed-by: Logan Gunthorpe 
Reviewed-by: Stephen Boyd 
Signed-off-by: Shuah Khan