Skip to contentSkip to conversation

Documentation, create-namespace: clarify fsdax wording

PATCH In review Vishal Verma 2 participants 2 messages Jul 20, 2018

Subsystems (2)
lore
Share & tools
lore

Vishal Verma

author maintainer
#0 lore raw

PATCH 1/1 Documentation, create-namespace: clarify fsdax wording

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.

---
 Documentation/ndctl/ndctl-create-namespace.txt | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
Documentation/ndctl/ndctl-create-namespace.txt +5 -4
index 4b8b0d1..343733d 100644
@@ -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
Signature · 6 lines
2.14.4

_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm
Reviewed-by on v1 1/1
#1 lore raw
Quoted 19 lines · 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.

---
 Documentation/ndctl/ndctl-create-namespace.txt | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)
Documentation/ndctl/ndctl-create-namespace.txt +0 -0
index 4b8b0d1..343733d 100644
@@ -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

Documentation/ndctl/ndctl-create-namespace.txt OPTIONS · line 75

Quoted 10 lines
Documentation/ndctl/ndctl-create-namespace.txt +5 -4
          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:

_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm