From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753020AbbKBJRb (ORCPT ); Mon, 2 Nov 2015 04:17:31 -0500 Received: from mail-wm0-f47.google.com ([74.125.82.47]:37831 "EHLO mail-wm0-f47.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1752692AbbKBJR0 (ORCPT ); Mon, 2 Nov 2015 04:17:26 -0500 Date: Mon, 2 Nov 2015 09:17:21 +0000 From: Lee Jones To: "Andrew F. Davis" Cc: Rob Herring , Pawel Moll , Mark Rutland , Ian Campbell , Kumar Gala , Linus Walleij , Alexandre Courbot , Samuel Ortiz , Liam Girdwood , Mark Brown , devicetree@vger.kernel.org, linux-gpio@vger.kernel.org, linux-kernel@vger.kernel.org Subject: Re: [PATCH v5 1/5] Documentation: tps65912: Add DT bindings for the TPS65912 PMIC Message-ID: <20151102091721.GU4058@x1> References: <1446161922-8755-1-git-send-email-afd@ti.com> <1446161922-8755-2-git-send-email-afd@ti.com> <20151030171006.GZ4058@x1> <5633B078.7080209@ti.com> <20151030190622.GN4058@x1> <5633C31E.5030408@ti.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: 8bit In-Reply-To: <5633C31E.5030408@ti.com> User-Agent: Mutt/1.5.21 (2010-09-15) Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org 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 > >>>>--- > >>>> .../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 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