Commit ed3648d2 authored by Krzysztof Kozlowski's avatar Krzysztof Kozlowski Committed by Rob Herring

docs: dt: submitting-patches: drop outdated points to TXT format

New bindings in TXT format are not accepted and DT schema format expects
all compatibles to be explicitly defined, thus guidance about "wildcard
<chip>" is not correct anymore.  Drop that paragraph and update one more
place which still mentions TXT files.
Signed-off-by: default avatarKrzysztof Kozlowski <krzysztof.kozlowski@linaro.org>
Link: https://lore.kernel.org/r/20240108083750.16350-1-krzysztof.kozlowski@linaro.orgSigned-off-by: default avatarRob Herring <robh@kernel.org>
parent 9f8bbb53
...@@ -42,28 +42,18 @@ I. For patch submitters ...@@ -42,28 +42,18 @@ I. For patch submitters
the code implementing the binding. the code implementing the binding.
6) 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 previously documented in the corresponding DT binding file
in Documentation/devicetree/bindings. This rule applies even if in Documentation/devicetree/bindings. This rule applies even if
the Linux device driver does not yet match on the compatible the Linux device driver does not yet match on the compatible
string. [ checkpatch will emit warnings if this step is not string. [ checkpatch will emit warnings if this step is not
followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864 followed as of commit bff5da4335256513497cc8c79f9a9d1665e09864
("checkpatch: add DT compatible string documentation checks"). ] ("checkpatch: add DT compatible string documentation checks"). ]
7) The wildcard "<chip>" may be used in compatible strings, as in 7) If a documented compatible string is not yet matched by the
the following example:
- compatible: Must contain '"nvidia,<chip>-pcie",
"nvidia,tegra20-pcie"' where <chip> is tegra30, tegra132, ...
As in the above example, the known values of "<chip>" should be
documented if it is used.
8) If a documented compatible string is not yet matched by the
driver, the documentation should also include a compatible driver, the documentation should also include a compatible
string that is matched by the driver (as in the "nvidia,tegra20-pcie" string that is matched by the driver.
example above).
9) Bindings are actively used by multiple projects other than the Linux 8) Bindings are actively used by multiple projects other than the Linux
Kernel, extra care and consideration may need to be taken when making changes Kernel, extra care and consideration may need to be taken when making changes
to existing bindings. to existing bindings.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment