[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-Id: <1575374868-32601-7-git-send-email-alan.maguire@oracle.com>
Date: Tue, 3 Dec 2019 12:07:48 +0000
From: Alan Maguire <alan.maguire@...cle.com>
To: brendanhiggins@...gle.com, linux-kselftest@...r.kernel.org
Cc: linux-kernel@...r.kernel.org, kunit-dev@...glegroups.com,
keescook@...omium.org, yzaikin@...gle.com,
akpm@...ux-foundation.org, yamada.masahiro@...ionext.com,
catalin.marinas@....com, joe.lawrence@...hat.com,
penguin-kernel@...ove.sakura.ne.jp, urezki@...il.com,
andriy.shevchenko@...ux.intel.com, corbet@....net,
davidgow@...gle.com, adilger.kernel@...ger.ca, tytso@....edu,
mcgrof@...nel.org, linux-doc@...r.kernel.org,
Alan Maguire <alan.maguire@...cle.com>,
Knut Omang <knut.omang@...cle.com>
Subject: [PATCH v5 linux-kselftest-test 6/6] kunit: update documentation to describe module-based build
Documentation should describe how to build kunit and tests as
modules.
Co-developed-by: Knut Omang <knut.omang@...cle.com>
Signed-off-by: Knut Omang <knut.omang@...cle.com>
Signed-off-by: Alan Maguire <alan.maguire@...cle.com>
Reviewed-by: Stephen Boyd <swboyd@...omium.org>
---
Documentation/dev-tools/kunit/faq.rst | 3 ++-
Documentation/dev-tools/kunit/index.rst | 3 +++
Documentation/dev-tools/kunit/usage.rst | 16 ++++++++++++++++
3 files changed, 21 insertions(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/kunit/faq.rst b/Documentation/dev-tools/kunit/faq.rst
index bf20951..ea55b24 100644
--- a/Documentation/dev-tools/kunit/faq.rst
+++ b/Documentation/dev-tools/kunit/faq.rst
@@ -29,7 +29,8 @@ Yes, well, mostly.
For the most part, the KUnit core framework (what you use to write the tests)
can compile to any architecture; it compiles like just another part of the
-kernel and runs when the kernel boots. However, there is some infrastructure,
+kernel and runs when the kernel boots, or when built as a module, when the
+module is loaded. However, there is some infrastructure,
like the KUnit Wrapper (``tools/testing/kunit/kunit.py``) that does not support
other architectures.
diff --git a/Documentation/dev-tools/kunit/index.rst b/Documentation/dev-tools/kunit/index.rst
index 26ffb46..7ddc385 100644
--- a/Documentation/dev-tools/kunit/index.rst
+++ b/Documentation/dev-tools/kunit/index.rst
@@ -48,6 +48,9 @@ to a standalone program that can be run like any other program directly inside
of a host operating system; to be clear, it does not require any virtualization
support; it is just a regular program.
+Alternatively, kunit and kunit tests can be built as modules and tests will
+run when the test module is loaded.
+
KUnit is fast. Excluding build time, from invocation to completion KUnit can run
several dozen tests in only 10 to 20 seconds; this might not sound like a big
deal to some people, but having such fast and easy to run tests fundamentally
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index c6e6963..82f9213 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -539,6 +539,22 @@ Interspersed in the kernel logs you might see the following:
Congratulations, you just ran a KUnit test on the x86 architecture!
+In a similar manner, kunit and kunit tests can also be built as modules,
+so if you wanted to run tests in this way you might add the following config
+options to your ``.config``:
+
+.. code-block:: none
+
+ CONFIG_KUNIT=m
+ CONFIG_KUNIT_EXAMPLE_TEST=m
+
+Once the kernel is built and installed, a simple
+
+.. code-block:: bash
+ modprobe example-test
+
+...will run the tests.
+
Writing new tests for other architectures
-----------------------------------------
--
1.8.3.1
Powered by blists - more mailing lists