Skip to contentSkip to conversation

Documentation/namespace-description: Clarify label-less restrictions

PATCH Superseded Vishal Verma 2 participants 2 messages Aug 7, 2019 – Aug 8, 2019

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Vishal Verma

author maintainer
#0 lore raw

PATCH 1/1 Documentation/namespace-description: Clarify label-less restrictions

In the ndctl-create-namespace (and related) man pages, add a clarification note regarding some of the restrictions a user may see when operating on label-less namespaces.

---
 Documentation/ndctl/namespace-description.txt | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/ndctl/namespace-description.txt +6 -0
index 94999e5..5f294be 100644
@@ -18,6 +18,12 @@ the kernel's 'memmap=ss!nn' command line option (see the nvdimm wiki on
 kernel.org), or NVDIMMs without a valid 'namespace index' in their label
 area.
 
+NOTE: Label-less namespaces lack many of the features of their label-rich
+cousins. For example, their size cannot be modified, or they cannot be
+'destroyed' (only disabled). The only operation supported on them is to
+change their 'mode', by adding on-media metadata which is then used to
+identify an address abstraction mechanism for the namespace.
+
 A namespace can be provisioned to operate in one of 4 modes, 'fsdax',
 'devdax', 'sector', and 'raw'. Here are the expected usage models for
 these modes:
Signature · 6 lines
2.20.1

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

In the ndctl-create-namespace (and related) man pages, add a clarification note regarding some of the restrictions a user may see when operating on label-less namespaces.

---
 Documentation/ndctl/namespace-description.txt | 6 ++++++
 1 file changed, 6 insertions(+)
Documentation/ndctl/namespace-description.txt +0 -0
index 94999e5..5f294be 100644

Documentation/ndctl/namespace-description.txt the kernel's 'memmap=ss!nn' command line option (see the nvdimm wiki on · line 25

Quoted 8 lines
Documentation/ndctl/namespace-description.txt +5 -0
@@ -18,6 +18,12 @@ the kernel's 'memmap=ss!nn' command line option (see the nvdimm wiki on
 kernel.org), or NVDIMMs without a valid 'namespace index' in their label
 area.
 
+NOTE: Label-less namespaces lack many of the features of their label-rich
+cousins. For example, their size cannot be modified, or they cannot be
+'destroyed' (only disabled). The only operation supported on them is to
+change their 'mode', by adding on-media metadata which is then used to
+identify an address abstraction mechanism for the namespace.

That last sentence is way too obtuse. You could end it at the word 'mode'.

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