diff mbox series

[1/3] statx.2: Document STATX_MNT_ID_UNIQUE

Message ID a45b2623a25357f33978b49963dad5f99b984386.1719341580.git.josef@toxicpanda.com (mailing list archive)
State New
Headers show
Series man-pages: add documentation for statmount/listmount | expand

Commit Message

Josef Bacik June 25, 2024, 6:56 p.m. UTC
Linux 6.8 adds STATX_MNT_ID_UNIQUE support
https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=98d2b43081972

Add the text and explanation to the statx man page.

Signed-off-by: Josef Bacik <josef@toxicpanda.com>
---
 man/man2/statx.2 | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

Comments

Alejandro Colomar June 25, 2024, 7:55 p.m. UTC | #1
On Tue, Jun 25, 2024 at 02:56:04PM GMT, Josef Bacik wrote:
> Linux 6.8 adds STATX_MNT_ID_UNIQUE support
> https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/commit/?id=98d2b43081972
> 
> Add the text and explanation to the statx man page.
> 
> Signed-off-by: Josef Bacik <josef@toxicpanda.com>

Hi Josef,

Thanks for the patch.  I've applied it with some minor tweaks.  I
changed mostly the line breaks (see /Use semantic newlines/ in
man-pages(7)).

<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=080218fbb88a94db7a9b24858ee5bad2610f13d5>

Have a lovely night!
Alex

> ---
>  man/man2/statx.2 | 12 ++++++++++--
>  1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/man/man2/statx.2 b/man/man2/statx.2
> index 0dcf7e20b..3d5ecd651 100644
> --- a/man/man2/statx.2
> +++ b/man/man2/statx.2
> @@ -234,7 +234,7 @@ .SH DESCRIPTION
>  .I mask
>  is an ORed combination of the following constants:
>  .P
> -.in +4n
> +.in +1n
>  .TS
>  lB l.
>  STATX_TYPE	Want stx_mode & S_IFMT
> @@ -255,6 +255,7 @@ .SH DESCRIPTION
>  STATX_MNT_ID	Want stx_mnt_id (since Linux 5.8)
>  STATX_DIOALIGN	Want stx_dio_mem_align and stx_dio_offset_align
>  	(since Linux 6.1; support varies by filesystem)
> +STATX_MNT_ID_UNIQUE	Want unique stx_mnt_id (since Linux 6.8)
>  .TE
>  .in
>  .P
> @@ -410,11 +411,18 @@ .SH DESCRIPTION
>  .TP
>  .I stx_mnt_id
>  .\" commit fa2fcf4f1df1559a0a4ee0f46915b496cc2ebf60
> -The mount ID of the mount containing the file.
> +If using STATX_MNT_ID, this is the mount ID of the mount containing the file.
>  This is the same number reported by
>  .BR name_to_handle_at (2)
>  and corresponds to the number in the first field in one of the records in
>  .IR /proc/self/mountinfo .
> +.IP
> +If using STATX_MNT_ID_UNIQUE, this is the unique mount ID of the mount
> +containing the file.  This is the number reported by
> +.BR listmount (2)
> +and is the ID used to query the mount with
> +.BR statmount (2) .
> +It is guaranteed to not be reused while the system is running.
>  .TP
>  .I stx_dio_mem_align
>  The alignment (in bytes) required for user memory buffers for direct I/O
> -- 
> 2.43.0
>
diff mbox series

Patch

diff --git a/man/man2/statx.2 b/man/man2/statx.2
index 0dcf7e20b..3d5ecd651 100644
--- a/man/man2/statx.2
+++ b/man/man2/statx.2
@@ -234,7 +234,7 @@  .SH DESCRIPTION
 .I mask
 is an ORed combination of the following constants:
 .P
-.in +4n
+.in +1n
 .TS
 lB l.
 STATX_TYPE	Want stx_mode & S_IFMT
@@ -255,6 +255,7 @@  .SH DESCRIPTION
 STATX_MNT_ID	Want stx_mnt_id (since Linux 5.8)
 STATX_DIOALIGN	Want stx_dio_mem_align and stx_dio_offset_align
 	(since Linux 6.1; support varies by filesystem)
+STATX_MNT_ID_UNIQUE	Want unique stx_mnt_id (since Linux 6.8)
 .TE
 .in
 .P
@@ -410,11 +411,18 @@  .SH DESCRIPTION
 .TP
 .I stx_mnt_id
 .\" commit fa2fcf4f1df1559a0a4ee0f46915b496cc2ebf60
-The mount ID of the mount containing the file.
+If using STATX_MNT_ID, this is the mount ID of the mount containing the file.
 This is the same number reported by
 .BR name_to_handle_at (2)
 and corresponds to the number in the first field in one of the records in
 .IR /proc/self/mountinfo .
+.IP
+If using STATX_MNT_ID_UNIQUE, this is the unique mount ID of the mount
+containing the file.  This is the number reported by
+.BR listmount (2)
+and is the ID used to query the mount with
+.BR statmount (2) .
+It is guaranteed to not be reused while the system is running.
 .TP
 .I stx_dio_mem_align
 The alignment (in bytes) required for user memory buffers for direct I/O