linux-kernel - Re: [PATCH 24/45] CacheFiles: Add a hook to write a single page of data to an inode [ver #41]

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Fri, 21 Nov 2008 12:43:41 +0000
From:	David Howells <dhowells@...hat.com>
To:	Andrew Morton <akpm@...ux-foundation.org>
Cc:	dhowells@...hat.com, trond.myklebust@....uio.no,
	viro@...IV.linux.org.uk, nfsv4@...ux-nfs.org,
	linux-kernel@...r.kernel.org, linux-fsdevel@...r.kernel.org,
	Randy Dunlap <randy.dunlap@...cle.com>
Subject: Re: [PATCH 24/45] CacheFiles: Add a hook to write a single page of data to an inode [ver #41]

Andrew Morton <akpm@...ux-foundation.org> wrote:

> Sigh.  I don't normally comment on busted comment layout, but Ingo does
> so I'm allowed to ;) See recent discussion around the kmemleak patches.

Sigh.  Three points for you to consider:

 (1) The prevailing comment style in struct address_space_operations does not
     have comment delimiters on their own lines.  This has the advantage that
     it doesn't unnecessarily waste two lines per comment.  I will advocate
     that style for banner comments for top-level constructs, but for internal
     comments it's generally a poor compromise.

     The following comment on braces applies also to comments:

	Also, note that this brace-placement also minimizes the number of empty
	(or almost empty) lines, without any loss of readability.  Thus, as the
	supply of new-lines on your screen is not a renewable resource (think
	25-line terminal screens here), you have more empty lines to put
	comments on.

 (2) Randy Dunlap should be beaten for his contribution to CodingStyle.  Next
     time I have the opportunity, I'll do just that, and this time I'll see
     about using one of my own racquets rather than one of his:-P

 (3) It's so much easier to write style guides than to properly document one's
     code.

</rant>

> > +/**
> > + * 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?

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

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