Re: [PATCH 24/45] CacheFiles: Add a hook to write a single page ofdata to an inode [ver #41]

From: Andrew Morton
Date: Fri Nov 21 2008 - 13:31:35 EST


On Fri, 21 Nov 2008 12:43:41 +0000 David Howells <dhowells@xxxxxxxxxx> wrote:

> > > +/**
> > > + * generic_file_buffered_write_one_page - Write a single page of data to an
> > > + * inode
> >
> > kerneldoc doesn't permit line breaks in this context (unless it got
> > fixed recently)
>
> So you advocate a line exceeding 80 chars?

yup

> I contend that kerneldoc is a bad idea in many ways: it encourages people to
> be lazy and to not write proper interface documentation.

yes, for some reason kereldoc-formatted comments usually aren't very
useful. They very often just don't convey useful insights. I wonder
why. Maybe people think that once they've filled out the form and
ticked all the boxes, they're done.

--
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/