linux.git/Documentation/dev-tools/kunit/start.rst, branch v5.13

Documentation: kunit: add tips.rst for small examples

2021-02-08T22:41:11+00:00

./usage.rst contains fairly long examples and explanations of things
like how to fake a class and how to use parameterized tests (and how you
could do table-driven tests yourself).

It's not exactly necessary information, so we add a new page with more
digestible tips like "use kunit_kzalloc() instead of kzalloc() so you
don't have to worry about calling kfree() yourself" and the like.

Change start.rst to point users to this new page first and let them know
that usage.rst is more of optional further reading.

Signed-off-by: Daniel Latypov 
Reviewed-by: Brendan Higgins 
Signed-off-by: Shuah Khan

KUnit: Docs: make start.rst example Kconfig follow style.rst

2021-02-08T22:40:12+00:00

The primary change is that we want to encourage people to respect
KUNIT_ALL_TESTS to make it easy to run all the relevant tests for a
given config.

Signed-off-by: Daniel Latypov 
Reviewed-by: Brendan Higgins 
Signed-off-by: Shuah Khan

Documentation: kunit: Update Kconfig parts for KUNIT's module support

2020-10-26T19:24:46+00:00

If 'CONFIG_KUNIT=m', letting kunit tests that do not support loadable
module build depends on 'KUNIT' instead of 'KUNIT=y' result in compile
errors.  This commit updates the document for this.

Fixes: 9fe124bf1b77 ("kunit: allow kunit to be loaded as a module")
Signed-off-by: SeongJae Park 
Reviewed-by: David Gow 
Reviewed-by: Brendan Higgins 
Signed-off-by: Shuah Khan

Documentation: kunit: Remove references to --defconfig

2020-07-17T20:08:43+00:00

The --defconfig option in kunit_tool was removed in [1], but the getting
started and kunit_tool documentation still encouraged its use. Update
those documents to reflect that it's no-longer required, and is the
default behaviour if no .kunitconfig is found.

Also update a couple of places where .kunitconfig is still referred to
as kunitconfig (this was changed in [2]).

[1]:
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/commit/?h=kunit-fixes&id=9bdf64b35117cc10813d24e1842cd8ee40ecbf19
[2]:
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/commit/?h=kunit-fixes&id=14ee5cfd4512ee3d1e0047d8751450dcc6544070

Signed-off-by: David Gow 
Signed-off-by: Shuah Khan

Documentation: test.h - fix warnings

2020-05-22T20:33:59+00:00

Fix warnings at 'make htmldocs', and formatting issues in the resulting
documentation.

- test.h: Fix annotation in kernel-doc parameter description.

- Documentation/*.rst: Fixing formatting issues, and a duplicate label
  issue due to usage of sphinx.ext.autosectionlabel and identical labels
  within one document (sphinx warning)

Signed-off-by: Lothar Rubusch 
Reviewed-by: Brendan Higgins 
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

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