Skip to contentSkip to conversation

Documentation: cxl,daxctl,ndctl add --list-cmds info

PATCH In review Rong Tao 2 participants 3 messages Jun 30, 2025 – Jul 1, 2025

Subsystems (2)
lore
Share & tools
lore

Rong Tao

author
#0 lore raw

PATCH 1/1 Documentation: cxl,daxctl,ndctl add --list-cmds info

From: Rong Tao <[email protected]>

Such as daxctl(1) manual.

---
 Documentation/cxl/cxl.txt       | 3 +++
 Documentation/daxctl/daxctl.txt | 3 +++
 Documentation/ndctl/ndctl.txt   | 3 +++
 3 files changed, 9 insertions(+)
Documentation/cxl/cxl.txt +3 -0
index 41a51c7d3892..546207d885eb 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
 OPTIONS
 -------
+--list-cmds::
+  Display all available commands.
+
 -v::
 --version::
   Display the version of the 'cxl' utility.
Documentation/daxctl/daxctl.txt +3 -0
index f81b161c9771..606abc3e9635 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
 OPTIONS
 -------
+--list-cmds::
+  Display all available commands.
+
 -v::
 --version::
   Display daxctl version.
Documentation/ndctl/ndctl.txt +3 -0
index c2919de4692d..08c3e949418a 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
 OPTIONS
 -------
+--list-cmds::
+  Display all available commands.
+
 -v::
 --version::
   Display ndctl version.
Signature · 1 line
2.50.0
maintainer
#1 lore raw
Quoted 3 lines · Rong Tao

From: Rong Tao <[email protected]>

Such as daxctl(1) manual.

What does the 'Such as ...' mean? I thought that it meant you saw the --list-cmds as an option in another of our family of commands, but I don't see it.

For these, the --list-cmds, is a suggestion in the --help option, like this:

$ ndctl -h

usage: ndctl [--version] [--help] COMMAND [ARGS]

See 'ndctl help COMMAND' for more information on a specific command. ndctl --list-cmds to see all available commands

Quoted 54 lines
---
 Documentation/cxl/cxl.txt       | 3 +++
 Documentation/daxctl/daxctl.txt | 3 +++
 Documentation/ndctl/ndctl.txt   | 3 +++
 3 files changed, 9 insertions(+)
Documentation/cxl/cxl.txt +3 -0
index 41a51c7d3892..546207d885eb 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
 OPTIONS
 -------
+--list-cmds::
+  Display all available commands.
+
 -v::
 --version::
   Display the version of the 'cxl' utility.
Documentation/daxctl/daxctl.txt +3 -0
index f81b161c9771..606abc3e9635 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
 OPTIONS
 -------
+--list-cmds::
+  Display all available commands.
+
 -v::
 --version::
   Display daxctl version.
Documentation/ndctl/ndctl.txt +3 -0
index c2919de4692d..08c3e949418a 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
 OPTIONS
 -------
+--list-cmds::
+  Display all available commands.
+
 -v::
 --version::
   Display ndctl version.
Signature · 1 line
2.50.0
author
#2 lore raw
Quoted 7 lines · Alison Schofield
Quoted 3 lines · Rong Tao

From: Rong Tao <[email protected]>

Such as daxctl(1) manual.

What does the 'Such as ...' mean? I thought that it meant you saw the --list-cmds as an option in another of our family of commands, but I don't see it.

Thanks for your reply, There are three commands has --list-cmds argument:

$ cxl --list-cmds
$ daxctl --list-cmds
$ ndctl --list-cmds

Thus, this patch add --list-cmds in man-page for those three tools.

Quoted 66 lines

For these, the --list-cmds, is a suggestion in the --help option, like this:

$ ndctl -h

usage: ndctl [--version] [--help] COMMAND [ARGS]

See 'ndctl help COMMAND' for more information on a specific command. ndctl --list-cmds to see all available commands

Quoted 53 lines
---
  Documentation/cxl/cxl.txt       | 3 +++
  Documentation/daxctl/daxctl.txt | 3 +++
  Documentation/ndctl/ndctl.txt   | 3 +++
  3 files changed, 9 insertions(+)
Documentation/cxl/cxl.txt +3 -0
index 41a51c7d3892..546207d885eb 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
  OPTIONS
  -------
+--list-cmds::
+  Display all available commands.
+
  -v::
  --version::
    Display the version of the 'cxl' utility.
Documentation/daxctl/daxctl.txt +3 -0
index f81b161c9771..606abc3e9635 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
  OPTIONS
  -------
+--list-cmds::
+  Display all available commands.
+
  -v::
  --version::
    Display daxctl version.
Documentation/ndctl/ndctl.txt +3 -0
index c2919de4692d..08c3e949418a 100644
@@ -14,6 +14,9 @@ SYNOPSIS
 
  OPTIONS
  -------
+--list-cmds::
+  Display all available commands.
+
  -v::
  --version::
    Display ndctl version.
Signature · 1 line
2.50.0