All of lore.kernel.org
 help / color / mirror / Atom feed
From: NeilBrown <neilb@suse.com>
To: "Michael Kerrisk \(man-pages\)" <mtk.manpages@gmail.com>
Cc: mtk.manpages@gmail.com, linux-man@vger.kernel.org,
	"linux-nfs\@vger.kernel.org" <linux-nfs@vger.kernel.org>,
	"linux-fsdevel\@vger.kernel.org" <linux-fsdevel@vger.kernel.org>,
	Lennart Poettering <lennart@poettering.net>
Subject: [manpages PATCH] open_by_handle_at.2: clarify MAX_HANDLE_SZ
Date: Fri, 24 Nov 2017 10:53:36 +1100	[thread overview]
Message-ID: <873754zh4v.fsf@notabene.neil.brown.name> (raw)
In-Reply-To: <52c5800b-150a-7ec9-133b-6c32e97249f4@gmail.com>

[-- Attachment #1: Type: text/plain, Size: 1113 bytes --]


As hinted in the kernel source, MAX_HANDLE_SZ is a hint
rather than a promise:

    /* limit the handle size to NFSv4 handle size now */
    #define MAX_HANDLE_SZ 128

Note the "now" (probably should be "for now").
So change the description to make this clear.

Reported-by: Lennart Poettering <lennart@poettering.net>
Signed-off-by: NeilBrown <neilb@suse.com>
---
 man2/open_by_handle_at.2 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/man2/open_by_handle_at.2 b/man2/open_by_handle_at.2
index 79987308bf3e..f3473d24fa50 100644
--- a/man2/open_by_handle_at.2
+++ b/man2/open_by_handle_at.2
@@ -91,7 +91,8 @@ field should be initialized to contain the allocated size for
 .BR MAX_HANDLE_SZ ,
 defined in
 .IR <fcntl.h> ,
-specifies the maximum possible size for a file handle.)
+specifies the maximum expected size for a file handle. It is not a
+guaranteed upper limit as future filesystems may require more space.)
 Upon successful return, the
 .IR handle_bytes
 field is updated to contain the number of bytes actually written to
-- 
2.14.0.rc0.dirty


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

WARNING: multiple messages have this Message-ID (diff)
From: NeilBrown <neilb-IBi9RG/b67k@public.gmane.org>
Cc: mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org,
	linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org,
	"linux-nfs@vger.kernel.org"
	<linux-nfs-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	"linux-fsdevel@vger.kernel.org"
	<linux-fsdevel-u79uwXL29TY76Z2rM5mHXA@public.gmane.org>,
	Lennart Poettering
	<lennart-mdGvqq1h2p+GdvJs77BJ7Q@public.gmane.org>
Subject: [manpages PATCH] open_by_handle_at.2: clarify MAX_HANDLE_SZ
Date: Fri, 24 Nov 2017 10:53:36 +1100	[thread overview]
Message-ID: <873754zh4v.fsf@notabene.neil.brown.name> (raw)
In-Reply-To: <52c5800b-150a-7ec9-133b-6c32e97249f4-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>

[-- Attachment #1: Type: text/plain, Size: 1158 bytes --]


As hinted in the kernel source, MAX_HANDLE_SZ is a hint
rather than a promise:

    /* limit the handle size to NFSv4 handle size now */
    #define MAX_HANDLE_SZ 128

Note the "now" (probably should be "for now").
So change the description to make this clear.

Reported-by: Lennart Poettering <lennart-mdGvqq1h2p+GdvJs77BJ7Q@public.gmane.org>
Signed-off-by: NeilBrown <neilb-IBi9RG/b67k@public.gmane.org>
---
 man2/open_by_handle_at.2 | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/man2/open_by_handle_at.2 b/man2/open_by_handle_at.2
index 79987308bf3e..f3473d24fa50 100644
--- a/man2/open_by_handle_at.2
+++ b/man2/open_by_handle_at.2
@@ -91,7 +91,8 @@ field should be initialized to contain the allocated size for
 .BR MAX_HANDLE_SZ ,
 defined in
 .IR <fcntl.h> ,
-specifies the maximum possible size for a file handle.)
+specifies the maximum expected size for a file handle. It is not a
+guaranteed upper limit as future filesystems may require more space.)
 Upon successful return, the
 .IR handle_bytes
 field is updated to contain the number of bytes actually written to
-- 
2.14.0.rc0.dirty


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 832 bytes --]

  reply	other threads:[~2017-11-23 23:53 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-11-21 21:15 [manpages PATCH] open_by_handle_at: clarifications needed due to NFS reexport NeilBrown
2017-11-21 21:15 ` NeilBrown
2017-11-22 16:48 ` Michael Kerrisk (man-pages)
2017-11-22 16:48   ` Michael Kerrisk (man-pages)
2017-11-23 23:53   ` NeilBrown [this message]
2017-11-23 23:53     ` [manpages PATCH] open_by_handle_at.2: clarify MAX_HANDLE_SZ NeilBrown
2017-11-24  8:34     ` Michael Kerrisk (man-pages)
2017-11-24  8:34       ` Michael Kerrisk (man-pages)

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=873754zh4v.fsf@notabene.neil.brown.name \
    --to=neilb@suse.com \
    --cc=lennart@poettering.net \
    --cc=linux-fsdevel@vger.kernel.org \
    --cc=linux-man@vger.kernel.org \
    --cc=linux-nfs@vger.kernel.org \
    --cc=mtk.manpages@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body. 
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.