[ndctl PATCH] Documentation, create-namespace: clarify fsdax wording

[ndctl PATCH] Documentation, create-namespace: clarify fsdax wording

[Vishal Verma]

Reword the description of the fsdax mode in the create-namespace
documentation to better distinguish when DAX can be used vs. how the raw
block device will use the page cache.

Link: https://github.com/pmem/issues/issues/915
Cc: Dan Williams <dan.j.williams@intel.com>
Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
---
 Documentation/ndctl/ndctl-create-namespace.txt | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/Documentation/ndctl/ndctl-create-namespace.txt b/Documentation/ndctl/ndctl-create-namespace.txt
index 4b8b0d1..343733d 100644
--- a/Documentation/ndctl/ndctl-create-namespace.txt
+++ b/Documentation/ndctl/ndctl-create-namespace.txt
@@ -68,10 +68,11 @@ OPTIONS
 	  comes at the cost of allocating per-page metadata. The
 	  capacity can be allocated from "System RAM", or from a
 	  reserved portion of "Persistent Memory" (see the --map=
-	  option).  Note that a filesystem is required for dax
-	  operation, the resulting raw block device (/dev/pmemX) will
-	  use the page cache. See "devdax" mode for raw device access
-	  that supports dax.
+	  option).  NOTE: A filesystem that supports DAX is required
+	  for dax operation. If the raw block device (/dev/pmemX) is
+	  used directly without a filesystem, it will use the page
+	  cache. See "devdax" mode for raw device access that supports
+	  dax.
 
 	- "devdax": The device-dax character device interface is a
 	  statically allocated / raw access analogue of filesystem-dax
-- 
2.14.4

_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm

Re: [ndctl PATCH] Documentation, create-namespace: clarify fsdax wording

[Ross Zwisler]

On Thu, Jul 19, 2018 at 6:17 PM Vishal Verma <vishal.l.verma@intel.com> wrote:
>
> Reword the description of the fsdax mode in the create-namespace
> documentation to better distinguish when DAX can be used vs. how the raw
> block device will use the page cache.
>
> Link: https://github.com/pmem/issues/issues/915
> Cc: Dan Williams <dan.j.williams@intel.com>
> Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
> ---
>  Documentation/ndctl/ndctl-create-namespace.txt | 9 +++++----
>  1 file changed, 5 insertions(+), 4 deletions(-)
>
> diff --git a/Documentation/ndctl/ndctl-create-namespace.txt b/Documentation/ndctl/ndctl-create-namespace.txt
> index 4b8b0d1..343733d 100644
> --- a/Documentation/ndctl/ndctl-create-namespace.txt
> +++ b/Documentation/ndctl/ndctl-create-namespace.txt
> @@ -68,10 +68,11 @@ OPTIONS
>           comes at the cost of allocating per-page metadata. The
>           capacity can be allocated from "System RAM", or from a
>           reserved portion of "Persistent Memory" (see the --map=
> -         option).  Note that a filesystem is required for dax
> -         operation, the resulting raw block device (/dev/pmemX) will
> -         use the page cache. See "devdax" mode for raw device access
> -         that supports dax.
> +         option).  NOTE: A filesystem that supports DAX is required
> +         for dax operation. If the raw block device (/dev/pmemX) is
> +         used directly without a filesystem, it will use the page
> +         cache. See "devdax" mode for raw device access that supports
> +         dax.

Looks good, you can add:

Reviewed-by: Ross Zwisler <ross.zwisler@linux.intel.com>
_______________________________________________
Linux-nvdimm mailing list
Linux-nvdimm@lists.01.org
https://lists.01.org/mailman/listinfo/linux-nvdimm