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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20180625111321.652d12ff@bbrezillon>
Date:   Mon, 25 Jun 2018 11:13:21 +0200
From:   Boris Brezillon <boris.brezillon@...tlin.com>
To:     Naga Sureshkumar Relli <nagasure@...inx.com>
Cc:     "richard@....at" <richard@....at>,
        "dwmw2@...radead.org" <dwmw2@...radead.org>,
        "computersforpeace@...il.com" <computersforpeace@...il.com>,
        "marek.vasut@...il.com" <marek.vasut@...il.com>,
        "f.fainelli@...il.com" <f.fainelli@...il.com>,
        "mmayer@...adcom.com" <mmayer@...adcom.com>,
        "rogerq@...com" <rogerq@...com>,
        "ladis@...ux-mips.org" <ladis@...ux-mips.org>,
        "ada@...rsis.com" <ada@...rsis.com>,
        "honghui.zhang@...iatek.com" <honghui.zhang@...iatek.com>,
        "miquel.raynal@...tlin.com" <miquel.raynal@...tlin.com>,
        "nagasureshkumarrelli@...il.com" <nagasureshkumarrelli@...il.com>,
        Michal Simek <michals@...inx.com>,
        "linux-mtd@...ts.infradead.org" <linux-mtd@...ts.infradead.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>
Subject: Re: [[LINUX PATCH v10] 3/4] Documentation: nand: pl353: Add
 documentation for controller and driver

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

> Hi Boris,
> 
> > -----Original Message-----
> > From: Boris Brezillon [mailto:boris.brezillon@...tlin.com]
> > Sent: Monday, June 25, 2018 2:24 AM
> > To: Naga Sureshkumar Relli <nagasure@...inx.com>
> > Cc: richard@....at; dwmw2@...radead.org; computersforpeace@...il.com;
> > marek.vasut@...il.com; f.fainelli@...il.com; mmayer@...adcom.com; rogerq@...com;
> > ladis@...ux-mips.org; ada@...rsis.com; honghui.zhang@...iatek.com;
> > miquel.raynal@...tlin.com; nagasureshkumarrelli@...il.com; Michal Simek
> > <michals@...inx.com>; linux-mtd@...ts.infradead.org; linux-kernel@...r.kernel.org
> > 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@...inx.com> wrote:
> >   
> > > Added notes about the controller and driver.
> > >
> > > Signed-off-by: Naga Sureshkumar Relli <naga.sureshkumar.relli@...inx.com>
> > > ---
> > > 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.