Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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>

authored by

Mauro Carvalho Chehab and committed by
Jonathan Corbet
654a5bd0 3a8b57d2

+18 -15
+1 -1
Documentation/dev-tools/kunit/faq.rst
··· 97 97 modules will automatically execute associated tests when loaded. Test results 98 98 can be collected from ``/sys/kernel/debug/kunit/<test suite>/results``, and 99 99 can be parsed with ``kunit.py parse``. For more details, see "KUnit on 100 - non-UML architectures" in :doc:`usage`. 100 + non-UML architectures" in Documentation/dev-tools/kunit/usage.rst. 101 101 102 102 If none of the above tricks help, you are always welcome to email any issues to 103 103 kunit-dev@googlegroups.com.
+7 -7
Documentation/dev-tools/kunit/index.rst
··· 36 36 results. This provides a quick way of running KUnit tests during development, 37 37 without requiring a virtual machine or separate hardware. 38 38 39 - Get started now: :doc:`start` 39 + Get started now: Documentation/dev-tools/kunit/start.rst 40 40 41 41 Why KUnit? 42 42 ========== ··· 88 88 How do I use it? 89 89 ================ 90 90 91 - * :doc:`start` - for new users of KUnit 92 - * :doc:`tips` - for short examples of best practices 93 - * :doc:`usage` - for a more detailed explanation of KUnit features 94 - * :doc:`api/index` - for the list of KUnit APIs used for testing 95 - * :doc:`kunit-tool` - for more information on the kunit_tool helper script 96 - * :doc:`faq` - for answers to some common questions about KUnit 91 + * Documentation/dev-tools/kunit/start.rst - for new users of KUnit 92 + * Documentation/dev-tools/kunit/tips.rst - for short examples of best practices 93 + * Documentation/dev-tools/kunit/usage.rst - for a more detailed explanation of KUnit features 94 + * Documentation/dev-tools/kunit/api/index.rst - for the list of KUnit APIs used for testing 95 + * Documentation/dev-tools/kunit/kunit-tool.rst - for more information on the kunit_tool helper script 96 + * Documentation/dev-tools/kunit/faq.rst - for answers to some common questions about KUnit
+2 -2
Documentation/dev-tools/kunit/start.rst
··· 21 21 ./tools/testing/kunit/kunit.py run 22 22 23 23 For more information on this wrapper (also called kunit_tool) check out the 24 - :doc:`kunit-tool` page. 24 + Documentation/dev-tools/kunit/kunit-tool.rst page. 25 25 26 26 Creating a .kunitconfig 27 27 ----------------------- ··· 234 234 235 235 Next Steps 236 236 ========== 237 - * Check out the :doc:`tips` page for tips on 237 + * Check out the Documentation/dev-tools/kunit/tips.rst page for tips on 238 238 writing idiomatic KUnit tests. 239 239 * Optional: see the :doc:`usage` page for a more 240 240 in-depth explanation of KUnit.
+3 -2
Documentation/dev-tools/kunit/tips.rst
··· 125 125 126 126 127 127 Note: here we're able to get away with using ``test->priv``, but if you wanted 128 - something more flexible you could use a named ``kunit_resource``, see :doc:`api/test`. 128 + something more flexible you could use a named ``kunit_resource``, see 129 + Documentation/dev-tools/kunit/api/test.rst. 129 130 130 131 Failing the current test 131 132 ------------------------ ··· 186 185 187 186 Next Steps 188 187 ========== 189 - * Optional: see the :doc:`usage` page for a more 188 + * Optional: see the Documentation/dev-tools/kunit/usage.rst page for a more 190 189 in-depth explanation of KUnit.
+5 -3
Documentation/dev-tools/kunit/usage.rst
··· 10 10 some basic knowledge of testing. 11 11 12 12 For a high level introduction to KUnit, including setting up KUnit for your 13 - project, see :doc:`start`. 13 + project, see Documentation/dev-tools/kunit/start.rst. 14 14 15 15 Organization of this document 16 16 ============================= ··· 99 99 expectations until the test case ends or is otherwise terminated. This is as 100 100 opposed to *assertions* which are discussed later. 101 101 102 - To learn about more expectations supported by KUnit, see :doc:`api/test`. 102 + To learn about more expectations supported by KUnit, see 103 + Documentation/dev-tools/kunit/api/test.rst. 103 104 104 105 .. note:: 105 106 A single test case should be pretty short, pretty easy to understand, ··· 217 216 after late_init, or when the test module is loaded (depending on whether the 218 217 test was built in or not). 219 218 220 - For more information on these types of things see the :doc:`api/test`. 219 + For more information on these types of things see the 220 + Documentation/dev-tools/kunit/api/test.rst. 221 221 222 222 Common Patterns 223 223 ===============