[PATCH v2 00/27] Armada 370/XP NAND support
Jason Cooper
jason at lakedaemon.net
Sun Oct 20 15:24:41 EDT 2013
On Sun, Oct 20, 2013 at 07:50:49PM +0200, Thomas Petazzoni wrote:
> Dear Ezequiel Garcia,
>
> On Sat, 19 Oct 2013 13:21:59 -0300, Ezequiel Garcia wrote:
>
> > > > I strongly believe that all the information above is very valuable and
> > > > that it's a shame to lose it in a cover message. It would definitely
> > > > make sense to have this in a doc file.
> > >
> > > Agreed. Great work Ezequiel! Let's capture this in Documentation/.
> > >
> >
> > Wait a second!
> >
> > $ ls Documentation/mtd/ | wc -l
> > 1
> >
> > Isn't documenting deprecated? ...
> >
> > Just kiddin'! I'll add this and the other cover to Documentation/
> > so typos and english fixes are welcome!
>
> I certainly agree this documentation should be kept, but I'm wondering
> if keeping it as a comment inside the driver doesn't make more sense.
That's a _long_ comment...
> This document is really more about specific implementation details, and
> the next person looking at the driver is not very likely to search such
> details in Documentation/, in my opinion.
A succinct comment in the code pointing to the Documentation/ should be
sufficient.
thx,
Jason.
More information about the linux-arm-kernel
mailing list