On Sat, 20 Mar 2021 12:15:08 +0530 Puranjay Mohan <[email protected]> wrote:
> Add devicetree binding document for TMP117, a digital temperature sensor. Contents looks fine, but the ordering is unusual. Vast majority of bindings I've seen have document in an order that makes sense for human readers (not alphabetical!) Use whitespace to help readability as well. Something like: > @@ -0,0 +1,27 @@ > +# SPDX-License-Identifier: GPL-2.0 > +%YAML 1.2 > +--- > +$id: "http://devicetree.org/schemas/iio/temperature/ti,tmp117.yaml#"; > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"; > +title: "TI TMP117 - Digital temperature sensor with integrated NV memory" > +description: | > + TI TMP117 - Digital temperature sensor with integrated NV memory that > supports Avoid repeating info in the title. > + I2C interface. > + https://www.ti.com/lit/gpn/tmp1 > +maintainers: > + - "Puranjay Mohan <[email protected]>" > +properties: > + compatible: > + enum: > + - "ti,tmp117" > + reg: > + maxItems: 1 > +required: > + - compatible > + - reg > +examples: | > + tmp117@48 { > + compatible = "ti,tmp117"; > + reg = <0x48>; > + }; > > Signed-off-by: Puranjay Mohan <[email protected]> > --- > .../bindings/iio/temperature/ti,tmp117.yaml | 27 +++++++++++++++++++ > 1 file changed, 27 insertions(+) > create mode 100644 > Documentation/devicetree/bindings/iio/temperature/ti,tmp117.yaml > > diff --git a/Documentation/devicetree/bindings/iio/temperature/ti,tmp117.yaml > b/Documentation/devicetree/bindings/iio/temperature/ti,tmp117.yaml > new file mode 100644 > index 000000000..927660461 > --- /dev/null > +++ b/Documentation/devicetree/bindings/iio/temperature/ti,tmp117.yaml > @@ -0,0 +1,27 @@ > +# SPDX-License-Identifier: GPL-2.0 > +%YAML 1.2 > +--- > +$id: "http://devicetree.org/schemas/iio/temperature/ti,tmp117.yaml#"; > +$schema: "http://devicetree.org/meta-schemas/core.yaml#"; > +description: | > + TI TMP117 - Digital temperature sensor with integrated NV memory that > supports > + I2C interface. > + https://www.ti.com/lit/gpn/tmp1 > +examples: | > + tmp117@48 { > + compatible = "ti,tmp117"; > + reg = <0x48>; > + }; > +maintainers: > + - "Puranjay Mohan <[email protected]>" > +properties: > + compatible: > + enum: > + - "ti,tmp117" > + reg: > + maxItems: 1 > +required: > + - compatible > + - reg > +title: "TI TMP117 - Digital temperature sensor with integrated NV memory" > +
