diff mbox

[v2,17/17] locks: clean up comments over fl_owner_t definition

Message ID 1409834323-7171-18-git-send-email-jlayton@primarydata.com (mailing list archive)
State New, archived
Headers show

Commit Message

Jeff Layton Sept. 4, 2014, 12:38 p.m. UTC
The contents of an fl_owner_t have morphed a bit over the years, fix up
the comments to account for the changes.

Signed-off-by: Jeff Layton <jlayton@primarydata.com>
---
 include/linux/fs.h | 16 ++++++++++++----
 1 file changed, 12 insertions(+), 4 deletions(-)

Comments

Christoph Hellwig Sept. 4, 2014, 5:53 p.m. UTC | #1
On Thu, Sep 04, 2014 at 08:38:43AM -0400, Jeff Layton wrote:
> The contents of an fl_owner_t have morphed a bit over the years, fix up
> the comments to account for the changes.

Instead of listing all the owners I'd just put something in like:

/* legacy typedef, will go away soon */
--
To unsubscribe from this list: send the line "unsubscribe linux-nfs" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Jeff Layton Sept. 5, 2014, 1:36 p.m. UTC | #2
On Thu, 4 Sep 2014 10:53:34 -0700
Christoph Hellwig <hch@infradead.org> wrote:

> On Thu, Sep 04, 2014 at 08:38:43AM -0400, Jeff Layton wrote:
> > The contents of an fl_owner_t have morphed a bit over the years, fix up
> > the comments to account for the changes.
> 
> Instead of listing all the owners I'd just put something in like:
> 
> /* legacy typedef, will go away soon */

For some definition of "soon" ;)? How about:

   /* legacy typedef, should eventually go away */

I'll change it to read that and probably squash this change in with
another patch.
diff mbox

Patch

diff --git a/include/linux/fs.h b/include/linux/fs.h
index ed4e1897099c..a51be79b7dc3 100644
--- a/include/linux/fs.h
+++ b/include/linux/fs.h
@@ -852,11 +852,19 @@  static inline struct file *get_file(struct file *f)
 #define FILE_LOCK_DEFERRED 1
 
 /*
- * The POSIX file lock owner is determined by
- * the "struct files_struct" in the thread group
- * (or NULL for no owner - BSD locks).
+ * A generic "file lock owner" value. This is set differently for different
+ * types of locks.
  *
- * Lockd stuffs a "host" pointer into this.
+ * The POSIX file lock owner is determined by the "struct files_struct" in the
+ * thread group.
+ *
+ * Flock (BSD) locks, OFD locks and leases set the fl_owner to the
+ * file description pointer.
+ *
+ * lockd stuffs a "host" pointer into this
+ *
+ * nfsd stuffs a * nfs4_file pointer into this for leases, and a lockowner
+ * pointer into it for v4 locks.
  */
 typedef void *fl_owner_t;