| Message ID | 20190807221815.25782-1-vishal.l.verma@intel.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [ndctl] Documentation/namespace-description: Clarify label-less restrictions | expand |
Vishal Verma <vishal.l.verma@intel.com> writes: > 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. > > Link: https://github.com/pmem/ndctl/issues/52 > Reported-by: Jane Chu <jane.chu@oracle.com> > Cc: Dan Williams <dan.j.williams@intel.com> > Signed-off-by: Vishal Verma <vishal.l.verma@intel.com> > --- > Documentation/ndctl/namespace-description.txt | 6 ++++++ > 1 file changed, 6 insertions(+) > > diff --git a/Documentation/ndctl/namespace-description.txt b/Documentation/ndctl/namespace-description.txt > index 94999e5..5f294be 100644 > --- a/Documentation/ndctl/namespace-description.txt > +++ b/Documentation/ndctl/namespace-description.txt > @@ -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
diff --git a/Documentation/ndctl/namespace-description.txt b/Documentation/ndctl/namespace-description.txt index 94999e5..5f294be 100644 --- a/Documentation/ndctl/namespace-description.txt +++ b/Documentation/ndctl/namespace-description.txt @@ -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:
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. Link: https://github.com/pmem/ndctl/issues/52 Reported-by: Jane Chu <jane.chu@oracle.com> Cc: Dan Williams <dan.j.williams@intel.com> Signed-off-by: Vishal Verma <vishal.l.verma@intel.com> --- Documentation/ndctl/namespace-description.txt | 6 ++++++ 1 file changed, 6 insertions(+)