Hi all,
Today's linux-next merge of the akpm tree got a conflict in:
Documentation/dev-tools/kasan.rst
between commit:
1a37e18bd4b9 ("Documentation: fix typos in dev-tools/kasan.rst")
from the jc_docs tree and commit:
bb26c2574ff9 ("kasan: update documentation")
from the akpm tree.
I fixed it up (see below) and can carry the fix as necessary. This
is now fixed as far as linux-next is concerned, but any non trivial
conflicts should be mentioned to your upstream maintainer when your tree
is submitted for merging. You may also want to consider cooperating
with the maintainer of the conflicting tree to minimise any particularly
complex conflicts.
--
Cheers,
Stephen Rothwell
diff --cc Documentation/dev-tools/kasan.rst
index 6d9abe57feaa,0d5d77919b1a..000000000000
--- a/Documentation/dev-tools/kasan.rst
+++ b/Documentation/dev-tools/kasan.rst
@@@ -357,37 -410,30 +410,30 @@@ Or, if one of the tests failed:
not ok 1 - kasan
- (1) Loadable Module
- ~~~~~~~~~~~~~~~~~~~~
+
+ There are a few ways to run KUnit-compatible KASAN tests.
+
+ 1. Loadable module
+ ~~~~~~~~~~~~~~~~~~
With ``CONFIG_KUNIT`` enabled, ``CONFIG_KASAN_KUNIT_TEST`` can be built as
- a loadable module and run on any architecture that supports KASAN
- using something like insmod or modprobe. The module is called ``test_kasan``.
+ a loadable module and run on any architecture that supports KASAN by loading
+ the module with insmod or modprobe. The module is called ``test_kasan``.
- (2) Built-In
- ~~~~~~~~~~~~~
+ 2. Built-In
+ ~~~~~~~~~~~
With ``CONFIG_KUNIT`` built-in, ``CONFIG_KASAN_KUNIT_TEST`` can be built-in
- on any architecture that supports KASAN. These and any other KUnit
- tests enabled will run and print the results at boot as a late-init
- call.
-on any architecure that supports KASAN. These and any other KUnit tests enabled
++on any architecture that supports KASAN. These and any other KUnit tests enabled
+ will run and print the results at boot as a late-init call.
- (3) Using kunit_tool
- ~~~~~~~~~~~~~~~~~~~~~
+ 3. Using kunit_tool
+ ~~~~~~~~~~~~~~~~~~~
- With ``CONFIG_KUNIT`` and ``CONFIG_KASAN_KUNIT_TEST`` built-in, we can also
- use kunit_tool to see the results of these along with other KUnit
- tests in a more readable way. This will not print the KASAN reports
- of tests that passed. Use `KUnit documentation <https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html>`_ for more up-to-date
- information on kunit_tool.
+ With ``CONFIG_KUNIT`` and ``CONFIG_KASAN_KUNIT_TEST`` built-in, it's also
+ possible use ``kunit_tool`` to see the results of these and other KUnit tests
+ in a more readable way. This will not print the KASAN reports of the tests that
+ passed. Use `KUnit documentation <https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html>`_
+ for more up-to-date information on ``kunit_tool``.
.. _KUnit: https://www.kernel.org/doc/html/latest/dev-tools/kunit/index.html
-
- ``CONFIG_TEST_KASAN_MODULE`` is a set of KASAN tests that could not be
- converted to KUnit. These tests can be run only as a module with
- ``CONFIG_TEST_KASAN_MODULE`` built as a loadable module and
- ``CONFIG_KASAN`` built-in. The type of error expected and the
- function being run is printed before the expression expected to give
- an error. Then the error is printed, if found, and that test
- should be interpreted to pass only if the error was the one expected
- by the test.
Attachment:
pgpjbUABoIQlx.pgp
Description: OpenPGP digital signature
