From: Guenter Roeck <linux@roeck-us•net>
To: linux-kselftest@vger•kernel.org
Cc: x86@kernel•org, loongarch@lists•linux.dev,
linux-doc@vger•kernel.org, dri-devel@lists•freedesktop.org,
"Brendan Higgins" <brendan.higgins@linux•dev>,
linux-riscv@lists•infradead.org,
"David Airlie" <airlied@gmail•com>,
"Arthur Grillo" <arthurgrillo@riseup•net>,
"Ville Syrjälä" <ville.syrjala@linux•intel.com>,
linux-arch@vger•kernel.org, linux-s390@vger•kernel.org,
"Daniel Diaz" <daniel.diaz@linaro•org>,
linux-sh@vger•kernel.org,
"Naresh Kamboju" <naresh.kamboju@linaro•org>,
"Maíra Canal" <mcanal@igalia•com>,
"Dan Carpenter" <dan.carpenter@linaro•org>,
"Linux Kernel Functional Testing" <lkft@linaro•org>,
"Guenter Roeck" <linux@roeck-us•net>,
"Kees Cook" <keescook@chromium•org>,
"Arnd Bergmann" <arnd@arndb•de>,
"Maarten Lankhorst" <maarten.lankhorst@linux•intel.com>,
"Maxime Ripard" <mripard@kernel•org>,
"David Gow" <davidgow@google•com>,
"Daniel Vetter" <daniel@ffwll•ch>,
linux-arm-kernel@lists•infradead.org, kunit-dev@googlegroups•com,
linux-parisc@vger•kernel.org
Subject: [PATCH v3 04/15] kunit: Add documentation for warning backtrace suppression API
Date: Wed, 3 Apr 2024 06:19:25 -0700 [thread overview]
Message-ID: <20240403131936.787234-5-linux@roeck-us.net> (raw)
In-Reply-To: <20240403131936.787234-1-linux@roeck-us.net>
Document API functions for suppressing warning backtraces.
Tested-by: Linux Kernel Functional Testing <lkft@linaro•org>
Acked-by: Dan Carpenter <dan.carpenter@linaro•org>
Reviewed-by: Kees Cook <keescook@chromium•org>
Signed-off-by: Guenter Roeck <linux@roeck-us•net>
---
v2:
- Rebased to v6.9-rc1
- Added Tested-by:, Acked-by:, and Reviewed-by: tags
v3:
- Rebased to v6.9-rc2
Documentation/dev-tools/kunit/usage.rst | 30 ++++++++++++++++++++++++-
1 file changed, 29 insertions(+), 1 deletion(-)
diff --git a/Documentation/dev-tools/kunit/usage.rst b/Documentation/dev-tools/kunit/usage.rst
index 22955d56b379..8d3d36d4103d 100644
--- a/Documentation/dev-tools/kunit/usage.rst
+++ b/Documentation/dev-tools/kunit/usage.rst
@@ -157,6 +157,34 @@ Alternatively, one can take full control over the error message by using
if (some_setup_function())
KUNIT_FAIL(test, "Failed to setup thing for testing");
+Suppressing warning backtraces
+------------------------------
+
+Some unit tests trigger warning backtraces either intentionally or as side
+effect. Such backtraces are normally undesirable since they distract from
+the actual test and may result in the impression that there is a problem.
+
+Such backtraces can be suppressed. To suppress a backtrace in some_function(),
+use the following code.
+
+.. code-block:: c
+
+ static void some_test(struct kunit *test)
+ {
+ DEFINE_SUPPRESSED_WARNING(some_function);
+
+ START_SUPPRESSED_WARNING(some_function);
+ trigger_backtrace();
+ END_SUPPRESSED_WARNING(some_function);
+ }
+
+SUPPRESSED_WARNING_COUNT() returns the number of suppressed backtraces. If the
+suppressed backtrace was triggered on purpose, this can be used to check if
+the backtrace was actually triggered.
+
+.. code-block:: c
+
+ KUNIT_EXPECT_EQ(test, SUPPRESSED_WARNING_COUNT(some_function), 1);
Test Suites
~~~~~~~~~~~
@@ -857,4 +885,4 @@ For example:
dev_managed_string = devm_kstrdup(fake_device, "Hello, World!");
// Everything is cleaned up automatically when the test ends.
- }
\ No newline at end of file
+ }
--
2.39.2
next prev parent reply other threads:[~2024-04-03 13:23 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-04-03 13:19 [PATCH v3 00/15] Add support for suppressing warning backtraces Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 01/15] bug/kunit: Core " Guenter Roeck
2024-04-09 8:29 ` David Gow
2024-04-03 13:19 ` [PATCH v3 02/15] kunit: bug: Count suppressed " Guenter Roeck
2024-04-09 8:29 ` David Gow
2024-04-03 13:19 ` [PATCH v3 03/15] kunit: Add test cases for backtrace warning suppression Guenter Roeck
2024-04-09 8:29 ` David Gow
2024-04-09 18:11 ` Guenter Roeck
2024-04-03 13:19 ` Guenter Roeck [this message]
2024-04-09 8:29 ` [PATCH v3 04/15] kunit: Add documentation for warning backtrace suppression API David Gow
2024-04-03 13:19 ` [PATCH v3 05/15] drm: Suppress intentional warning backtraces in scaling unit tests Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 06/15] net: kunit: Suppress lock warning noise at end of dev_addr_lists tests Guenter Roeck
2024-04-04 1:34 ` Jakub Kicinski
2024-04-08 16:34 ` Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 07/15] x86: Add support for suppressing warning backtraces Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 08/15] arm64: " Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 09/15] loongarch: " Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 10/15] parisc: " Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 11/15] s390: " Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 12/15] sh: " Guenter Roeck
2024-04-03 13:19 ` [PATCH v3 13/15] sh: Move defines needed " Guenter Roeck
2024-04-05 18:31 ` Simon Horman
2024-04-03 13:19 ` [PATCH v3 14/15] riscv: Add support " Guenter Roeck
2024-04-22 17:40 ` Charlie Jenkins
2024-04-03 13:19 ` [PATCH v3 15/15] powerpc: " Guenter Roeck
2024-04-04 2:14 ` Michael Ellerman
2024-04-03 21:20 ` [PATCH v3 00/15] " Kees Cook
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=20240403131936.787234-5-linux@roeck-us.net \
--to=linux@roeck-us$(echo .)net \
--cc=airlied@gmail$(echo .)com \
--cc=arnd@arndb$(echo .)de \
--cc=arthurgrillo@riseup$(echo .)net \
--cc=brendan.higgins@linux$(echo .)dev \
--cc=dan.carpenter@linaro$(echo .)org \
--cc=daniel.diaz@linaro$(echo .)org \
--cc=daniel@ffwll$(echo .)ch \
--cc=davidgow@google$(echo .)com \
--cc=dri-devel@lists$(echo .)freedesktop.org \
--cc=keescook@chromium$(echo .)org \
--cc=kunit-dev@googlegroups$(echo .)com \
--cc=linux-arch@vger$(echo .)kernel.org \
--cc=linux-arm-kernel@lists$(echo .)infradead.org \
--cc=linux-doc@vger$(echo .)kernel.org \
--cc=linux-kselftest@vger$(echo .)kernel.org \
--cc=linux-parisc@vger$(echo .)kernel.org \
--cc=linux-riscv@lists$(echo .)infradead.org \
--cc=linux-s390@vger$(echo .)kernel.org \
--cc=linux-sh@vger$(echo .)kernel.org \
--cc=lkft@linaro$(echo .)org \
--cc=loongarch@lists$(echo .)linux.dev \
--cc=maarten.lankhorst@linux$(echo .)intel.com \
--cc=mcanal@igalia$(echo .)com \
--cc=mripard@kernel$(echo .)org \
--cc=naresh.kamboju@linaro$(echo .)org \
--cc=ville.syrjala@linux$(echo .)intel.com \
--cc=x86@kernel$(echo .)org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox