Skip to contentSkip to conversation

mkfs.xfs.8: clarify DAX-vs-reflink restrictions in the mkfs.xfs man page

PATCH In review Eric Sandeen 4 participants 5 messages Aug 27, 2021

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 mkfs.xfs.8: clarify DAX-vs-reflink restrictions in the mkfs.xfs man page

Now that we have the tristate dax mount options, it is possible to enable DAX mode for non-reflinked files on a reflink-capable filesystem. Clarify this in the mkfs.xfs manpage.

---

man/man8/mkfs.xfs.8 +11 -3
index a7f70285..84ac50e8 100644
@@ -316,12 +316,20 @@ option set. When the option
 is used, the reference count btree feature is not supported and reflink is
 disabled.
 .IP
-Note: the filesystem DAX mount option (
+Note: the filesystem-wide DAX mount options (
 .B \-o dax
-) is incompatible with
-reflink-enabled XFS filesystems.  To use filesystem DAX with XFS, specify the
+and
+.B \-o dax=always
+) are incompatible with
+reflink-enabled XFS filesystems.  To use filesystem-wide DAX with XFS, specify the
 .B \-m reflink=0
 option to mkfs.xfs to disable the reflink feature.
+Alternatey, use the
+.B \-o dax=inode
+mount option to selectively enable DAX mode on non-reflinked files.
+See
+.BR xfs (5)
+for more information.
 .RE
 .PP
 .PD 0
Reviewed-by on v1 1/1
#1 lore raw
Quoted 18 lines · Eric Sandeen

Now that we have the tristate dax mount options, it is possible to enable DAX mode for non-reflinked files on a reflink-capable filesystem. Clarify this in the mkfs.xfs manpage.

---

man/man8/mkfs.xfs.8 +1 -1
index a7f70285..84ac50e8 100644
@@ -316,12 +316,20 @@ option set. When the option
 is used, the reference count btree feature is not supported and reflink is
 disabled.
 .IP
-Note: the filesystem DAX mount option (
+Note: the filesystem-wide DAX mount options (

man/man8/mkfs.xfs.8 option set. When the option · line 327

Quoted 10 lines
man/man8/mkfs.xfs.8 +5 -2
 .B \-o dax
-) is incompatible with
-reflink-enabled XFS filesystems.  To use filesystem DAX with XFS, specify the
+and
+.B \-o dax=always
+) are incompatible with
+reflink-enabled XFS filesystems.  To use filesystem-wide DAX with XFS, specify the
 .B \-m reflink=0
 option to mkfs.xfs to disable the reflink feature.
+Alternatey, use the

s /Alternatey/Alternately

man/man8/mkfs.xfs.8 option set. When the option · line 335

Quoted 9 lines
man/man8/mkfs.xfs.8 +5 -0
+.B \-o dax=inode
+mount option to selectively enable DAX mode on non-reflinked files.
+See
+.BR xfs (5)
+for more information.
 .RE
 .PP
 .PD 0
#2 lore raw
Quoted 11 lines · Bill O'Donnell

man/man8/mkfs.xfs.8 option set. When the option · line 327

Quoted 7 lines · Eric Sandeen
man/man8/mkfs.xfs.8 +5 -0
+and
+.B \-o dax=always
+) are incompatible with
+reflink-enabled XFS filesystems.  To use filesystem-wide DAX with XFS, specify the
  .B \-m reflink=0
  option to mkfs.xfs to disable the reflink feature.
+Alternatey, use the

s /Alternatey/Alternately

Doh! Thanks.

-Eric

#3 lore raw
In reply to Eric Sandeen
Quoted 18 lines · Eric Sandeen

Now that we have the tristate dax mount options, it is possible to enable DAX mode for non-reflinked files on a reflink-capable filesystem. Clarify this in the mkfs.xfs manpage.

---

man/man8/mkfs.xfs.8 +1 -1
index a7f70285..84ac50e8 100644
@@ -316,12 +316,20 @@ option set. When the option
 is used, the reference count btree feature is not supported and reflink is
 disabled.
 .IP
-Note: the filesystem DAX mount option (
+Note: the filesystem-wide DAX mount options (

man/man8/mkfs.xfs.8 option set. When the option · line 327

Quoted 10 lines
man/man8/mkfs.xfs.8 +5 -2
 .B \-o dax
-) is incompatible with
-reflink-enabled XFS filesystems.  To use filesystem DAX with XFS, specify the
+and
+.B \-o dax=always
+) are incompatible with
+reflink-enabled XFS filesystems.  To use filesystem-wide DAX with XFS, specify the
 .B \-m reflink=0
 option to mkfs.xfs to disable the reflink feature.
+Alternatey, use the

"Alternately..."

man/man8/mkfs.xfs.8 option set. When the option · line 329

Quoted 2 lines
man/man8/mkfs.xfs.8 +2 -0
+.B \-o dax=inode
+mount option to selectively enable DAX mode on non-reflinked files.

/me wonders if this is dangerously close to wading into the muck that is "Use dax=inode or even no dax option at all, then make sure nobody shares your file's data blocks to set the DAX fsxattr flag on the file, and /then/ you can have DAX."

<shrug> But the only blocker I can see is the misspelling above.

--D

Quoted 7 lines
man/man8/mkfs.xfs.8 +3 -0
+See
+.BR xfs (5)
+for more information.
 .RE
 .PP
 .PD 0
#4 lore raw
Quoted 23 lines · Darrick J. Wong
Quoted 22 lines · Eric Sandeen

Now that we have the tristate dax mount options, it is possible to enable DAX mode for non-reflinked files on a reflink-capable filesystem. Clarify this in the mkfs.xfs manpage.

---

man/man8/mkfs.xfs.8 +2 -3
index a7f70285..84ac50e8 100644
@@ -316,12 +316,20 @@ option set. When the option
  is used, the reference count btree feature is not supported and reflink is
  disabled.
  .IP
-Note: the filesystem DAX mount option (
+Note: the filesystem-wide DAX mount options (
  .B \-o dax
-) is incompatible with
-reflink-enabled XFS filesystems.  To use filesystem DAX with XFS, specify the
+and
Quoted 8 lines

man/man8/mkfs.xfs.8 option set. When the option · line 327

Quoted 6 lines
man/man8/mkfs.xfs.8 +4 -0
+.B \-o dax=always
+) are incompatible with
+reflink-enabled XFS filesystems.  To use filesystem-wide DAX with XFS, specify the
  .B \-m reflink=0
  option to mkfs.xfs to disable the reflink feature.
+Alternatey, use the

"Alternately..."

"Alternatively,"

Quoted 8 lines

man/man8/mkfs.xfs.8 option set. When the option · line 329

Quoted 3 lines
man/man8/mkfs.xfs.8 +2 -0
+.B \-o dax=inode
+mount option to selectively enable DAX mode on non-reflinked files.

/me wonders if this is dangerously close to wading into the muck that is "Use dax=inode or even no dax option at all, then make sure nobody shares your file's data blocks to set the DAX fsxattr flag on the file, and /then/ you can have DAX."

Perhaps I should drop most of it, and just wave hands vaguely at xfs.5?

-Eric