dt: writing-schema: Add a note about tools PATH setup
Rob Herring
maintainerPATCH 1/2 dt: writing-schema: Add a note about tools PATH setup
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 <[email protected]>
Signed-off-by Rob Herring <[email protected]>
--- Documentation/devicetree/writing-schema.rst | 3 +++ 1 file changed, 3 insertions(+)
Documentation/devicetree/writing-schema.rst +3 -0
@@ -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.
Signature · 1 line
2.20.1
Rob Herring
maintainerPATCH 2/2 dt: submitting-patches: Document requirements for DT schema
Update the DT submitting-patches.txt with additional requirements for DT binding schemas. New binding documents should generally use the schema format and have an explicit license.
Signed-off-by Rob Herring <[email protected]>
--- .../bindings/submitting-patches.txt | 21 ++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-)
Documentation/devicetree/bindings/submitting-patches.txt +16 -5
@@ -15,17 +15,28 @@ I. For patch submitters use "Documentation" or "doc" because that is implied. All bindings are docs. Repeating "binding" again should also be avoided. - 2) Submit the entire series to the devicetree mailinglist at + 2) DT binding files are written in DT schema format using json-schema + vocabulary and YAML file format. The DT binding files must pass validation + by running: + + make dt_binding_check + + See ../writing-schema.rst for more details about schema and tools setup. + + 3) DT binding files should be dual licensed. The preferred license tag is + (GPL-2.0-only OR BSD-2-Clause). + + 4) Submit the entire series to the devicetree mailinglist at [email protected] and Cc: the DT maintainers. Use scripts/get_maintainer.pl to identify all of the DT maintainers. - 3) The Documentation/ portion of the patch should come in the series before + 5) The Documentation/ portion of the patch should come in the series before the code implementing the binding. - 4) Any compatible strings used in a chip or board DTS file must be + 6) Any compatible strings used in a chip or board DTS file must be previously documented in the corresponding DT binding text file in Documentation/devicetree/bindings. This rule applies even if the Linux device driver does not yet match on the compatible
@@ -33,7 +44,7 @@ I. For patch submitters followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864 ("checkpatch: add DT compatible string documentation checks"). ] - 5) The wildcard "<chip>" may be used in compatible strings, as in + 7) The wildcard "<chip>" may be used in compatible strings, as in the following example: - compatible: Must contain '"nvidia,<chip>-pcie",
@@ -42,7 +53,7 @@ I. For patch submitters As in the above example, the known values of "<chip>" should be documented if it is used. - 6) If a documented compatible string is not yet matched by the + 8) If a documented compatible string is not yet matched by the driver, the documentation should also include a compatible string that is matched by the driver (as in the "nvidia,tegra20-pcie" example above).
Signature · 1 line
2.20.1