Re: [PATCH] statx.2: document STATX_DIO_READ_ALIGN

Alejandro Colomar
2025-01-09T13:21:27Z

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

Hi Christoph,

On Thu, Jan 09, 2025 at 09:32:26AM +0100, Christoph Hellwig wrote:
> Document the new STATX_DIO_READ_ALIGN flag and the new
> stx_dio_read_offset_align field guarded by it.
>
> Signed-off-by: Christoph Hellwig <hch@lst.de>
> Reviewed-by: "Darrick J. Wong" <djwong@kernel.org>

Thanks for the patch! I've applied it.
<https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/commit/?h=contrib&id=3eb8ef31cb5295b5eaaaf319796ea6279b7f7002>

A few minor comments:

Please add the CCd people as Cc: in the commit message. I'll do that
anyway, so it avoids me pasting them, and will probably make it easier
for you to send with git-send-email(1) (or whatever you use).

> Subject: Re: [PATCH] statx.2: document STATX_DIO_READ_ALIGN

I changed commit subjects to use the full path to the manual page.
Also please start with uppercase after the ':'.

Also, please use version numbers for patches (v2, v3, ...).

> ---
> man/man2/statx.2 | 26 +++++++++++++++++++++++++-
> 1 file changed, 25 insertions(+), 1 deletion(-)
>
> diff --git a/man/man2/statx.2 b/man/man2/statx.2
> index c5b5a28ec2f1..7ad9c219a51d 100644
> --- a/man/man2/statx.2
> +++ b/man/man2/statx.2
> @@ -76,6 +76,9 @@ struct statx {
> __u32 stx_atomic_write_unit_min;
> __u32 stx_atomic_write_unit_max;
> __u32 stx_atomic_write_segments_max;
> +

I didn't realize this needed a \&. The CI reminded me. I've amended
that.

Have a lovely day!
Alex

> + /* File offset alignment for direct I/O reads */
> + __u32 stx_dio_read_offset_align;
> };
> .EE
> .in
> @@ -261,7 +264,7 @@ STATX_BTIME Want stx_btime
> STATX_ALL The same as STATX_BASIC_STATS | STATX_BTIME.
> It is deprecated and should not be used.
> STATX_MNT_ID Want stx_mnt_id (since Linux 5.8)
> -STATX_DIOALIGN Want stx_dio_mem_align and stx_dio_offset_align
> +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)
> STATX_SUBVOL Want stx_subvol
> @@ -270,6 +273,8 @@ STATX_WRITE_ATOMIC Want stx_atomic_write_unit_min,
> stx_atomic_write_unit_max,
> and stx_atomic_write_segments_max.
> (since Linux 6.11; support varies by filesystem)
> +STATX_DIO_READ_ALIGN Want stx_dio_read_offset_align.
> + (since Linux 6.14; support varies by filesystem)
> .TE
> .in
> .P
> @@ -467,6 +472,25 @@ This will only be nonzero if
> .I stx_dio_mem_align
> is nonzero, and vice versa.
> .TP
> +.I stx_dio_read_offset_align
> +The alignment (in bytes) required for file offsets and I/O segment lengths for
> +direct I/O reads
> +.RB ( O_DIRECT )
> +on this file.
> +If zero, the limit in
> +.I stx_dio_offset_align
> +applies for reads as well.
> +If non-zero, this value must be smaller than or equal to
> +.I stx_dio_offset_align
> +which must be provided by the file system if requested by the application.
> +The memory alignment in
> +.I stx_dio_mem_align
> +is not affected by this value.
> +.IP
> +.B STATX_DIO_READ_ALIGN
> +.RI ( stx_dio_offset_align )
> +is supported by xfs on regular files since Linux 6.14.
> +.TP
> .I stx_subvol
> Subvolume number of the current file.
> .IP
> --
> 2.45.2
>
>

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

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