Re: patch: improve generic_file_buffered_write()

[Randy Dunlap <randy.dunlap@oracle.com>]

On Wed, 5 Sep 2007 15:45:36 +0200 Bernd Schubert wrote:

> Hi,

meta-comments:

> filemap.c |  144 
> +++++++++++++++++++++++++++++++++++++++++---------------------
>  1 file changed, 96 insertions(+), 48 deletions(-)

Use "diffstat -p 1 -w 70" per Documentation/SubmittingPatches.


> Index: linux-2.6.20.3/mm/filemap.c
> ===================================================================
> --- linux-2.6.20.3.orig/mm/filemap.c	2007-09-04 13:43:04.000000000 +0200
> +++ linux-2.6.20.3/mm/filemap.c	2007-09-05 12:39:23.000000000 +0200
> @@ -2057,6 +2057,19 @@
>  }
>  EXPORT_SYMBOL(generic_file_direct_write);
>  
> +/**
> + * This function will do 3 main tasks for each iov:
> + * - prepare a write
> + * - copy the data from iov into a new page
> + * - commit this page
> + * @iob:	file operations
> + * @iov:	vector of data to write
> + * @nr_segs:	number of iov segments
> + * @pos:	position in the file
> + * @ppos:	position in the file after this function
> + * @count:	number of bytes to write
> + * written:	offset in iov->base (data to skip on write)
> + */
>  ssize_t
>  generic_file_buffered_write(struct kiocb *iocb, const struct iovec *iov,
>  		unsigned long nr_segs, loff_t pos, loff_t *ppos,

Use proper kernel-doc notation, per Documentation/kernel-doc-nano-HOWTO.txt.

This comment block should be:

/**
 * generic_file_buffered_write - handle an iov
 * @iocb:	file operations
 * @iov:	vector of data to write
 * @nr_segs:	number of iov segments
 * @pos:	position in the file
 * @ppos:	position in the file after this function
 * @count:	number of bytes to write
 * @written:	offset in iov->base (data to skip on write)
 *
 * This function will do 3 main tasks for each iov:
 * - prepare a write
 * - copy the data from iov into a new page
 * - commit this page
 */

---
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***