do not wrap resource agent longdesc

tomjelinek · tomjelinek · commit 4a422c8f8985 · 2025-09-09T13:13:49.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -17,6 +17,8 @@
 - Commands `pcs resource|booth delete|remove` and
   `pcs cluster node delete-remote|remove-remote` will now end with an error when
   trying to delete unmanaged started resources ([RHEL-76162])
+- Do not wrap resource and stonith agent description to preserve existing
+  formatting ([RHEL-111451])
 
 ### Deprecated
 - Using `--force` in `pcs resource|booth delete|remove` and
@@ -27,6 +29,7 @@
 
 [RHEL-76157]: https://issues.redhat.com/browse/RHEL-76157
 [RHEL-76162]: https://issues.redhat.com/browse/RHEL-76162
+[RHEL-111451]: https://issues.redhat.com/browse/RHEL-111451
 
 
 ## [0.12.1] - 2025-07-08
diff --git a/pcs/cli/resource/output.py b/pcs/cli/resource/output.py
@@ -19,6 +19,7 @@
     format_wrap_for_terminal,
     options_to_cmd,
     pairs_to_cmd,
+    smart_wrap_text,
 )
 from pcs.cli.nvset import nvset_dto_to_lines
 from pcs.cli.reports.output import warn
@@ -192,11 +193,17 @@ def resource_agent_metadata_to_text(
 
     if metadata.longdesc:
         output.append("")
-        output.extend(
-            format_wrap_for_terminal(
-                metadata.longdesc.replace("\n", " "), subsequent_indent=0
+        # Some agents provide longdesc as a single long line. Others provide
+        # formatted text with pagarpahs, indentation, lists, etc. Wrap only
+        # one-line longdesc to preserve such formatting. Agent authors are
+        # expected to wrap formatted longdesc appropriately. We cannot fix just
+        # some wrapping while keeping other formatting in place.
+        if "\n" in metadata.longdesc:
+            output.extend(metadata.longdesc.splitlines())
+        else:
+            output.extend(
+                format_wrap_for_terminal(metadata.longdesc, subsequent_indent=0)
             )
-        )
 
     params = []
     for param in metadata.parameters:
@@ -210,7 +217,7 @@ def resource_agent_metadata_to_text(
             output.append("Stonith options:")
         else:
             output.append("Resource options:")
-        output.extend(indent(params, indent_step=INDENT_STEP))
+        output.extend(smart_wrap_text(indent(params, indent_step=INDENT_STEP)))
 
     operations = []
     for operation in default_operations:
@@ -219,7 +226,9 @@ def resource_agent_metadata_to_text(
     if operations:
         output.append("")
         output.append("Default operations:")
-        output.extend(indent(operations, indent_step=INDENT_STEP))
+        output.extend(
+            smart_wrap_text(indent(operations, indent_step=INDENT_STEP))
+        )
 
     return output
 
diff --git a/pcs/resource.py b/pcs/resource.py
@@ -12,7 +12,6 @@
 from pcs import constraint, utils
 from pcs.cli.cluster_property.output import PropertyConfigurationFacade
 from pcs.cli.common.errors import CmdLineInputError
-from pcs.cli.common.output import smart_wrap_text
 from pcs.cli.common.parse_args import (
     FUTURE_OPTION,
     OUTPUT_FORMAT_VALUE_CMD,
@@ -547,14 +546,12 @@ def resource_list_options(
         )
     print(
         "\n".join(
-            smart_wrap_text(
-                resource_agent_metadata_to_text(
-                    lib.resource_agent.get_agent_metadata(agent_name),
-                    lib.resource_agent.get_agent_default_operations(
-                        agent_name
-                    ).operations,
-                    verbose=modifiers.is_specified("--full"),
-                )
+            resource_agent_metadata_to_text(
+                lib.resource_agent.get_agent_metadata(agent_name),
+                lib.resource_agent.get_agent_default_operations(
+                    agent_name
+                ).operations,
+                verbose=modifiers.is_specified("--full"),
             )
         )
     )
diff --git a/pcs/stonith.py b/pcs/stonith.py
@@ -10,7 +10,6 @@
 )
 from pcs.cli.common import parse_args
 from pcs.cli.common.errors import CmdLineInputError
-from pcs.cli.common.output import smart_wrap_text
 from pcs.cli.common.parse_args import (
     Argv,
     InputModifiers,
@@ -108,14 +107,12 @@ def stonith_list_options(
     agent_name = ResourceAgentNameDto("stonith", None, argv[0])
     print(
         "\n".join(
-            smart_wrap_text(
-                resource_agent_metadata_to_text(
-                    lib.resource_agent.get_agent_metadata(agent_name),
-                    lib.resource_agent.get_agent_default_operations(
-                        agent_name
-                    ).operations,
-                    verbose=modifiers.is_specified("--full"),
-                )
+            resource_agent_metadata_to_text(
+                lib.resource_agent.get_agent_metadata(agent_name),
+                lib.resource_agent.get_agent_default_operations(
+                    agent_name
+                ).operations,
+                verbose=modifiers.is_specified("--full"),
             )
         )
     )
