Skip to contentSkip to conversation

ndctl: s/memory/fsdax/ in some user visible places

PATCH In review Ross Zwisler 2 participants 5 messages Apr 9, 2018

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/2 ndctl: s/memory/fsdax/ in some user visible places

Adding on to the work started by:

commit ebb4fb605e68 ("ndctl, create-namespace: introduce "fsdax" and "devdax" modes")

---
 Documentation/ndctl/ndctl-inject-error.txt | 2 +-
 ndctl/namespace.c                          | 8 ++++----
 2 files changed, 5 insertions(+), 5 deletions(-)
Documentation/ndctl/ndctl-inject-error.txt +1 -1
index 01f6c22..94c4e69 100644
@@ -45,7 +45,7 @@ OPTIONS
 
 	NOTE: The offset is interpreted in different ways based on the "mode"
 	of the namespace. For "raw" mode, the offset is the base namespace
-	offset. For "memory" mode (i.e. a "pfn" namespace), the offset is
+	offset. For "fsdax" mode (i.e. a "pfn" namespace), the offset is
 	relative to the user-visible part of the namespace, and the offset
 	introduced by the kernel's metadata will be accounted for. For a
 	"sector" mode namespace (i.e. a "BTT" namespace), the offset is
ndctl/namespace.c +4 -4
index f2c5644..e619dc1 100644
@@ -103,7 +103,7 @@ OPT_STRING('n', "name", &param.name, "name", \
 OPT_STRING('s', "size", &param.size, "size", \
 	"specify the namespace size in bytes (default: available capacity)"), \
 OPT_STRING('m', "mode", &param.mode, "operation-mode", \
-	"specify a mode for the namespace, 'sector', 'memory', or 'raw'"), \
+	"specify a mode for the namespace, 'sector', 'fsdax', or 'raw'"), \
 OPT_STRING('M', "map", &param.map, "memmap-location", \
 	"specify 'mem' or 'dev' for the location of the memmap"), \
 OPT_STRING('l', "sector-size", &param.sector_size, "lba-size", \
@@ -696,7 +696,7 @@ static int validate_namespace_options(struct ndctl_region *region,
 
 		if (ndns && p->mode != NDCTL_NS_MODE_MEMORY
 			&& p->mode != NDCTL_NS_MODE_DAX) {
-			debug("%s: --map= only valid for memory mode namespace\n",
+			debug("%s: --map= only valid for fsdax mode namespace\n",
 				ndctl_namespace_get_devname(ndns));
 			return -EINVAL;
 		}
@@ -709,10 +709,10 @@ static int validate_namespace_options(struct ndctl_region *region,
 		struct ndctl_pfn *pfn = ndctl_region_get_pfn_seed(region);
 
 		if (!pfn && param.mode_default) {
-			debug("%s memory mode not available\n", region_name);
+			debug("%s fsdax mode not available\n", region_name);
 			p->mode = NDCTL_NS_MODE_RAW;
 		} else if (!pfn) {
-			error("operation failed, %s memory mode not available\n",
+			error("operation failed, %s fsdax mode not available\n",
 					region_name);
 			return -EINVAL;
 		}
Signature · 6 lines
2.14.3

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

PATCH 2/2 ndctl: fix some spelling mistakes

---
 Documentation/ndctl/ndctl-create-namespace.txt |  2 +-
 ccan/list/list.h                               | 12 ++++++------
 2 files changed, 7 insertions(+), 7 deletions(-)
Documentation/ndctl/ndctl-create-namespace.txt +1 -1
index 14c5409..29c55f5 100644
@@ -42,7 +42,7 @@ OPTIONS
 -m::
 --mode=::
 	- "raw": expose the namespace capacity directly with
-	  limitations.  Neither a raw pmem namepace nor raw blk
+	  limitations.  Neither a raw pmem namespace nor raw blk
 	  namespace support sector atomicity by default (see "sector"
 	  mode below).  A raw pmem namespace may have limited to no dax
 	  support depending the kernel. In other words operations like
ccan/list/list.h +6 -6
index 4d1d34e..b4c2d75 100644
@@ -540,20 +540,20 @@ static inline void list_prepend_list_(struct list_head *to,
 /**
  * list_for_each_off - iterate through a list of memory regions.
  * @h: the list_head
- * @i: the pointer to a memory region wich contains list node data.
+ * @i: the pointer to a memory region which contains list node data.
  * @off: offset(relative to @i) at which list node data resides.
  *
  * This is a low-level wrapper to iterate @i over the entire list, used to
- * implement all oher, more high-level, for-each constructs. It's a for loop,
+ * implement all other, more high-level, for-each constructs. It's a for loop,
  * so you can break and continue as normal.
  *
  * WARNING! Being the low-level macro that it is, this wrapper doesn't know
- * nor care about the type of @i. The only assumtion made is that @i points
+ * nor care about the type of @i. The only assumption made is that @i points
  * to a chunk of memory that at some @offset, relative to @i, contains a
  * properly filled `struct node_list' which in turn contains pointers to
- * memory chunks and it's turtles all the way down. Whith all that in mind
+ * memory chunks and it's turtles all the way down. With all that in mind
  * remember that given the wrong pointer/offset couple this macro will
- * happilly churn all you memory untill SEGFAULT stops it, in other words
+ * happily churn all you memory until SEGFAULT stops it, in other words
  * caveat emptor.
  *
  * It is worth mentioning that one of legitimate use-cases for that wrapper
@@ -577,7 +577,7 @@ static inline void list_prepend_list_(struct list_head *to,
  * list_for_each_safe_off - iterate through a list of memory regions, maybe
  * during deletion
  * @h: the list_head
- * @i: the pointer to a memory region wich contains list node data.
+ * @i: the pointer to a memory region which contains list node data.
  * @nxt: the structure containing the list_node
  * @off: offset(relative to @i) at which list node data resides.
  *
Signature · 6 lines
2.14.3

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

Re: [ndctl PATCH 2/2] ndctl: fix some spelling mistakes

Quoted 5 lines · Ross Zwisler
---
 Documentation/ndctl/ndctl-create-namespace.txt |  2 +-
 ccan/list/list.h                               | 12 ++++++------

ccan changes should go to the ccan upstream, I don't want to carry local ccan changes in ndctl.
_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm

#3 lore raw
In reply to Ross Zwisler
Quoted 3 lines · Ross Zwisler

Adding on to the work started by:

commit ebb4fb605e68 ("ndctl, create-namespace: introduce "fsdax" and "devdax" modes")

I'd say "why" here.

Also, might as well also convert util_namespace_to_json() to emit "fsdax" in all cases. I had initially thought there were compat concerns with removing the "memory" designation, but it will just cause ongoing confusion. Lets kill its output everywhere, but of course still accept it as a command input.
_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm

#4 lore raw
Quoted 7 lines · Dan Williams
Quoted 3 lines · Ross Zwisler

Adding on to the work started by:

commit ebb4fb605e68 ("ndctl, create-namespace: introduce "fsdax" and "devdax" modes")

I'd say "why" here.

Because having both "memory" and "fsdax" and having to know that they are aliases is confusing. It'd be great if we could just choose one term and stick with it, and I thought the term we had decided on was "fsdax".

Quoted 5 lines

Also, might as well also convert util_namespace_to_json() to emit "fsdax" in all cases. I had initially thought there were compat concerns with removing the "memory" designation, but it will just cause ongoing confusion. Lets kill its output everywhere, but of course still accept it as a command input.

Cool, I think that'd be best.
_______________________________________________
Linux-nvdimm mailing list
[email protected]
https://lists.01.org/mailman/listinfo/linux-nvdimm