Re: [PATCH 2/3] fanotify_init.2: move out of place entry FAN_REPORT_FID

["Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>]

On 5/29/20 11:25 AM, Amir Goldstein wrote:
> It was inserted in the middle of the FAN_CLASS_ multi flags bit and
> broke the multi flag documentation.

Thanks, Amir. Patch applied.

Cheers,

Michael


> Signed-off-by: Amir Goldstein <amir73il@gmail.com>
> ---
>  man2/fanotify_init.2 | 60 ++++++++++++++++++++++----------------------
>  1 file changed, 30 insertions(+), 30 deletions(-)
> 
> diff --git a/man2/fanotify_init.2 b/man2/fanotify_init.2
> index 0131575ab..5cfeea023 100644
> --- a/man2/fanotify_init.2
> +++ b/man2/fanotify_init.2
> @@ -94,36 +94,6 @@ already contain their final content.
>  This notification class might be used by malware detection programs, for
>  example.
>  .TP
> -.BR FAN_REPORT_FID " (since Linux 5.1)"
> -.\" commit a8b13aa20afb69161b5123b4f1acc7ea0a03d360
> -This value allows the receipt of events which contain additional information
> -about the underlying filesystem object correlated to an event.
> -An additional structure encapsulates the information about the object and is
> -included alongside the generic event metadata structure.
> -The file descriptor that is used to represent the object correlated to an
> -event is instead substituted with a file handle.
> -It is intended for applications that may find the use of a file handle to
> -identify an object more suitable than a file descriptor.
> -Additionally, it may be used for applications that are interested in
> -directory entry events, such as
> -.BR FAN_CREATE ,
> -.BR FAN_ATTRIB ,
> -.BR FAN_MOVE ,
> -and
> -.BR FAN_DELETE
> -for example.
> -Note that the use of directory modification events are not supported when
> -monitoring a mount point.
> -The use of
> -.BR FAN_CLASS_CONTENT
> -or
> -.BR FAN_CLASS_PRE_CONTENT
> -is not permitted with this flag and will result in the error
> -.BR EINVAL .
> -See
> -.BR fanotify (7)
> -for additional information.
> -.TP
>  .B FAN_CLASS_NOTIF
>  This is the default value.
>  It does not need to be specified.
> @@ -184,6 +154,36 @@ supplied to
>  .BR read (2)
>  (see
>  .BR fanotify (7)).
> +.TP
> +.BR FAN_REPORT_FID " (since Linux 5.1)"
> +.\" commit a8b13aa20afb69161b5123b4f1acc7ea0a03d360
> +This value allows the receipt of events which contain additional information
> +about the underlying filesystem object correlated to an event.
> +An additional structure encapsulates the information about the object and is
> +included alongside the generic event metadata structure.
> +The file descriptor that is used to represent the object correlated to an
> +event is instead substituted with a file handle.
> +It is intended for applications that may find the use of a file handle to
> +identify an object more suitable than a file descriptor.
> +Additionally, it may be used for applications that are interested in
> +directory entry events, such as
> +.BR FAN_CREATE ,
> +.BR FAN_ATTRIB ,
> +.BR FAN_MOVE ,
> +and
> +.BR FAN_DELETE
> +for example.
> +Note that the use of directory modification events are not supported when
> +monitoring a mount point.
> +The use of
> +.BR FAN_CLASS_CONTENT
> +or
> +.BR FAN_CLASS_PRE_CONTENT
> +is not permitted with this flag and will result in the error
> +.BR EINVAL .
> +See
> +.BR fanotify (7)
> +for additional information.
>  .PP
>  The
>  .I event_f_flags
> 


-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/