aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorVishal Verma <vishal.l.verma@intel.com>2022-06-01 17:22:31 -0600
committerVishal Verma <vishal.l.verma@intel.com>2022-08-11 16:58:41 -0600
commit9c46b56afb59079e2d936bf4739ab0f80c60b746 (patch)
treea249d9af3dc4c92d38d62fd7182119c15724e8df
parent6fa7cd857544038f4896ae6847c7be2ce84a897f (diff)
cxl/port: Consolidate the debug option in cxl-port man pages
In preparation for additional commands that implement the --debug option, consolidate the option description from the cxl-port man pages into an include. The port man pages also mentioned the debug option requiring a build with debug enabled, which wasn't true - so remove that part. Cc: Dan Williams <dan.j.williams@intel.com> Reviewed-by: Dan Williams <dan.j.williams@intel.com> Signed-off-by: Vishal Verma <vishal.l.verma@intel.com>
-rw-r--r--Documentation/cxl/cxl-disable-port.txt5
-rw-r--r--Documentation/cxl/cxl-enable-port.txt5
-rw-r--r--Documentation/cxl/debug-option.txt4
-rw-r--r--Documentation/cxl/meson.build1
4 files changed, 7 insertions, 8 deletions
diff --git a/Documentation/cxl/cxl-disable-port.txt b/Documentation/cxl/cxl-disable-port.txt
index ac56f20e..7a22efc3 100644
--- a/Documentation/cxl/cxl-disable-port.txt
+++ b/Documentation/cxl/cxl-disable-port.txt
@@ -30,10 +30,7 @@ OPTIONS
firmware and disabling an active device is akin to force removing memory
from a running system.
---debug::
- If the cxl tool was built with debug disabled, turn on debug
- messages.
-
+include::debug-option.txt[]
include::../copyright.txt[]
diff --git a/Documentation/cxl/cxl-enable-port.txt b/Documentation/cxl/cxl-enable-port.txt
index 9a37cef0..50b53d1f 100644
--- a/Documentation/cxl/cxl-enable-port.txt
+++ b/Documentation/cxl/cxl-enable-port.txt
@@ -31,10 +31,7 @@ OPTIONS
memdev is only enabled after all CXL ports in its device topology
ancestry are enabled.
---debug::
- If the cxl tool was built with debug enabled, turn on debug
- messages.
-
+include::debug-option.txt[]
include::../copyright.txt[]
diff --git a/Documentation/cxl/debug-option.txt b/Documentation/cxl/debug-option.txt
new file mode 100644
index 00000000..70b922fc
--- /dev/null
+++ b/Documentation/cxl/debug-option.txt
@@ -0,0 +1,4 @@
+// SPDX-License-Identifier: GPL-2.0
+
+--debug::
+ Turn on additional debug messages including library debug.
diff --git a/Documentation/cxl/meson.build b/Documentation/cxl/meson.build
index d019dfc2..423be905 100644
--- a/Documentation/cxl/meson.build
+++ b/Documentation/cxl/meson.build
@@ -22,6 +22,7 @@ filedeps = [
'../copyright.txt',
'memdev-option.txt',
'labels-options.txt',
+ 'debug-option.txt',
]
cxl_manpages = [