Re: [PATCH] kernel-doc: mm/readhead fixup

From: Randy.Dunlap
Date: Mon May 29 2006 - 15:17:40 EST


On Mon, 29 May 2006 12:20:09 -0700 Andrew Morton wrote:

> On Mon, 29 May 2006 12:07:29 -0700
> "Randy.Dunlap" <rdunlap@xxxxxxxxxxxx> wrote:
>
> > From: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
> >
> > Put short function description for read_cache_pages() on one line
> > as needed by kernel-doc.
> >
> > Signed-off-by: Randy Dunlap <rdunlap@xxxxxxxxxxxx>
> > ---
> > mm/readahead.c | 3 +--
> > 1 files changed, 1 insertion(+), 2 deletions(-)
> >
> > --- linux-2617-rc5.orig/mm/readahead.c
> > +++ linux-2617-rc5/mm/readahead.c
> > @@ -118,8 +118,7 @@ static inline unsigned long get_next_ra_
> > #define list_to_page(head) (list_entry((head)->prev, struct page, lru))
> >
> > /**
> > - * read_cache_pages - populate an address space with some pages, and
> > - * start reads against them.
> > + * read_cache_pages - populate an address space with some pages & start reads against them
> > * @mapping: the address_space
> > * @pages: The address of a list_head which contains the target pages. These
> > * pages have their ->index populated and are otherwise uninitialised.
>
> Can kernel-doc be fixed? (I can't see how, give the vague syntax).

I don't know. It's on my list to look at.
I expect that it will require some small syntax changes (but
should maintain backward compatibility).

---
~Randy
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/