From a951e6ddaec82dc0c33fb4e665e20f8fe4ce9caf Mon Sep 17 00:00:00 2001

From: Vishal Verma <vishal.l.verma@intel.com>

Date: Mon, 15 Aug 2022 13:22:05 -0600

Subject: [PATCH 190/217] 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.

Link: https://lore.kernel.org/r/20220815192214.545800-3-vishal.l.verma@intel.com

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>

---

 Documentation/cxl/cxl-disable-port.txt | 5 +----

 Documentation/cxl/cxl-enable-port.txt  | 5 +----

 Documentation/cxl/debug-option.txt     | 4 ++++

 Documentation/cxl/meson.build          | 1 +

 4 files changed, 7 insertions(+), 8 deletions(-)

 create mode 100644 Documentation/cxl/debug-option.txt

diff --git a/Documentation/cxl/cxl-disable-port.txt b/Documentation/cxl/cxl-disable-port.txt

index ac56f20..7a22efc 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 9a37cef..50b53d1 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 0000000..70b922f

--- /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 d019dfc..423be90 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 = [

-- 

2.27.0