From: Andrew Morton Subject: Re: [PATCH] Remove fcntl f_op Date: Sun, 15 Aug 2004 10:43:47 -0700 Sender: linux-fsdevel-owner@vger.kernel.org Message-ID: <20040815104347.7d9b2b95.akpm@osdl.org> References: <20040812221229.GH12936@parcelfarce.linux.theplanet.co.uk> <20040814233906.0df76f12.akpm@osdl.org> <20040815125240.GF12936@parcelfarce.linux.theplanet.co.uk> Mime-Version: 1.0 Content-Type: text/plain; charset=US-ASCII Content-Transfer-Encoding: 7bit Cc: torvalds@osdl.org, linux-fsdevel@vger.kernel.org, smfrench@austin.rr.com, trond.myklebust@fys.uio.no Return-path: Received: from fw.osdl.org ([65.172.181.6]:4063 "EHLO mail.osdl.org") by vger.kernel.org with ESMTP id S266769AbUHORpY (ORCPT ); Sun, 15 Aug 2004 13:45:24 -0400 To: Matthew Wilcox In-Reply-To: <20040815125240.GF12936@parcelfarce.linux.theplanet.co.uk> List-Id: linux-fsdevel.vger.kernel.org Matthew Wilcox wrote: > > I documented them where the other file_operations are > documented, in Documentation/filesystems/Locking. Documentation/filesystems/Locking does document address_space_ops. But not, it seems, file_operations. > If you wanted Documentation/filesystems/vfs.txt to mention them, well, > that needs to be updated to something from this decade first -- I can't > believe anyone's actually reading that. Just from file_operations, > it's missing aio_read, aio_write, aio_fsync, readv, writev, sendfile, > sendpage and get_unmapped_area. It also claims check_media_change and > revalidate are file_operations, when they aren't. > > If there's somewhere else to document them, I'd be only too happy to. Documentation in Documentation/ goes out of date - we've seen this again and again and again. Documentation in code comments gets a lot more eyeball time, and people spot errors and omissions. For this reason, I'd suggest that we prefer to document the code inside the code. External interfaces and things which are distributed all over the tree (proc.txt, kernel-parameters.txt, etc) are more appropriately handled in Documentation/.