Document the 'daxctl list' command which emits the details of the Device-DAX regions and device instances in the system:
# daxctl list -DRi { "id":1, "devices":[ { "chardev":"dax1.0", "size":3233808384 } ] } Signed-off-by: Dan Williams <dan.j.willi...@intel.com> --- Documentation/Makefile.am | 3 +- Documentation/daxctl-list.txt | 78 +++++++++++++++++++++++++++++++++++++++++ 2 files changed, 80 insertions(+), 1 deletion(-) create mode 100644 Documentation/daxctl-list.txt diff --git a/Documentation/Makefile.am b/Documentation/Makefile.am index adcc9e7dde8e..6daeb5621af0 100644 --- a/Documentation/Makefile.am +++ b/Documentation/Makefile.am @@ -12,7 +12,8 @@ man1_MANS = \ ndctl-disable-namespace.1 \ ndctl-create-namespace.1 \ ndctl-destroy-namespace.1 \ - ndctl-list.1 + ndctl-list.1 \ + daxctl-list.1 CLEANFILES = $(man1_MANS) diff --git a/Documentation/daxctl-list.txt b/Documentation/daxctl-list.txt new file mode 100644 index 000000000000..168d410d12d8 --- /dev/null +++ b/Documentation/daxctl-list.txt @@ -0,0 +1,78 @@ +daxctl-list(1) +============= + +NAME +---- +daxctl-list - dump the platform Device-DAX regions, devices, and +attributes in json. + +SYNOPSIS +-------- +[verse] +'daxctl list' [<options>] + +Walk all the device-dax-regions in the system and list all device +instances along with some of their major attributes. + +Options can be specified to limit the output to objects of a certain +class. Where the classes are regions or devices. By default, 'daxctl +list' with no options is equivalent to: +[verse] +daxctl list --devices + +EXAMPLE +------- +[verse] +# daxctl list --regions --devices + +["literal"] +{ + "id":1, + "devices":[ + { + "chardev":"dax1.0", + "size":3233808384 + } + ] +} + +OPTIONS +------- +-r:: +--region=:: + A device-dax region is a contiguous range of memory that + hosts one or more /dev/daxX.Y devices, where X is the region id + and Y is the device instance id. The keyword 'all' can be + specified to carry out the operation on every region in the + system. + +-d:: +--dev=:: + Specify a dax device name, <region id>.<instance id> + tuple, or keyword 'all' to filter the listing. For + example to list the first device instance in region1: + +[verse] +# daxctl list --dev=1.0 + +["literal"] +{ + "chardev":"dax1.0", + "size":3233808384 +} + +-D:: +--devices:: + Include device-dax instance info in the listing (default) + +-R:: +--regions:: + Include region info in the listing + +-R:: +--regions:: + Include region info in the listing + +-i:: +--idle:: + Include idle (not enabled / zero-sized) devices in the listing _______________________________________________ Linux-nvdimm mailing list Linux-nvdimm@lists.01.org https://lists.01.org/mailman/listinfo/linux-nvdimm