[PATCH] gdb: fix formatting for help set/show extended-prompt

[PATCH] gdb: fix formatting for help set/show extended-prompt

[Andrew Burgess]

The formatting of the help text for 'help set extended-prompt' and
'help show extended-prompt' is a little off.

Here's the offending snippet:

    Substitutions are applied to VALUE to compute the real prompt.

    The currently defined substitutions are:
      \[	Begins a sequence of non-printing characters.
  \\	A backslash.
  \]	Ends a sequence of non-printing characters.
  \e	The ESC character.

Notice that the line for '\[' is indented more that the others.

Turns out this is due to how we build this help text, something which
is done in Python.  We extended a classes __doc__ string with some
dynamically generated text.

The classes doc string looks like this:

    """Set the extended prompt.

    Usage: set extended-prompt VALUE

    Substitutions are applied to VALUE to compute the real prompt.

    The currently defined substitutions are:
    """

Notice the closing """ are in a line of their own, and include some
white space just before.  It's this extra white space that's causing
the problem.

Fix the formatting issue by moving the """ to the end of the previous
line.  I then add the extra newline in at the point where the doc
string is merged with the dynamically generated text.

Now everything lines up correctly.
---
 gdb/python/lib/gdb/command/prompt.py | 5 ++---
 1 file changed, 2 insertions(+), 3 deletions(-)

diff --git a/gdb/python/lib/gdb/command/prompt.py b/gdb/python/lib/gdb/command/prompt.py
index 1491c6a3e65..8dfa8ed91ef 100644
--- a/gdb/python/lib/gdb/command/prompt.py
+++ b/gdb/python/lib/gdb/command/prompt.py
@@ -28,12 +28,11 @@ class _ExtendedPrompt(gdb.Parameter):
 
     Substitutions are applied to VALUE to compute the real prompt.
 
-    The currently defined substitutions are:
-    """
+    The currently defined substitutions are:"""
 
     # Add the prompt library's dynamically generated help to the
     # __doc__ string.
-    __doc__ = __doc__ + gdb.prompt.prompt_help()
+    __doc__ = __doc__ + "\n" + gdb.prompt.prompt_help()
 
     set_doc = "Set the extended prompt."
     show_doc = "Show the extended prompt."
-- 
2.25.4

Re: [PATCH] gdb: fix formatting for help set/show extended-prompt

[Tom Tromey]

>>>>> "Andrew" == Andrew Burgess via Gdb-patches <gdb-patches@sourceware.org> writes:

Andrew> Fix the formatting issue by moving the """ to the end of the previous
Andrew> line.  I then add the extra newline in at the point where the doc
Andrew> string is merged with the dynamically generated text.

Looks good, thank you.

Tom