[lldb] [cosmetic] Update help message of (lldb) b

[royitaqi]

(lldb) b can be used in two different ways:

1. Running b without arguments, it lists all existing breakpoints.
2. Running b with arguments, it adds breakpoints.

However, the help message doesn't mention the first use case. This patch adds help message to mention it.

Without patch:

(lldb) help b
Set a breakpoint using one of several shorthand formats.  Expects 'raw' input (see 'help raw-input'.)

Syntax:
_regexp-break <filename>:<linenum>:<colnum>
              main.c:12:21          // Break at line 12 and column 21 of main.c
...

With patch:

(lldb) help b
Set a breakpoint using one of several shorthand formats, or list the
existing breakpoints if no arguments are provided.  Expects 'raw' input
(see 'help raw-input'.)

Syntax:
_regexp-break <filename>:<linenum>:<colnum>
              main.c:12:21          // Break at line 12 and column 21 of main.c
...
_regexp-break
                                    // List the existing breakpoints

[llvmbot]

@llvm/pr-subscribers-lldb

Author: None (royitaqi)

Changes

(lldb) b can be used in two different ways:

1. Running b without arguments, it lists all existing breakpoints.
2. Running b with additional arguments, it adds breakpoints.

However, the help message doesn't mention the first use case. This patch adds help message to mention it by adding "List all breakpoints, or ...".

Without patch:

(lldb) help b
Set a breakpoint using one of several shorthand formats.  Expects 'raw' input (see 'help raw-input'.)

Syntax:
_regexp-break <filename>:<linenum>:<colnum>
              main.c:12:21          // Break at line 12 and column 21 of main.c
...


(lldb) apropos breakpoint
  b                         -- Set a breakpoint using one of several shorthand formats.

With patch:

(lldb) help b
List all breakpoints, or set a breakpoint using one of several shorthand formats.  Expects 'raw' input (see 'help raw-input'.)

Syntax:
_regexp-break <filename>:<linenum>:<colnum>
              main.c:12:21          // Break at line 12 and column 21 of main.c
...


(lldb) apropos breakpoint
  b                         -- List all breakpoints, or set a breakpoint using one of several shorthand formats.

---

Full diff: https://github.com/llvm/llvm-project/pull/149114.diff

1 Files Affected:

• (modified) lldb/source/Interpreter/CommandInterpreter.cpp (+2-1)

diff --git a/lldb/source/Interpreter/CommandInterpreter.cpp b/lldb/source/Interpreter/CommandInterpreter.cpp
index 00c3472444d2e..2d8ab7bf3bbf4 100644
--- a/lldb/source/Interpreter/CommandInterpreter.cpp
+++ b/lldb/source/Interpreter/CommandInterpreter.cpp
@@ -616,7 +616,8 @@ void CommandInterpreter::LoadCommandDictionary() {
   std::unique_ptr<CommandObjectRegexCommand> break_regex_cmd_up(
       new CommandObjectRegexCommand(
           *this, "_regexp-break",
-          "Set a breakpoint using one of several shorthand formats.",
+          "List all breakpoints, or set a breakpoint using one of several "
+          "shorthand formats.",
           "\n"
           "_regexp-break <filename>:<linenum>:<colnum>\n"
           "              main.c:12:21          // Break at line 12 and column "

[dmpots]

LGTM with one suggestion.

[JDevlieghere]

[begin bikeshedding]
How about something like this:

Set a breakpoint using one of several shorthand formats, or list the existing breakpoints if no arguments are provided. Expects 'raw' input (see 'help raw-input'.)

My reasoning is that it describes the more common use case first while also telling you how to get the behavior for listing breakpoints.

[end bikeshedding]

[royitaqi]

Folks, how about now? (see PR description for latest visualization)
cc @JDevlieghere, @dmpots, @clayborg.

--

FWIW, @JDevlieghere: That wasn't bikeshedding at all. The order is important because it decides what gets delivered to the user/reader. Thanks for the great suggestion.

[JDevlieghere]

LGTM!