[PATCH V2] Add dax mount option to man xfs(5)

[PATCH V2] Add dax mount option to man xfs(5)

[Carlos Maiolino]

Details are already in kernel's documentation, but make dax mount option
information accessible through xfs(5) manpage.

Signed-off-by: Carlos Maiolino <cmaiolino@redhat.com>
---

Changelog:
	V2:
	 - Add changes suggested by Darrick on his review.

 man/man5/xfs.5 | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/man/man5/xfs.5 b/man/man5/xfs.5
index 7642662f..372dc08a 100644
--- a/man/man5/xfs.5
+++ b/man/man5/xfs.5
@@ -133,6 +133,23 @@ by the filesystem.
 CRC enabled filesystems always use the attr2 format, and so
 will reject the noattr2 mount option if it is set.
 .TP
+.BR dax=value
+Set CPU direct access (DAX) behavior for the current filesystem. This mount
+option accepts the following values:
+
+"dax=inode" DAX will be enabled only on regular files with FS_XFLAG_DAX applied.
+
+"dax=never" DAX will not be enabled for any files. FS_XFLAG_DAX will be ignored.
+
+"dax=always" DAX will be enabled for all regular files, regardless of the
+FS_XFLAG_DAX state.
+
+If no option is used when mounting a filesystem stored on a DAX capable device,
+dax=inode will be used as default.
+
+For details regarding DAX behavior in kernel, please refer to kernel's
+documentation at filesystems/dax.txt
+.TP
 .BR discard | nodiscard
 Enable/disable the issuing of commands to let the block
 device reclaim space freed by the filesystem.  This is
-- 
2.30.2

Re: [PATCH V2] Add dax mount option to man xfs(5)

[Darrick J. Wong]

On Tue, Apr 06, 2021 at 01:56:12PM +0200, Carlos Maiolino wrote:
> Details are already in kernel's documentation, but make dax mount option
> information accessible through xfs(5) manpage.
> 
> Signed-off-by: Carlos Maiolino <cmaiolino@redhat.com>

Yay!
Reviewed-by: Darrick J. Wong <djwong@kernel.org>

--D

> ---
> 
> Changelog:
> 	V2:
> 	 - Add changes suggested by Darrick on his review.
> 
>  man/man5/xfs.5 | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/man/man5/xfs.5 b/man/man5/xfs.5
> index 7642662f..372dc08a 100644
> --- a/man/man5/xfs.5
> +++ b/man/man5/xfs.5
> @@ -133,6 +133,23 @@ by the filesystem.
>  CRC enabled filesystems always use the attr2 format, and so
>  will reject the noattr2 mount option if it is set.
>  .TP
> +.BR dax=value
> +Set CPU direct access (DAX) behavior for the current filesystem. This mount
> +option accepts the following values:
> +
> +"dax=inode" DAX will be enabled only on regular files with FS_XFLAG_DAX applied.
> +
> +"dax=never" DAX will not be enabled for any files. FS_XFLAG_DAX will be ignored.
> +
> +"dax=always" DAX will be enabled for all regular files, regardless of the
> +FS_XFLAG_DAX state.
> +
> +If no option is used when mounting a filesystem stored on a DAX capable device,
> +dax=inode will be used as default.
> +
> +For details regarding DAX behavior in kernel, please refer to kernel's
> +documentation at filesystems/dax.txt
> +.TP
>  .BR discard | nodiscard
>  Enable/disable the issuing of commands to let the block
>  device reclaim space freed by the filesystem.  This is
> -- 
> 2.30.2
>