kunit: split resource API from test.h into new resource.h
Subsystems (4)
PATCH v3 1/2 kunit: split resource API from test.h into new resource.h
Background:
Currently, a reader looking at kunit/test.h will find the file is quite long, and the first meaty comment is a doc comment about struct kunit_resource.
Most users will not ever use the KUnit resource API directly. They'll use kunit_kmalloc() and friends, or decide it's simpler to do cleanups via labels (it often can be) instead of figuring out how to use the API.
It's also logically separate from everything else in test.h. Removing it from the file doesn't cause any compilation errors (since struct kunit has struct list_head resources to store them).
This commit:
Let's move it into a kunit/resource.h file and give it a separate page in the docs, kunit/api/resource.rst.
We include resource.h at the bottom of test.h since
* don't want to force existing users to add a new include if they use the API
* it accesses lock inside struct kunit in a inline func
* so we can't just forward declare, and the alternatives require uninlining the func, adding hepers to lock/unlock, or other more invasive changes.
Now the first big comment in test.h is about kunit_case, which is a lot more relevant to what a new user wants to know.
A side effect of this is git blame won't properly track history by default, users need to run
$ git blame -L ,1 -C17 include/kunit/resource.h
---
v1 -> v2: add TODO to make users #include resource.h, drop redundant fwd decl of struct kunit in resource.h
v2 -> v3: no change.
--- Documentation/dev-tools/kunit/api/index.rst | 5 + .../dev-tools/kunit/api/resource.rst | 13 + include/kunit/resource.h | 318 ++++++++++++++++++ include/kunit/test.h | 303 +---------------- 4 files changed, 340 insertions(+), 299 deletions(-) create mode 100644 Documentation/dev-tools/kunit/api/resource.rst create mode 100644 include/kunit/resource.h
Documentation/dev-tools/kunit/api/index.rst +5 -0
@@ -6,6 +6,7 @@ API Reference .. toctree:: test + resource This section documents the KUnit kernel testing API. It is divided into the following sections:
@@ -13,3 +14,7 @@ following sections: Documentation/dev-tools/kunit/api/test.rst - documents all of the standard testing API + +Documentation/dev-tools/kunit/api/resource.rst + + - documents the KUnit resource API
Documentation/dev-tools/kunit/api/resource.rst new file +13 -0
@@ -0,0 +1,13 @@ +.. SPDX-License-Identifier: GPL-2.0 + +============ +Resource API +============ + +This file documents the KUnit resource API. + +Most users won't need to use this API directly, power users can use it to store +state on a per-test basis, register custom cleanup actions, and more. + +.. kernel-doc:: include/kunit/resource.h + :internal:
include/kunit/resource.h new file +318 -0
318 lines not on this page · raw message
include/kunit/test.h +4 -299
319 lines not on this page · raw message
base-commit: b14ffae378aa1db993e62b01392e70d1e585fb23
Signature · 1 line
2.35.1.1021.g381101b075-goog
PATCH v3 2/2 kunit: split resource API impl from test.c into new resource.c
We've split out the declarations from include/kunit/test.h into resource.h.
This patch splits out the definitions as well for consistency.
A side effect of this is git blame won't properly track history by default, users need to run
$ git blame -L ,1 -C13 lib/kunit/resource.c
---
v1 -> v2: add this patch
v2 -> v3: drop trailing \n at end of resource.c
--- lib/kunit/Makefile | 1 + lib/kunit/resource.c | 125 +++++++++++++++++++++++++++++++++++++++++++ lib/kunit/test.c | 116 +-------------------------------------- 3 files changed, 127 insertions(+), 115 deletions(-) create mode 100644 lib/kunit/resource.c
lib/kunit/Makefile +1 -0
@@ -1,6 +1,7 @@ obj-$(CONFIG_KUNIT) += kunit.o kunit-objs += test.o \ + resource.o \ string-stream.o \ assert.o \ try-catch.o \
lib/kunit/resource.c new file +125 -0
125 lines not on this page · raw message
lib/kunit/test.c +1 -115
131 lines not on this page · raw message
Signature · 1 line
2.35.1.1021.g381101b075-goog