2006-05-29 19:04:53

by Randy Dunlap

[permalink] [raw]
Subject: [PATCH] kernel-doc: mm/readhead fixup

From: Randy Dunlap <[email protected]>

Put short function description for read_cache_pages() on one line
as needed by kernel-doc.

Signed-off-by: Randy Dunlap <[email protected]>
---
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.


---


2006-05-29 19:15:51

by Andrew Morton

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

On Mon, 29 May 2006 12:07:29 -0700
"Randy.Dunlap" <[email protected]> wrote:

> From: Randy Dunlap <[email protected]>
>
> Put short function description for read_cache_pages() on one line
> as needed by kernel-doc.
>
> Signed-off-by: Randy Dunlap <[email protected]>
> ---
> 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).

2006-05-29 19:18:35

by Randy Dunlap

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

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

> On Mon, 29 May 2006 12:07:29 -0700
> "Randy.Dunlap" <[email protected]> wrote:
>
> > From: Randy Dunlap <[email protected]>
> >
> > Put short function description for read_cache_pages() on one line
> > as needed by kernel-doc.
> >
> > Signed-off-by: Randy Dunlap <[email protected]>
> > ---
> > 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