summaryrefslogtreecommitdiff
path: root/doc/develop
diff options
context:
space:
mode:
authorSimon Glass <sjg@chromium.org>2024-08-22 07:57:49 -0600
committerTom Rini <trini@konsulko.com>2024-08-26 18:51:49 -0600
commitb073d48e8dd7d178ebd237089be730d15c72ddfc (patch)
treeabc9d5842979f4c495528da9cf08ca2f26ee8554 /doc/develop
parent725c438c6271f1870636f61a68d6904dc27a1357 (diff)
test: Drop the blank line before test macros
Most tests don't have this. It helps to keep the test declaration clearly associated with the function it relates to, rather than the next one in the file. Remove the extra blank line and mention this in the docs. Signed-off-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc/develop')
-rw-r--r--doc/develop/tests_writing.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/develop/tests_writing.rst b/doc/develop/tests_writing.rst
index 655eb95110d..c277c8dd44f 100644
--- a/doc/develop/tests_writing.rst
+++ b/doc/develop/tests_writing.rst
@@ -228,6 +228,9 @@ Declare the test with::
}
DM_TEST(dm_test_uclassname_what, UTF_SCAN_FDT);
+Note that the convention is to NOT add a blank line before the macro, so that
+the function it relates to is more obvious.
+
Replace 'uclassname' with the name of your uclass, if applicable. Replace 'what'
with what you are testing.