docs: dev-tools: kunit: avoid using ReST :doc:foo
markup
The :doc:`foo` tag is auto-generated via automarkup.py. So, use the filename at the sources, instead of :doc:`foo`. Reviewed-by: David Gow <davidgow@google.com> Acked-by: Brendan Higgins <brendanhiggins@google.com> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Link: https://lore.kernel.org/r/6fde409079959a95b62b9b2692503608d7ff0dbd.1623824363.git.mchehab+huawei@kernel.org Signed-off-by: Jonathan Corbet <corbet@lwn.net>
This commit is contained in:
parent
3a8b57d27a
commit
654a5bd0ea
@ -97,7 +97,7 @@ things to try.
|
|||||||
modules will automatically execute associated tests when loaded. Test results
|
modules will automatically execute associated tests when loaded. Test results
|
||||||
can be collected from ``/sys/kernel/debug/kunit/<test suite>/results``, and
|
can be collected from ``/sys/kernel/debug/kunit/<test suite>/results``, and
|
||||||
can be parsed with ``kunit.py parse``. For more details, see "KUnit on
|
can be parsed with ``kunit.py parse``. For more details, see "KUnit on
|
||||||
non-UML architectures" in :doc:`usage`.
|
non-UML architectures" in Documentation/dev-tools/kunit/usage.rst.
|
||||||
|
|
||||||
If none of the above tricks help, you are always welcome to email any issues to
|
If none of the above tricks help, you are always welcome to email any issues to
|
||||||
kunit-dev@googlegroups.com.
|
kunit-dev@googlegroups.com.
|
||||||
|
@ -36,7 +36,7 @@ To make running these tests (and reading the results) easier, KUnit offers
|
|||||||
results. This provides a quick way of running KUnit tests during development,
|
results. This provides a quick way of running KUnit tests during development,
|
||||||
without requiring a virtual machine or separate hardware.
|
without requiring a virtual machine or separate hardware.
|
||||||
|
|
||||||
Get started now: :doc:`start`
|
Get started now: Documentation/dev-tools/kunit/start.rst
|
||||||
|
|
||||||
Why KUnit?
|
Why KUnit?
|
||||||
==========
|
==========
|
||||||
@ -88,9 +88,9 @@ it takes to read their test log?
|
|||||||
How do I use it?
|
How do I use it?
|
||||||
================
|
================
|
||||||
|
|
||||||
* :doc:`start` - for new users of KUnit
|
* Documentation/dev-tools/kunit/start.rst - for new users of KUnit
|
||||||
* :doc:`tips` - for short examples of best practices
|
* Documentation/dev-tools/kunit/tips.rst - for short examples of best practices
|
||||||
* :doc:`usage` - for a more detailed explanation of KUnit features
|
* Documentation/dev-tools/kunit/usage.rst - for a more detailed explanation of KUnit features
|
||||||
* :doc:`api/index` - for the list of KUnit APIs used for testing
|
* Documentation/dev-tools/kunit/api/index.rst - for the list of KUnit APIs used for testing
|
||||||
* :doc:`kunit-tool` - for more information on the kunit_tool helper script
|
* Documentation/dev-tools/kunit/kunit-tool.rst - for more information on the kunit_tool helper script
|
||||||
* :doc:`faq` - for answers to some common questions about KUnit
|
* Documentation/dev-tools/kunit/faq.rst - for answers to some common questions about KUnit
|
||||||
|
@ -21,7 +21,7 @@ The wrapper can be run with:
|
|||||||
./tools/testing/kunit/kunit.py run
|
./tools/testing/kunit/kunit.py run
|
||||||
|
|
||||||
For more information on this wrapper (also called kunit_tool) check out the
|
For more information on this wrapper (also called kunit_tool) check out the
|
||||||
:doc:`kunit-tool` page.
|
Documentation/dev-tools/kunit/kunit-tool.rst page.
|
||||||
|
|
||||||
Creating a .kunitconfig
|
Creating a .kunitconfig
|
||||||
-----------------------
|
-----------------------
|
||||||
@ -234,7 +234,7 @@ Congrats! You just wrote your first KUnit test!
|
|||||||
|
|
||||||
Next Steps
|
Next Steps
|
||||||
==========
|
==========
|
||||||
* Check out the :doc:`tips` page for tips on
|
* Check out the Documentation/dev-tools/kunit/tips.rst page for tips on
|
||||||
writing idiomatic KUnit tests.
|
writing idiomatic KUnit tests.
|
||||||
* Optional: see the :doc:`usage` page for a more
|
* Optional: see the :doc:`usage` page for a more
|
||||||
in-depth explanation of KUnit.
|
in-depth explanation of KUnit.
|
||||||
|
@ -125,7 +125,8 @@ Here's a slightly in-depth example of how one could implement "mocking":
|
|||||||
|
|
||||||
|
|
||||||
Note: here we're able to get away with using ``test->priv``, but if you wanted
|
Note: here we're able to get away with using ``test->priv``, but if you wanted
|
||||||
something more flexible you could use a named ``kunit_resource``, see :doc:`api/test`.
|
something more flexible you could use a named ``kunit_resource``, see
|
||||||
|
Documentation/dev-tools/kunit/api/test.rst.
|
||||||
|
|
||||||
Failing the current test
|
Failing the current test
|
||||||
------------------------
|
------------------------
|
||||||
@ -185,5 +186,5 @@ Alternatively, one can take full control over the error message by using ``KUNIT
|
|||||||
|
|
||||||
Next Steps
|
Next Steps
|
||||||
==========
|
==========
|
||||||
* Optional: see the :doc:`usage` page for a more
|
* Optional: see the Documentation/dev-tools/kunit/usage.rst page for a more
|
||||||
in-depth explanation of KUnit.
|
in-depth explanation of KUnit.
|
||||||
|
@ -10,7 +10,7 @@ understand it. This guide assumes a working knowledge of the Linux kernel and
|
|||||||
some basic knowledge of testing.
|
some basic knowledge of testing.
|
||||||
|
|
||||||
For a high level introduction to KUnit, including setting up KUnit for your
|
For a high level introduction to KUnit, including setting up KUnit for your
|
||||||
project, see :doc:`start`.
|
project, see Documentation/dev-tools/kunit/start.rst.
|
||||||
|
|
||||||
Organization of this document
|
Organization of this document
|
||||||
=============================
|
=============================
|
||||||
@ -99,7 +99,8 @@ violated; however, the test will continue running, potentially trying other
|
|||||||
expectations until the test case ends or is otherwise terminated. This is as
|
expectations until the test case ends or is otherwise terminated. This is as
|
||||||
opposed to *assertions* which are discussed later.
|
opposed to *assertions* which are discussed later.
|
||||||
|
|
||||||
To learn about more expectations supported by KUnit, see :doc:`api/test`.
|
To learn about more expectations supported by KUnit, see
|
||||||
|
Documentation/dev-tools/kunit/api/test.rst.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
A single test case should be pretty short, pretty easy to understand,
|
A single test case should be pretty short, pretty easy to understand,
|
||||||
@ -216,7 +217,8 @@ test suite in a special linker section so that it can be run by KUnit either
|
|||||||
after late_init, or when the test module is loaded (depending on whether the
|
after late_init, or when the test module is loaded (depending on whether the
|
||||||
test was built in or not).
|
test was built in or not).
|
||||||
|
|
||||||
For more information on these types of things see the :doc:`api/test`.
|
For more information on these types of things see the
|
||||||
|
Documentation/dev-tools/kunit/api/test.rst.
|
||||||
|
|
||||||
Common Patterns
|
Common Patterns
|
||||||
===============
|
===============
|
||||||
|
Loading…
x
Reference in New Issue
Block a user