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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Mon, 2 Nov 2015 09:17:21 +0000
From:	Lee Jones <lee.jones@...aro.org>
To:	"Andrew F. Davis" <afd@...com>
Cc:	Rob Herring <robh+dt@...nel.org>, Pawel Moll <pawel.moll@....com>,
	Mark Rutland <mark.rutland@....com>,
	Ian Campbell <ijc+devicetree@...lion.org.uk>,
	Kumar Gala <galak@...eaurora.org>,
	Linus Walleij <linus.walleij@...aro.org>,
	Alexandre Courbot <gnurou@...il.com>,
	Samuel Ortiz <sameo@...ux.intel.com>,
	Liam Girdwood <lgirdwood@...il.com>,
	Mark Brown <broonie@...nel.org>, devicetree@...r.kernel.org,
	linux-gpio@...r.kernel.org, linux-kernel@...r.kernel.org
Subject: Re: [PATCH v5 1/5] Documentation: tps65912: Add DT bindings for the
 TPS65912 PMIC

On Fri, 30 Oct 2015, Andrew F. Davis wrote:

> 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@...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.

Let's at least attempt to stick to the rules.

Please adapt your formatting to <dt-bindings/gpio/gpio.h> in order to
eradicate any Linuxiness.

> >[...]
> >
> >>>>+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. ;)
> >
> >[...]
> >

-- 
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/