diff mbox

[manpages] open_by_handle_at.2: clarify MAX_HANDLE_SZ

Message ID 873754zh4v.fsf@notabene.neil.brown.name
State New, archived
Headers show

Commit Message

NeilBrown Nov. 23, 2017, 11:53 p.m. UTC
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(-)

Comments

Michael Kerrisk (man-pages) Nov. 24, 2017, 8:34 a.m. UTC | #1
Hello Neil,

On 24 November 2017 at 00:53, NeilBrown <neilb@suse.com> wrote:
>
> 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.

Thanks! Applied.

Cheers,

Michael


> 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
>
diff mbox

Patch

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