binutils-gdb/gdb/python
Andrew Burgess 2f6b20e2e0 gdb: fix formatting for help set/show extended-prompt
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.
2022-02-02 16:33:05 +00:00
..
lib/gdb gdb: fix formatting for help set/show extended-prompt 2022-02-02 16:33:05 +00:00
py-all-events.def Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-arch.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-auto-load.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-block.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-bpevent.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-breakpoint.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-cmd.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-connection.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-continueevent.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-event-types.def Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-event.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-event.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-events.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-evtregistry.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-evts.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-exitedevent.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-finishbreakpoint.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-frame.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-framefilter.c Convert wrap_here to use integer parameter 2022-01-26 15:19:13 -07:00
py-function.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-gdb-readline.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-inferior.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-infevents.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-infthread.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-instruction.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-instruction.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-lazy-string.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-linetable.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-membuf.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-newobjfileevent.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-objfile.c gdb/python: fix gdb.Objfile.__repr__ () for dynamically compiled code 2022-02-01 14:49:30 +00:00
py-param.c gdb/python: improve the auto help text for gdb.Parameter 2022-01-26 22:00:20 +00:00
py-prettyprint.c Always call the wrap_here method 2022-01-26 15:19:13 -07:00
py-progspace.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-record-btrace.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-record-btrace.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-record-full.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-record-full.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-record.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-record.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-ref.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-registers.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-signalevent.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-stopevent.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-stopevent.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-symbol.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-symtab.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-threadevent.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-tui.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-type.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-unwind.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-utils.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
py-value.c gdb/python: add gdb.history_count function 2022-01-26 21:58:12 +00:00
py-varobj.c Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00
py-xmethods.c Change how Python architecture and language are handled 2022-01-26 06:49:51 -07:00
python-config.py gdb: re-format Python files using black 21.4b0 2021-05-07 10:56:20 -04:00
python-internal.h gdb/python: add gdb.history_count function 2022-01-26 21:58:12 +00:00
python.c gdb/python: handle non utf-8 characters when source highlighting 2022-01-26 23:12:52 +00:00
python.h Automatic Copyright Year update after running gdb/copyright.py 2022-01-01 19:13:23 +04:00