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

Thierry Reding
2013-09-19T11:27:01Z

[-- Attachment #1: Type: text/plain, Size: 1547 bytes --]

On Mon, Sep 16, 2013 at 08:30:00AM +0100, Lee Jones wrote:
> 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.

Okay. So in this case perhaps Milo should simply drop the documentation
file. Perhaps link to the public datasheet from on of the source files,
although that could be problematic if the URL isn't permanent.

Thierry

[-- Attachment #2: Type: application/pgp-signature, Size: 836 bytes --]