diff mbox series

[v3,1/3] Add validation instructions

Message ID 20230821180220.2724080-1-sjg@chromium.org
State New
Headers show
Series [v3,1/3] Add validation instructions | expand

Commit Message

Simon Glass Aug. 21, 2023, 6:01 p.m. UTC 
Add simple instructions for people wanting to validate their schema.

Signed-off-by: Simon Glass <sjg@chromium.org>
---

(no changes since v1)

 README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
diff mbox series

Patch

diff --git a/README.md b/README.md
index 9d2f6e8..d8767fa 100644
--- a/README.md
+++ b/README.md
@@ -118,6 +118,25 @@  Example:
 dt-check-compatible -s processed-schema.json vendor,a-compatible
 ```
 
+## Testing your changes
+
+Once you add or change schema, you should test it locally. This assumes that
+your system is set up so that 'python' runs Python 3.
+
+First make sure you don't have any existing dt-schema in your system as this
+may interfere:
+
+```
+sudo apt-get remove dt-schema
+pip remove dt-schema
+```
+
+Then, to validate, use:
+
+```
+PYTHONPATH=. test/test-dt-validate.py
+```
+
 ## Installing
 The project and its dependencies can be installed with pip: