All of lore.kernel.org
 help / color / mirror / Atom feed
From: Brendan Higgins <brendanhiggins@google.com>
To: jdike@addtoit.com, richard@nod.at,
	anton.ivanov@cambridgegreys.com, arnd@arndb.de,
	keescook@chromium.org, skhan@linuxfoundation.org,
	alan.maguire@oracle.com, yzaikin@google.com, davidgow@google.com,
	akpm@linux-foundation.org, rppt@linux.ibm.com,
	frowand.list@gmail.com
Cc: gregkh@linuxfoundation.org, sboyd@kernel.org,
	logang@deltatee.com, mcgrof@kernel.org,
	linux-arch@vger.kernel.org, linux-kselftest@vger.kernel.org,
	kunit-dev@googlegroups.com, linux-kernel@vger.kernel.org,
	linux-doc@vger.kernel.org,
	Brendan Higgins <brendanhiggins@google.com>
Subject: [PATCH v6 5/5] Documentation: kunit: add a brief blurb about kunit_test_suite
Date: Tue,  4 Aug 2020 13:47:45 -0700	[thread overview]
Message-ID: <20200804204745.987648-6-brendanhiggins@google.com> (raw)
In-Reply-To: <20200804204745.987648-1-brendanhiggins@google.com>

Add a brief blurb saying how and when the kunit_test_suite() macro
works to the usage documentation.

Signed-off-by: Brendan Higgins <brendanhiggins@google.com>
---
 Documentation/dev-tools/kunit/usage.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 3c3fe8b5feccf..961d3ea3ca19a 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -211,6 +211,11 @@ KUnit test framework.
 .. note::
    A test case will only be run if it is associated with a test suite.
 
+``kunit_test_suite(...)`` is a macro which tells the linker to put the specified
+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
+test was built in or not).
+
 For more information on these types of things see the :doc:`api/test`.
 
 Isolating Behavior
-- 
2.28.0.163.g6104cc2f0b6-goog


  parent reply	other threads:[~2020-08-04 20:48 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-08-04 20:47 [PATCH v6 0/5] kunit: create a centralized executor to dispatch all KUnit tests Brendan Higgins
2020-08-04 20:47 ` [PATCH v6 1/5] vmlinux.lds.h: add linker section for KUnit test suites Brendan Higgins
2020-08-04 20:47 ` [PATCH v6 2/5] kunit: test: create a single centralized executor for all tests Brendan Higgins
2020-10-13 11:09   ` Mauro Carvalho Chehab
2020-08-04 20:47 ` [PATCH v6 3/5] init: main: add KUnit to kernel init Brendan Higgins
2020-08-04 20:47 ` [PATCH v6 4/5] kunit: test: add test plan to KUnit TAP format Brendan Higgins
2020-08-04 20:47 ` Brendan Higgins [this message]
2020-08-05  6:01   ` [PATCH v6 5/5] Documentation: kunit: add a brief blurb about kunit_test_suite Stephen Boyd
2020-08-05  6:01     ` Stephen Boyd

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200804204745.987648-6-brendanhiggins@google.com \
    --to=brendanhiggins@google.com \
    --cc=akpm@linux-foundation.org \
    --cc=alan.maguire@oracle.com \
    --cc=anton.ivanov@cambridgegreys.com \
    --cc=arnd@arndb.de \
    --cc=davidgow@google.com \
    --cc=frowand.list@gmail.com \
    --cc=gregkh@linuxfoundation.org \
    --cc=jdike@addtoit.com \
    --cc=keescook@chromium.org \
    --cc=kunit-dev@googlegroups.com \
    --cc=linux-arch@vger.kernel.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-kselftest@vger.kernel.org \
    --cc=logang@deltatee.com \
    --cc=mcgrof@kernel.org \
    --cc=richard@nod.at \
    --cc=rppt@linux.ibm.com \
    --cc=sboyd@kernel.org \
    --cc=skhan@linuxfoundation.org \
    --cc=yzaikin@google.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.