From: Matthew House <mattlloydhouse@gmail.com>
To: Alejandro Colomar <alx@kernel.org>
Cc: linux-man@vger.kernel.org
Subject: [PATCH] fanotify.7: Fix field name in struct fanotify_event_info_fid
Date: Sat, 14 Oct 2023 20:50:27 -0400 [thread overview]
Message-ID: <20231015005029.962889-1-mattlloydhouse@gmail.com> (raw)
The final field of this struct as defined in include/uapi/linux/fanotify.h
(and as used in the example program) is called handle, not file_handle.
Fix this, and also replace the zero-length array with a flexible array
member to match the definition in the header.
Fixes: 0a4db6dc742d ("fanotify.7, fanotify_init.2, fanotify_mark.2: Document FAN_REPORT_FID and directory modification events")
Signed-off-by: Matthew House <mattlloydhouse@gmail.com>
---
man7/fanotify.7 | 17 +++++++++--------
1 file changed, 9 insertions(+), 8 deletions(-)
diff --git a/man7/fanotify.7 b/man7/fanotify.7
index 7c72a2996..1dea4c13c 100644
--- a/man7/fanotify.7
+++ b/man7/fanotify.7
@@ -207,7 +207,7 @@ structure within the read buffer:
struct fanotify_event_info_fid {
struct fanotify_event_info_header hdr;
__kernel_fsid_t fsid;
- unsigned char file_handle[0];
+ unsigned char handle[];
};
.EE
.in
@@ -576,8 +576,9 @@ and contains the same value as
when calling
.BR statfs (2).
.TP
-.I file_handle
-This is a variable length structure of type struct file_handle.
+.I handle
+This field contains a variable-length structure of type
+.IR "struct file_handle" .
It is an opaque handle that corresponds to a specified object on a
filesystem as returned by
.BR name_to_handle_at (2).
@@ -601,14 +602,14 @@ if the value of
field is
.BR FAN_EVENT_INFO_TYPE_FID ,
the
-.I file_handle
+.I handle
identifies the object correlated to the event.
If the value of
.I info_type
field is
.BR FAN_EVENT_INFO_TYPE_DFID ,
the
-.I file_handle
+.I handle
identifies the directory object correlated to the event or the parent directory
of a non-directory object correlated to the event.
If the value of
@@ -616,7 +617,7 @@ If the value of
field is
.BR FAN_EVENT_INFO_TYPE_DFID_NAME ,
the
-.I file_handle
+.I handle
identifies the same directory object that would be reported with
.B FAN_EVENT_INFO_TYPE_DFID
and the file handle is followed by a null terminated string that identifies the
@@ -796,9 +797,9 @@ but not all kinds of error types are reported by all filesystems.
.PP
Errors not directly related to a file (i.e. super block corruption)
are reported with an invalid
-.IR file_handle .
+.IR handle .
For these errors, the
-.I file_handle
+.I handle
will have the field
.I handle_type
set to
--
2.42.0
next reply other threads:[~2023-10-15 0:50 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-10-15 0:50 Matthew House [this message]
2023-10-15 10:43 ` [PATCH] fanotify.7: Fix field name in struct fanotify_event_info_fid Alejandro Colomar
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=20231015005029.962889-1-mattlloydhouse@gmail.com \
--to=mattlloydhouse@gmail.com \
--cc=alx@kernel.org \
--cc=linux-man@vger.kernel.org \
/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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox