diff mbox series

[v2] dt-bindings: iio: Document "label" property

Message ID 20211221133339.66766-1-paul@crapouillou.net (mailing list archive)
State Deferred
Headers show
Series [v2] dt-bindings: iio: Document "label" property | expand

Commit Message

Paul Cercueil Dec. 21, 2021, 1:33 p.m. UTC
Document the "label" property, which can contain a descriptive label
that allows to uniquely identify a device within the system.

Signed-off-by: Paul Cercueil <paul@crapouillou.net>
---

Notes:
    v2: - Reword description and commit message
        - Use > instead of | for proper multiline handling

 Documentation/devicetree/bindings/iio/common.yaml | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Rob Herring (Arm) Dec. 22, 2021, 6:37 p.m. UTC | #1
On Tue, 21 Dec 2021 13:33:39 +0000, Paul Cercueil wrote:
> Document the "label" property, which can contain a descriptive label
> that allows to uniquely identify a device within the system.
> 
> Signed-off-by: Paul Cercueil <paul@crapouillou.net>
> ---
> 
> Notes:
>     v2: - Reword description and commit message
>         - Use > instead of | for proper multiline handling
> 
>  Documentation/devicetree/bindings/iio/common.yaml | 6 ++++++
>  1 file changed, 6 insertions(+)
> 

Acked-by: Rob Herring <robh@kernel.org>
Paul Cercueil Dec. 23, 2021, 10:51 a.m. UTC | #2
Jonathan:

Please ignore this patch for now - I will add a global definition in 
dtschema instead.

Cheers,
-Paul

Le mar., déc. 21 2021 at 13:33:39 +0000, Paul Cercueil 
<paul@crapouillou.net> a écrit :
> Document the "label" property, which can contain a descriptive label
> that allows to uniquely identify a device within the system.
> 
> Signed-off-by: Paul Cercueil <paul@crapouillou.net>
> ---
> 
> Notes:
>     v2: - Reword description and commit message
>         - Use > instead of | for proper multiline handling
> 
>  Documentation/devicetree/bindings/iio/common.yaml | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/iio/common.yaml 
> b/Documentation/devicetree/bindings/iio/common.yaml
> index f845b41d74c4..49f9f62dbb3e 100644
> --- a/Documentation/devicetree/bindings/iio/common.yaml
> +++ b/Documentation/devicetree/bindings/iio/common.yaml
> @@ -32,6 +32,12 @@ properties:
>        considered 'near' to the device (an object is near to the
>        sensor).
> 
> +  label:
> +    $ref: /schemas/types.yaml#/definitions/string
> +    description: >
> +      Optional descriptive label that allows to uniquely identify a 
> device
> +      within the system.
> +
>  additionalProperties: true
> 
>  ...
> --
> 2.34.1
>
diff mbox series

Patch

diff --git a/Documentation/devicetree/bindings/iio/common.yaml b/Documentation/devicetree/bindings/iio/common.yaml
index f845b41d74c4..49f9f62dbb3e 100644
--- a/Documentation/devicetree/bindings/iio/common.yaml
+++ b/Documentation/devicetree/bindings/iio/common.yaml
@@ -32,6 +32,12 @@  properties:
       considered 'near' to the device (an object is near to the
       sensor).
 
+  label:
+    $ref: /schemas/types.yaml#/definitions/string
+    description: >
+      Optional descriptive label that allows to uniquely identify a device
+      within the system.
+
 additionalProperties: true
 
 ...