Re: [PATCH] statx.2: Document STATX_SUBVOL

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 15/03/2024 13:47, Alejandro Colomar wrote:
Hi!


Was there ever an updated version of this patch?

I don't see anything for this in the man pages git yet.



On Mon, Mar 11, 2024 at 07:19:08PM -0700, Eric Biggers wrote:
On Mon, Mar 11, 2024 at 04:31:36PM -0400, Kent Overstreet wrote:
Document the new statxt.stx_subvol field.

This would be clearer if we had a proper API for walking subvolumes that
we could refer to, but that's still coming.

Link: https://lore.kernel.org/linux-fsdevel/20240308022914.196982-1-kent.overstreet@xxxxxxxxx/
Signed-off-by: Kent Overstreet <kent.overstreet@xxxxxxxxx>
Cc: Alejandro Colomar <alx@xxxxxxxxxx>
Cc: linux-man@xxxxxxxxxxxxxxx
Cc: linux-fsdevel@xxxxxxxxxxxxxxx
---
  man2/statx.2 | 8 ++++++++
  1 file changed, 8 insertions(+)

diff --git a/man2/statx.2 b/man2/statx.2
index 0dcf7e20bb1f..480e69b46a89 100644
--- a/man2/statx.2
+++ b/man2/statx.2
@@ -68,6 +68,7 @@ struct statx {
      /* Direct I/O alignment restrictions */
      __u32 stx_dio_mem_align;
      __u32 stx_dio_offset_align;
+    __u64 stx_subvol;      /* Subvolume identifier */
  };
  .EE
  .in
@@ -255,6 +256,8 @@ STATX_ALL	The same as STATX_BASIC_STATS | STATX_BTIME.
  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_SUBVOL	Wants stx_subvol
+	(since Linux 6.9; support varies by filesystem)

The other ones say "Want", not "Wants".

+.TP
+.I stx_subvolume

It's stx_subvol, not stx_subvolume.

+Subvolume number of the current file.
+

Also, don't use blank lines.  We use '.P' for new paragraphs.

+Subvolumes are fancy directories, i.e. they form a tree structure that may be walked recursively.

And please use semantic newlines (see man-pages(7)).

Have a lovely day!
Alex


How about documenting which filesystems support it?

- Eric







[Index of Archives]     [Linux Ext4 Filesystem]     [Union Filesystem]     [Filesystem Testing]     [Ceph Users]     [Ecryptfs]     [NTFS 3]     [AutoFS]     [Kernel Newbies]     [Share Photos]     [Security]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux Cachefs]     [Reiser Filesystem]     [Linux RAID]     [NTFS 3]     [Samba]     [Device Mapper]     [CEPH Development]

  Powered by Linux