Skip to contentSkip to conversation

Documentation/namespace-description: Clarify label-less restrictions

PATCH In review Vishal Verma 2 participants 2 messages Aug 8, 2019

Subsystems (2)
lore
Share & tools
lore

Vishal Verma

author maintainer
#0 lore raw

PATCH v2 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.

---

v2:
- Remove the part about an address abstraction mechanism; It didn't add any value (Jeff)
- Add an additional sentence about space reclamation semantics (Dan)

 Documentation/ndctl/namespace-description.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
Documentation/ndctl/namespace-description.txt +9 -0
index 94999e5..c59fbef 100644
@@ -18,6 +18,15 @@ 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
+fully 'destroyed' (i.e. the space reclaimed). A destroy operation will
+zero any mode-specific metadata. Finally, for create-namespace operations
+on label-less namespaces, ndctl bypasses the region capacity availability
+checks, and always satisfies the request using the full region capacity.
+The only reconfiguration operation supported on a label-less namespace
+is changing its 'mode'.
+
 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
Reviewed-by on v2 1/1
#1 lore raw
Quoted 8 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.

Quoted 6 lines

---

v2:
- Remove the part about an address abstraction mechanism; It didn't add any value (Jeff)
- Add an additional sentence about space reclamation semantics (Dan)

LGTM

-Jeff

Quoted 14 lines
 Documentation/ndctl/namespace-description.txt | 9 +++++++++
 1 file changed, 9 insertions(+)
Documentation/ndctl/namespace-description.txt +2 -0
index 94999e5..c59fbef 100644
@@ -18,6 +18,15 @@ 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

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

Quoted 10 lines
Documentation/ndctl/namespace-description.txt +7 -0
+fully 'destroyed' (i.e. the space reclaimed). A destroy operation will
+zero any mode-specific metadata. Finally, for create-namespace operations
+on label-less namespaces, ndctl bypasses the region capacity availability
+checks, and always satisfies the request using the full region capacity.
+The only reconfiguration operation supported on a label-less namespace
+is changing its 'mode'.
+
 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:

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