niansa-misc/linux
1
0
Fork 0
mirror of synced 2025-03-06 20:59:54 +01:00
Code Issues Projects Releases Packages Wiki Activity

docs: dt: convert submitting-patches.txt to ReST format

Browse source 
- Add a SPDX header;
- Adjust document and section titles;
- Mark literal blocks as such;
- Add it to bindings/index.rst.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Rob Herring <robh@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2020-04-15 16:45:25 +02:00 • committed by Rob Herring
parent 56516a9fe1
commit 858e684565
6 changed files with 14 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
Documentation/devicetree/bindings/index.rst
View file

@ -8,3 +8,4 @@ Device Tree
:maxdepth: 1 :maxdepth: 1
ABI ABI
submitting-patches

12
Documentation/devicetree/bindings/submitting-patches.txt → Documentation/devicetree/bindings/submitting-patches.rst
View file

@ -1,13 +1,17 @@
.. SPDX-License-Identifier: GPL-2.0
Submitting devicetree (DT) binding patches ==========================================
Submitting devicetree (DT) binding patches
==========================================
I. For patch submitters I. For patch submitters
=======================
0) Normal patch submission rules from Documentation/process/submitting-patches.rst 0) Normal patch submission rules from Documentation/process/submitting-patches.rst
applies. applies.
1) The Documentation/ and include/dt-bindings/ portion of the patch should 1) The Documentation/ and include/dt-bindings/ portion of the patch should
be a separate patch. The preferred subject prefix for binding patches is: be a separate patch. The preferred subject prefix for binding patches is::
"dt-bindings: <binding dir>: ..." "dt-bindings: <binding dir>: ..."
@ -17,7 +21,7 @@ I. For patch submitters
2) DT binding files are written in DT schema format using json-schema 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 vocabulary and YAML file format. The DT binding files must pass validation
by running: by running::
make dt_binding_check make dt_binding_check
@ -60,6 +64,7 @@ I. For patch submitters
II. For kernel maintainers II. For kernel maintainers
==========================
1) If you aren't comfortable reviewing a given binding, reply to it and ask 1) If you aren't comfortable reviewing a given binding, reply to it and ask
the devicetree maintainers for guidance. This will help them prioritize the devicetree maintainers for guidance. This will help them prioritize
@ -76,6 +81,7 @@ II. For kernel maintainers
kept with the driver using the binding. kept with the driver using the binding.
III. Notes III. Notes
==========
0) Please see ...bindings/ABI.txt for details regarding devicetree ABI. 0) Please see ...bindings/ABI.txt for details regarding devicetree ABI.

2
Documentation/devicetree/bindings/writing-bindings.txt
View file

@ -4,7 +4,7 @@ This is a list of common review feedback items focused on binding design. With
every rule, there are exceptions and bindings have many gray areas. every rule, there are exceptions and bindings have many gray areas.
For guidelines related to patches, see For guidelines related to patches, see
Documentation/devicetree/bindings/submitting-patches.txt Documentation/devicetree/bindings/submitting-patches.rst
Overall design Overall design

2
Documentation/process/submitting-patches.rst
View file

@ -16,7 +16,7 @@ for a list of items to check before
submitting code. If you are submitting a driver, also read submitting code. If you are submitting a driver, also read
:ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>`; :ref:`Documentation/process/submitting-drivers.rst <submittingdrivers>`;
for device tree binding patches, read for device tree binding patches, read
Documentation/devicetree/bindings/submitting-patches.txt. Documentation/devicetree/bindings/submitting-patches.rst.
Many of these steps describe the default behavior of the ``git`` version Many of these steps describe the default behavior of the ``git`` version
control system; if you use ``git`` to prepare your patches, you'll find much control system; if you use ``git`` to prepare your patches, you'll find much

2
Documentation/translations/it_IT/process/submitting-patches.rst
View file

@ -21,7 +21,7 @@ Leggete anche :ref:`Documentation/translations/it_IT/process/submit-checklist.rs
per una lista di punti da verificare prima di inviare del codice. Se state per una lista di punti da verificare prima di inviare del codice. Se state
inviando un driver, allora leggete anche :ref:`Documentation/translations/it_IT/process/submitting-drivers.rst <it_submittingdrivers>`; inviando un driver, allora leggete anche :ref:`Documentation/translations/it_IT/process/submitting-drivers.rst <it_submittingdrivers>`;
per delle patch relative alle associazioni per Device Tree leggete per delle patch relative alle associazioni per Device Tree leggete
Documentation/devicetree/bindings/submitting-patches.txt. Documentation/devicetree/bindings/submitting-patches.rst.
Molti di questi passi descrivono il comportamento di base del sistema di Molti di questi passi descrivono il comportamento di base del sistema di
controllo di versione ``git``; se utilizzate ``git`` per preparare le vostre controllo di versione ``git``; se utilizzate ``git`` per preparare le vostre

2
scripts/checkpatch.pl
View file

@ -2594,7 +2594,7 @@ sub process {
if (($last_binding_patch != -1) && if (($last_binding_patch != -1) &&
($last_binding_patch ^ $is_binding_patch)) { ($last_binding_patch ^ $is_binding_patch)) {
WARN("DT_SPLIT_BINDING_PATCH", WARN("DT_SPLIT_BINDING_PATCH",
"DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n"); "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
} }
} }