Documentation: kunit: Remove redundant 'tips.rst' page
Subsystems (4)
PATCH 1/1 Documentation: kunit: Remove redundant 'tips.rst' page
The contents of 'tips.rst' was included in 'usage.rst' way back in
commit 953574390634 ("Documentation: KUnit: Rework writing page to focus on writing tests"), but the tips page remained behind as well.
Therefore, delete 'tips.rst'
While I regret breaking any links to 'tips' which might exist externally, it's confusing to have two subtly different versions of the same content around.
--- Documentation/dev-tools/kunit/index.rst | 1 - Documentation/dev-tools/kunit/tips.rst | 190 ------------------------ 2 files changed, 191 deletions(-) delete mode 100644 Documentation/dev-tools/kunit/tips.rst
Documentation/dev-tools/kunit/index.rst +0 -1
@@ -16,7 +16,6 @@ KUnit - Linux Kernel Unit Testing api/index style faq - tips running_tips This section details the kernel unit testing framework.
Documentation/dev-tools/kunit/tips.rst deleted +0 -190
190 lines not on this page · raw message
Signature · 1 line
2.38.0.135.g90850a2211-goog
Quoted 5 lines · David Gow
The contents of '
tips.rst' was included in 'usage.rst' way back in
commit 953574390634 ("Documentation: KUnit: Rework writing page to focus on writing tests"), but the tips page remained behind as well.
Quoted 7 lines
Therefore, delete '
tips.rst'While I regret breaking any links to 'tips' which might exist externally, it's confusing to have two subtly different versions of the same content around.
Signed-off-by David Gow <[email protected]>
I liked tips.rst, but I agree we should probably remove it for the sake of deduping.
The only blocker in my mind is we're missing an equivalent of:
https://www.kernel.org/doc/html/latest/dev-tools/kunit/tips.html#customizing-error-messages
Non-blocker: we have a duplicate section on assertion vs expectations:
https://www.kernel.org/doc/html/latest/dev-tools/kunit/usage.html#assertions
https://www.kernel.org/doc/html/latest/dev-tools/kunit/usage.html#exiting-early-on-failed-expectations
Daniel