Re: [[LINUX PATCH v10] 3/4] Documentation: nand: pl353: Add documentation for controller and driver

[Boris Brezillon]

On Mon, 25 Jun 2018 08:56:41 +0000
Naga Sureshkumar Relli <nagasure@xxxxxxxxxx> wrote:

> Hi Boris,
> 
> > -----Original Message-----
> > From: Boris Brezillon [mailto:boris.brezillon@xxxxxxxxxxx]
> > Sent: Monday, June 25, 2018 2:24 AM
> > To: Naga Sureshkumar Relli <nagasure@xxxxxxxxxx>
> > Cc: richard@xxxxxx; dwmw2@xxxxxxxxxxxxx; computersforpeace@xxxxxxxxx;
> > marek.vasut@xxxxxxxxx; f.fainelli@xxxxxxxxx; mmayer@xxxxxxxxxxxx; rogerq@xxxxxx;
> > ladis@xxxxxxxxxxxxxx; ada@xxxxxxxxxxx; honghui.zhang@xxxxxxxxxxxx;
> > miquel.raynal@xxxxxxxxxxx; nagasureshkumarrelli@xxxxxxxxx; Michal Simek
> > <michals@xxxxxxxxxx>; linux-mtd@xxxxxxxxxxxxxxxxxxx; linux-kernel@xxxxxxxxxxxxxxx
> > Subject: Re: [[LINUX PATCH v10] 3/4] Documentation: nand: pl353: Add documentation
> > for controller and driver
> > 
> > On Thu, 21 Jun 2018 12:12:30 +0530
> > Naga Sureshkumar Relli <naga.sureshkumar.relli@xxxxxxxxxx> wrote:
> >   
> > > Added notes about the controller and driver.
> > >
> > > Signed-off-by: Naga Sureshkumar Relli <naga.sureshkumar.relli@xxxxxxxxxx>
> > > ---
> > > Changes in v10:
> > >  - None
> > > Changes in v9:
> > >  - Addressed the comments given by Miquel and Randy
> > > Changes in v8
> > >  - None
> > > Changes in v7:
> > > - None
> > > Changes in v6:
> > > - None
> > > Changes in v5:
> > > - Fixed the review comments
> > > Changes in v4:
> > > - None
> > > ---
> > >  Documentation/mtd/nand/pl353-nand.txt | 99  
> > +++++++++++++++++++++++++++++++++++  
> > >  1 file changed, 99 insertions(+)
> > >  create mode 100644 Documentation/mtd/nand/pl353-nand.txt  
> > 
> > Can we put these information directly in the driver instead of having
> > yet another place where we have things partially documented? I just
> > discovered a doc for the pxa NAND controller in this directory because
> > of this patch, which kind of proves my point :-).  
> Ok, but could you please explain where to put in driver?
> Do you mean, as comments inside drivers/mtd/raw/pl353-nand.c?

Yes. Either inline, next to the relevant section of code, or at the
beginning of the file.