[PATCH v2 0/3] Update fanotify man pages for NFSD filecache backports

[PATCH v2 0/3] Update fanotify man pages for NFSD filecache backports

[cel]

From: Chuck Lever <chuck.lever@oracle.com>

I backported a number of NFSD-related fixes to v5.15 and v5.10 LTS
kernels. The backports include some changes to the fanotify API
which need to be documented.

Changes since v1:
- Amir added a few items to the original list of updates

Chuck Lever (3):
  fanotify_mark(2): Support for FA_ flags has been backported to LTS
    kernels
  fanotify_init(2): Support for FA_ flags has been backported to LTS
    kernels
  fanotify(7): Document changes backported to LTS kernels

 man/man2/fanotify_init.2 | 8 ++++----
 man/man2/fanotify_mark.2 | 8 ++++----
 man/man7/fanotify.7      | 2 +-
 3 files changed, 9 insertions(+), 9 deletions(-)

-- 
2.45.1

[PATCH v2 1/3] fanotify_mark(2): Support for FA_ flags has been backported to LTS kernels

[cel]

From: Chuck Lever <chuck.lever@oracle.com>

Reviewed-by: Amir Goldstein <amir73il@gmail.com>
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 man/man2/fanotify_mark.2 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/man/man2/fanotify_mark.2 b/man/man2/fanotify_mark.2
index f3fce0c4e4c4..edeadc883029 100644
--- a/man/man2/fanotify_mark.2
+++ b/man/man2/fanotify_mark.2
@@ -176,7 +176,7 @@ the update fails with
 .B EEXIST
 error.
 .TP
-.BR FAN_MARK_IGNORE " (since Linux 6.0)"
+.BR FAN_MARK_IGNORE " (since Linux 6.0, 5.15.154, and 5.10.220)"
 .\" commit e252f2ed1c8c6c3884ab5dd34e003ed21f1fe6e0
 This flag has a similar effect as setting the
 .B FAN_MARK_IGNORED_MASK
@@ -271,7 +271,7 @@ error.
 This is a synonym for
 .RB ( FAN_MARK_IGNORE | FAN_MARK_IGNORED_SURV_MODIFY ).
 .TP
-.BR FAN_MARK_EVICTABLE " (since Linux 5.19)"
+.BR FAN_MARK_EVICTABLE " (since Linux 5.19, 5.15.154, and 5.10.220)"
 .\" commit 5f9d3bd520261fd7a850818c71809fd580e0f30c
 When an inode mark is created with this flag,
 the inode object will not be pinned to the inode cache,
@@ -362,7 +362,7 @@ Create an event when a marked file or directory itself is deleted.
 An fanotify group that identifies filesystem objects by file handles
 is required.
 .TP
-.BR FAN_FS_ERROR " (since Linux 5.16)"
+.BR FAN_FS_ERROR " (since Linux 5.16, 5.15.154, and 5.10.220)"
 .\" commit 9709bd548f11a092d124698118013f66e1740f9b
 Create an event when a filesystem error
 leading to inconsistent filesystem metadata is detected.
@@ -399,7 +399,7 @@ directory.
 An fanotify group that identifies filesystem objects by file handles
 is required.
 .TP
-.BR FAN_RENAME " (since Linux 5.17)"
+.BR FAN_RENAME " (since Linux 5.17, 5.15.154, and 5.10.220)"
 .\" commit 8cc3b1ccd930fe6971e1527f0c4f1bdc8cb56026
 This event contains the same information provided by events
 .B FAN_MOVED_FROM
-- 
2.45.1

[PATCH v2 2/3] fanotify_init(2): Support for FA_ flags has been backported to LTS kernels

[cel]

From: Chuck Lever <chuck.lever@oracle.com>

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 man/man2/fanotify_init.2 | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/man/man2/fanotify_init.2 b/man/man2/fanotify_init.2
index e5f9cbf298ee..12378ac05255 100644
--- a/man/man2/fanotify_init.2
+++ b/man/man2/fanotify_init.2
@@ -295,7 +295,7 @@ for additional details.
 This is a synonym for
 .RB ( FAN_REPORT_DIR_FID | FAN_REPORT_NAME ).
 .TP
-.BR FAN_REPORT_TARGET_FID " (since Linux 5.17)"
+.BR FAN_REPORT_TARGET_FID " (since Linux 5.17, 5.15.154, and 5.10.220)"
 .\" commit d61fd650e9d206a71fda789f02a1ced4b19944c4
 Events for fanotify groups initialized with this flag
 will contain additional information about the child
@@ -330,7 +330,7 @@ that the directory entry is referring to.
 This is a synonym for
 .RB ( FAN_REPORT_DFID_NAME | FAN_REPORT_FID | FAN_REPORT_TARGET_FID ).
 .TP
-.BR FAN_REPORT_PIDFD " (since Linux 5.15)"
+.BR FAN_REPORT_PIDFD " (since Linux 5.15 and 5.10.220)"
 .\" commit af579beb666aefb17e9a335c12c788c92932baf1
 Events for fanotify groups initialized with this flag will contain
 an additional information record alongside the generic
@@ -460,14 +460,14 @@ The fanotify API is available only if the kernel was configured with
 .B EPERM
 The operation is not permitted because the caller lacks a required capability.
 .SH VERSIONS
-Prior to Linux 5.13,
+Prior to Linux 5.13 (and 5.10.220),
 .\" commit 7cea2a3c505e87a9d6afc78be4a7f7be636a73a7
 calling
 .BR fanotify_init ()
 required the
 .B CAP_SYS_ADMIN
 capability.
-Since Linux 5.13,
+Since Linux 5.13 (and 5.10.220),
 .\" commit 7cea2a3c505e87a9d6afc78be4a7f7be636a73a7
 users may call
 .BR fanotify_init ()
-- 
2.45.1

[PATCH v2 3/3] fanotify(7): Document changes backported to LTS kernels

[cel]

From: Chuck Lever <chuck.lever@oracle.com>

Signed-off-by: Chuck Lever <chuck.lever@oracle.com>
---
 man/man7/fanotify.7 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/man/man7/fanotify.7 b/man/man7/fanotify.7
index 3733543013d5..449af949c0a8 100644
--- a/man/man7/fanotify.7
+++ b/man/man7/fanotify.7
@@ -825,7 +825,7 @@ See
 .BR proc (5)
 for details.
 .P
-Since Linux 5.13,
+Since Linux 5.13 (and 5.10.220),
 .\" commit 5b8fea65d197f408bb00b251c70d842826d6b70b
 the following interfaces can be used to control the amount of
 kernel resources consumed by fanotify:
-- 
2.45.1

Re: [PATCH v2 3/3] fanotify(7): Document changes backported to LTS kernels

[Amir Goldstein]

On Sat, Jul 13, 2024 at 9:16 PM <cel@kernel.org> wrote:
>
> From: Chuck Lever <chuck.lever@oracle.com>
>
> Signed-off-by: Chuck Lever <chuck.lever@oracle.com>

Reviewed-by: Amir Goldstein <amir73il@gmail.com>

> ---
>  man/man7/fanotify.7 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/man/man7/fanotify.7 b/man/man7/fanotify.7
> index 3733543013d5..449af949c0a8 100644
> --- a/man/man7/fanotify.7
> +++ b/man/man7/fanotify.7
> @@ -825,7 +825,7 @@ See
>  .BR proc (5)
>  for details.
>  .P
> -Since Linux 5.13,
> +Since Linux 5.13 (and 5.10.220),
>  .\" commit 5b8fea65d197f408bb00b251c70d842826d6b70b
>  the following interfaces can be used to control the amount of
>  kernel resources consumed by fanotify:
> --
> 2.45.1
>

Re: [PATCH v2 2/3] fanotify_init(2): Support for FA_ flags has been backported to LTS kernels

[Amir Goldstein]

On Sat, Jul 13, 2024 at 9:16 PM <cel@kernel.org> wrote:
>
> From: Chuck Lever <chuck.lever@oracle.com>
>
> Signed-off-by: Chuck Lever <chuck.lever@oracle.com>

Reviewed-by: Amir Goldstein <amir73il@gmail.com>

> ---
>  man/man2/fanotify_init.2 | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
>
> diff --git a/man/man2/fanotify_init.2 b/man/man2/fanotify_init.2
> index e5f9cbf298ee..12378ac05255 100644
> --- a/man/man2/fanotify_init.2
> +++ b/man/man2/fanotify_init.2
> @@ -295,7 +295,7 @@ for additional details.
>  This is a synonym for
>  .RB ( FAN_REPORT_DIR_FID | FAN_REPORT_NAME ).
>  .TP
> -.BR FAN_REPORT_TARGET_FID " (since Linux 5.17)"
> +.BR FAN_REPORT_TARGET_FID " (since Linux 5.17, 5.15.154, and 5.10.220)"
>  .\" commit d61fd650e9d206a71fda789f02a1ced4b19944c4
>  Events for fanotify groups initialized with this flag
>  will contain additional information about the child
> @@ -330,7 +330,7 @@ that the directory entry is referring to.
>  This is a synonym for
>  .RB ( FAN_REPORT_DFID_NAME | FAN_REPORT_FID | FAN_REPORT_TARGET_FID ).
>  .TP
> -.BR FAN_REPORT_PIDFD " (since Linux 5.15)"
> +.BR FAN_REPORT_PIDFD " (since Linux 5.15 and 5.10.220)"
>  .\" commit af579beb666aefb17e9a335c12c788c92932baf1
>  Events for fanotify groups initialized with this flag will contain
>  an additional information record alongside the generic
> @@ -460,14 +460,14 @@ The fanotify API is available only if the kernel was configured with
>  .B EPERM
>  The operation is not permitted because the caller lacks a required capability.
>  .SH VERSIONS
> -Prior to Linux 5.13,
> +Prior to Linux 5.13 (and 5.10.220),
>  .\" commit 7cea2a3c505e87a9d6afc78be4a7f7be636a73a7
>  calling
>  .BR fanotify_init ()
>  required the
>  .B CAP_SYS_ADMIN
>  capability.
> -Since Linux 5.13,
> +Since Linux 5.13 (and 5.10.220),
>  .\" commit 7cea2a3c505e87a9d6afc78be4a7f7be636a73a7
>  users may call
>  .BR fanotify_init ()
> --
> 2.45.1
>

Re: [PATCH v2 0/3] Update fanotify man pages for NFSD filecache backports

[Alejandro Colomar]

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

Hi Chuck, Amir,

On Sat, Jul 13, 2024 at 02:15:45PM GMT, cel@kernel.org wrote:
> From: Chuck Lever <chuck.lever@oracle.com>
> 
> I backported a number of NFSD-related fixes to v5.15 and v5.10 LTS
> kernels. The backports include some changes to the fanotify API
> which need to be documented.
> 
> Changes since v1:
> - Amir added a few items to the original list of updates
> 
> Chuck Lever (3):
>   fanotify_mark(2): Support for FA_ flags has been backported to LTS
>     kernels
>   fanotify_init(2): Support for FA_ flags has been backported to LTS
>     kernels
>   fanotify(7): Document changes backported to LTS kernels

Thanks for the patches, and for reviewing them; I've applied them all.

Have a lovely night!
Alex

> 
>  man/man2/fanotify_init.2 | 8 ++++----
>  man/man2/fanotify_mark.2 | 8 ++++----
>  man/man7/fanotify.7      | 2 +-
>  3 files changed, 9 insertions(+), 9 deletions(-)
> 
> -- 
> 2.45.1
> 

-- 
<https://www.alejandro-colomar.es/>

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