Documentation/namespace-description: Clarify label-less restrictions
Subsystems (2)
Vishal Verma
maintainerPATCH 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
@@ -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
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.
Reported-by Jane Chu <[email protected]>Cc Dan Williams <[email protected]>Signed-off-by Vishal Verma <[email protected]>--- Documentation/ndctl/namespace-description.txt | 6 ++++++ 1 file changed, 6 insertions(+)Documentation/ndctl/namespace-description.txt +0
-0
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