Re: [PATCH v3 4/4] Documentation: add LP3943 DT bindings and document

[Lee Jones <lee.jones@linaro.org>]

On Sun, 15 Sep 2013, Thierry Reding wrote:

> On Thu, Sep 12, 2013 at 04:24:55PM +0100, Lee Jones wrote:
> > On Thu, 12 Sep 2013, Milo Kim wrote:
> [...]
> > > diff --git a/Documentation/lp3943.txt b/Documentation/lp3943.txt
> > > new file mode 100644
> > > index 0000000..576ebd0
> > > --- /dev/null
> > > +++ b/Documentation/lp3943.txt
> [...]
> > If this stuff is really important (and most of it really isn't), then
> > put it either in the commit log or in the driver.
> 
> I can only speak for myself, but the initial driver commit message is
> about the last place I look for this kind of information. I'd expect it
> to be either somewhere in Documentation/ or in one of the source files.
> In this case I'd probably look at the MFD core driver source file. More
> likely, even, I'd just go google "LP3943" and grab a public datasheet
> from TI where all of this can hopefully be found.

The latter option is the most common. If the datasheet is publicly
available, then there is no rhyme nor reason to put it in the kernel
source too. /Documentation is already overloaded, it would be even
more so if each and every driver residing in the kernel decided to
bulk it up further.

-- 
Lee Jones
Linaro STMicroelectronics Landing Team Lead
Linaro.org │ Open source software for ARM SoCs
Follow Linaro: Facebook | Twitter | Blog