summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSimon Glass <[email protected]>2026-03-06 11:12:51 -0700
committerSimon Glass <[email protected]>2026-03-18 06:14:17 -0600
commit4d17632b9a2866695a312e049f94aa386145bafa (patch)
tree1143097f8049220ac81fba069b1d0d2c446d971d /doc
parentd6b10d2021ed772d5b1404d304db5efa3bc755f5 (diff)
binman: doc: Update binman_tests.rst for subdirectory layout
Update the guidance for adding new tests to describe the subdirectory structure instead of the numbering scheme. Signed-off-by: Simon Glass <[email protected]>
Diffstat (limited to 'doc')
-rw-r--r--doc/develop/binman_tests.rst28
1 files changed, 6 insertions, 22 deletions
diff --git a/doc/develop/binman_tests.rst b/doc/develop/binman_tests.rst
index 74a2d0e8ef2..40865912911 100644
--- a/doc/develop/binman_tests.rst
+++ b/doc/develop/binman_tests.rst
@@ -453,31 +453,15 @@ help with this, but your code will be different.
Generally you are adding a test because you are adding a new entry type
('etype'). So start by creating the shortest and simplest image-description you
-can, which contains the new etype. Put it in a numbered file in
-``tool/binman/test`` so that it comes last. All the numbers are unique and there
-are no gaps.
+can, which contains the new etype. Put it under ``tools/binman/test`` in the
+appropriate subdirectory (e.g. ``fit/`` for FIT image tests, ``vendor/`` for
+vendor-specific tests, ``entry/`` for general entry types) with a descriptive
+filename.
Example from ``tools/binman/test/vendor/nxp_imx8.dts``:
-.. code-block:: devicetree
-
- // SPDX-License-Identifier: GPL-2.0+
-
- /dts-v1/;
-
- / {
- #address-cells = <1>;
- #size-cells = <1>;
-
- binman {
- nxp-imx8mimage {
- args; /* TODO: Needed by mkimage etype superclass */
- nxp,boot-from = "sd";
- nxp,rom-version = <1>;
- nxp,loader-address = <0x10>;
- };
- };
- };
+.. literalinclude:: ../../tools/binman/test/vendor/nxp_imx8.dts
+ :language: devicetree
Note that you should use tabs in the file, not spaces. You can see that this has
been cut down to the bare minimum, just enough to include the etype and the