dt: writing-schema: Add a note about tools PATH setup
authorRob Herring <robh@kernel.org>
Tue, 15 Oct 2019 15:26:00 +0000 (10:26 -0500)
committerRob Herring <robh@kernel.org>
Fri, 25 Oct 2019 14:14:20 +0000 (09:14 -0500)
Users without an existing python install may not have their PATH setup
for pip installed python programs already. Add a note about having the
DT validation programs in the PATH.

Reported-by: Robert Jones <rjones@gateworks.com>
Signed-off-by: Rob Herring <robh@kernel.org>
Documentation/devicetree/writing-schema.rst

index f4a638072262f939c03e148eaa9b84a076457941..3fce61cfd649fe6bd5245b94073bcfaeaaa0fae8 100644 (file)
@@ -117,6 +117,9 @@ project can be installed with pip::
 
     pip3 install git+https://github.com/devicetree-org/dt-schema.git@master
 
+Several executables (dt-doc-validate, dt-mk-schema, dt-validate) will be
+installed. Ensure they are in your PATH (~/.local/bin by default).
+
 dtc must also be built with YAML output support enabled. This requires that
 libyaml and its headers be installed on the host system.