Re: [PATCH] silence 'make xmldocs' warning by adding missing description of 'raw' in nand_base.c:1485

Re: [PATCH] silence 'make xmldocs' warning by adding missing description of 'raw' in nand_base.c:1485

[Thomas Gleixner]

On Thu, 2006-10-26 at 01:43 +0200, Jesper Juhl wrote:
> 'make xmldocs' currently gives me this warning :
> 
>     Warning(/home/juhl/download/kernel/linux-2.6//drivers/mtd/nand/nand_base.c:1485): No description found for parameter 'raw'
> 
> This patch silences the warning by adding a description for 'raw'
> 
> 
> Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>

ACK
	tglx

Re: [PATCH] silence 'make xmldocs' warning by adding missing description of 'raw' in nand_base.c:1485

[Jesper Juhl]

On Thursday 26 October 2006 07:27, Thomas Gleixner wrote:
> On Thu, 2006-10-26 at 01:43 +0200, Jesper Juhl wrote:
> > 'make xmldocs' currently gives me this warning :
> > 
> >     Warning(/home/juhl/download/kernel/linux-2.6//drivers/mtd/nand/nand_base.c:1485): No description found for parameter 'raw'
> > 
> > This patch silences the warning by adding a description for 'raw'
> > 
> > 
> > Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
> 
> ACK
> 	tglx
> 
Thank you for the ACK Thomas.

Linus: Could you add this to your tree?  I believe it's still appropriate even at -rc3 since it doesn't make any code changes but simply fix an annoying warning.
Patch included (again) below for your convenience : 


Add description of 'raw' in comments for 
drivers/mtd/nand/nand_base.c::nand_write_page_syndrome() so 'make xmldocs' 
will not spew a warning at us.

Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
---

 drivers/mtd/nand/nand_base.c |    1 +
 1 files changed, 1 insertions(+), 0 deletions(-)

diff --git a/drivers/mtd/nand/nand_base.c b/drivers/mtd/nand/nand_base.c
index baece61..41bfcae 100644
--- a/drivers/mtd/nand/nand_base.c
+++ b/drivers/mtd/nand/nand_base.c
@@ -1479,6 +1479,7 @@ static void nand_write_page_syndrome(str
  * @buf:	the data to write
  * @page:	page number to write
  * @cached:	cached programming
+ * @raw:	use _raw version of write_page
  */
 static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
 			   const uint8_t *buf, int page, int cached, int raw)

Re: [PATCH] silence 'make xmldocs' warning by adding missing description of 'raw' in nand_base.c:1485

[Randy Dunlap]

On Fri, 27 Oct 2006 22:59:03 GMT Linux Kernel Mailing List wrote:

> commit efbfe96c5d839c367249bf1cd53249716450c0a2
> tree 36a1a7d72586a2f8fd25feb225cd4e627cd275b3
> parent 735a7ffb739b6efeaeb1e720306ba308eaaeb20e
> author Jesper Juhl <jesper.juhl@gmail.com> 1161984287 +0200
> committer Linus Torvalds <torvalds@g5.osdl.org> 1161988491 -0700
> 
> [PATCH] silence 'make xmldocs' warning by adding missing description of 'raw' in nand_base.c:1485
> 
> Add description of 'raw' in comments for
> drivers/mtd/nand/nand_base.c::nand_write_page_syndrome() so 'make xmldocs'
> will not spew a warning at us.
> 
> Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
> Acked-by: Thomas Gleixner <tglx@linutronix.de>
> Signed-off-by: Linus Torvalds <torvalds@osdl.org>
> 
>  drivers/mtd/nand/nand_base.c |    1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/drivers/mtd/nand/nand_base.c b/drivers/mtd/nand/nand_base.c
> index baece61..41bfcae 100644
> --- a/drivers/mtd/nand/nand_base.c
> +++ b/drivers/mtd/nand/nand_base.c
> @@ -1479,6 +1479,7 @@ static void nand_write_page_syndrome(str
>   * @buf:	the data to write
>   * @page:	page number to write
>   * @cached:	cached programming
> + * @raw:	use _raw version of write_page
>   */
>  static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
>  			   const uint8_t *buf, int page, int cached, int raw)
> -

Hi Jesper,
I'm still seeing a kernel-doc warning in include/linux/mtd/nand.h.
Do you not see it also?

Patch is here:
http://marc.theaimsgroup.com/?l=linux-mm-commits&m=116189778426861&w=2

---
~Randy

Re: [PATCH] silence 'make xmldocs' warning by adding missing description of 'raw' in nand_base.c:1485

[Jesper Juhl]

On 28/10/06, Randy Dunlap <randy.dunlap@oracle.com> wrote:
> On Fri, 27 Oct 2006 22:59:03 GMT Linux Kernel Mailing List wrote:
>
> > commit efbfe96c5d839c367249bf1cd53249716450c0a2
> > tree 36a1a7d72586a2f8fd25feb225cd4e627cd275b3
> > parent 735a7ffb739b6efeaeb1e720306ba308eaaeb20e
> > author Jesper Juhl <jesper.juhl@gmail.com> 1161984287 +0200
> > committer Linus Torvalds <torvalds@g5.osdl.org> 1161988491 -0700
> >
> > [PATCH] silence 'make xmldocs' warning by adding missing description of 'raw' in nand_base.c:1485
> >
> > Add description of 'raw' in comments for
> > drivers/mtd/nand/nand_base.c::nand_write_page_syndrome() so 'make xmldocs'
> > will not spew a warning at us.
> >
> > Signed-off-by: Jesper Juhl <jesper.juhl@gmail.com>
> > Acked-by: Thomas Gleixner <tglx@linutronix.de>
> > Signed-off-by: Linus Torvalds <torvalds@osdl.org>
> >
> >  drivers/mtd/nand/nand_base.c |    1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/drivers/mtd/nand/nand_base.c b/drivers/mtd/nand/nand_base.c
> > index baece61..41bfcae 100644
> > --- a/drivers/mtd/nand/nand_base.c
> > +++ b/drivers/mtd/nand/nand_base.c
> > @@ -1479,6 +1479,7 @@ static void nand_write_page_syndrome(str
> >   * @buf:     the data to write
> >   * @page:    page number to write
> >   * @cached:  cached programming
> > + * @raw:     use _raw version of write_page
> >   */
> >  static int nand_write_page(struct mtd_info *mtd, struct nand_chip *chip,
> >                          const uint8_t *buf, int page, int cached, int raw)
> > -
>
> Hi Jesper,
> I'm still seeing a kernel-doc warning in include/linux/mtd/nand.h.
> Do you not see it also?
>
I see it, simply got distracted when doing the patch and forgot about it.


> Patch is here:
> http://marc.theaimsgroup.com/?l=linux-mm-commits&m=116189778426861&w=2
>
Looks good.

-- 
Jesper Juhl <jesper.juhl@gmail.com>
Don't top-post  http://www.catb.org/~esr/jargon/html/T/top-post.html
Plain text mails only, please      http://www.expita.com/nomime.html