Re: [PATCH v5 1/5] Documentation: tps65912: Add DT bindings for the TPS65912 PMIC

Andrew F. Davis
2015-10-30T19:21:18Z

On 10/30/2015 02:06 PM, Lee Jones wrote:
> On Fri, 30 Oct 2015, Andrew F. Davis wrote:
>
>> On 10/30/2015 12:10 PM, Lee Jones wrote:
>>> On Thu, 29 Oct 2015, Andrew F. Davis wrote:
>>>
>>>> The TPS65912 PMIC contains several regulators and a GPIO controller.
>>>> Add bindings for the TPS65912 PMIC.
>>>>
>>>> Signed-off-by: Andrew F. Davis <afd@ti.com>
>>>> ---
>>>> .../devicetree/bindings/gpio/gpio-tps65912.txt | 16 +++++++
>>>
>>> Why have you dropped Linus' Review-by?
>>>
>>
>> Strange, I thought I made a change to this. Well this brings up a question,
>> how much change can we have before we are supposed to drop Reviewed/Acked-by?
>
> Common sense call I'm afraid. ;)
>
> [...]
>
>>>> + the second cell is used to specify flags.
>>>> + See include/dt-bindings/gpio/gpio.h for possible values.
>>>
>>> This is a Linuxisum and shouldn't really live in here.
>>>
>>> I think it would be better to document them in ../gpio/gpio.txt and
>>> reference that instead.
>>>
>>
>> Looks like that is already in ../gpio/gpio.txt:57
>
> There is a mention of GPIO_ACTIVE_HIGH, as it's used in an example.
> However GPIO_ACTIVE_LOW is missing. I think both could do with
> documenting properly, then you can refer to them from here.
>

I mean the lines above the example, they say to use the macros
defined in include/dt-bindings/gpio/gpio.h whenever possible,
that's really all I would say.

> [...]
>
>>>> +Required properties:
>>>> + - compatible : Should be "ti,tps65912".
>>>> + - reg : Slave address or chip select number (I2C / SPI).
>>>> + - interrupt-parent : The parent interrupt controller.
>>>> + - interrupts : The interrupt line the device is connected to.
>>>> + - interrupt-controller : Marks the device node as an interrupt controller.
>>>> + - #interrupt-cells: The number of cells to describe an IRQ, this should be 2.
>>>> + The first cell is the IRQ number.
>>>> + The second cell is the flags, encoded as the trigger masks from
>>>> + ../interrupt-controller/interrupts.txt
>>>
>>> Nit: We *normally* treat these as bullet-points and not place
>>> full-stops on them:
>>>
>>> $ git grep "compatible" -- Documentation/devicetree/bindings/ | grep -v "\.$" | wc -l
>>> 5227
>>> $ git grep "compatible.*\.$" -- Documentation/devicetree/bindings/ | wc -l
>>> 486
>>>
>>
>> What about for multi-sentence descriptions, we need the middle full-stops, then to not
>> have one on the end seems kinda odd looking.
>
> That's the way I usually do it -- doesn't look too bad. ;)
>
> [...]
>