[lldb] improve the help strings for gdb-remote and kdp-remote

[lawrence_danna]

Summary

The help string can be more helpful by explaining these are
aliases for 'process connect'

[lawrence_danna]

clang-format

[DavidSpickett]

I've seen commands print that they are an alias automatically:

(lldb) help rbreak
Sets a breakpoint or set of breakpoints in the executable.

Syntax: rbreak <cmd-options>

<...>

'rbreak' is an abbreviation for 'breakpoint set -r %1'

Is this not the case for regex commands? Showing the user a cryptic regex isn't going to help them that much anyway, so nothing against doing this change.

[jingham]

In D111965#3069568, @DavidSpickett wrote:

I've seen commands print that they are an alias automatically:

(lldb) help rbreak
Sets a breakpoint or set of breakpoints in the executable.

Syntax: rbreak <cmd-options>

<...>

'rbreak' is an abbreviation for 'breakpoint set -r %1'

Is this not the case for regex commands? Showing the user a cryptic regex isn't going to help them that much anyway, so nothing against doing this change.

A regex command is not necessarily an alias for anything. You can have a regex command that calls different lldb commands depending on the regex. So there's no way for a regex command to automatically show anything but the regex's. So if you want to provide useful help for regex commands, you kind of have to provide a hand-written help.

[JDevlieghere]

LGTM

lldb/source/Interpreter/CommandInterpreter.cpp

if (undisplay_regex_cmd_up->AddRegexCommand("^([0-9]+)$",
       m_command_dict[std::string(undisplay_regex_cmd_sp->GetCommandName())] =
           undisplay_regex_cmd_sp;
     }
   }
 
   std::unique_ptr<CommandObjectRegexCommand> connect_gdb_remote_cmd_up(
       new CommandObjectRegexCommand(
           *this, "gdb-remote",
-          "Connect to a process via remote GDB server.  "
-          "If no host is specifed, localhost is assumed.",
+          "Connect to a process via remote GDB server.\n"
+          "If no host is specifed, localhost is assumed.\n"
+          "gdb-remote is an abbreviation for 'process connect --plugin "
+          "gdb-remote connect://<hostname>:<port>'\n",
           "gdb-remote [<hostname>:]<portnum>", 2, 0, false));
   if (connect_gdb_remote_cmd_up) {
     if (connect_gdb_remote_cmd_up->AddRegexCommand(
             "^([^:]+|\\[[0-9a-fA-F:]+.*\\]):([0-9]+)$",
             "process connect --plugin gdb-remote connect://%1:%2") &&
         connect_gdb_remote_cmd_up->AddRegexCommand(
             "^([[:digit:]]+)$",
             "process connect --plugin gdb-remote connect://localhost:%1")) {
       CommandObjectSP command_sp(connect_gdb_remote_cmd_up.release());
       m_command_dict[std::string(command_sp->GetCommandName())] = command_sp;
     }
   }
 
   std::unique_ptr<CommandObjectRegexCommand> connect_kdp_remote_cmd_up(
       new CommandObjectRegexCommand(
           *this, "kdp-remote",
-          "Connect to a process via remote KDP server.  "
-          "If no UDP port is specified, port 41139 is "
-          "assumed.",
+          "Connect to a process via remote KDP server.\n"
+          "If no UDP port is specified, port 41139 is assumed.\n"
+          "kdp-remote is an abbreviation for 'process connect --plugin "
+          "kdp-remote udp://<hostname>:<port>'\n",
           "kdp-remote <hostname>[:<portnum>]", 2, 0, false));
   if (connect_kdp_remote_cmd_up) {
     if (connect_kdp_remote_cmd_up->AddRegexCommand(
             "^([^:]+:[[:digit:]]+)$",
             "process connect --plugin kdp-remote udp://%1") &&
         connect_kdp_remote_cmd_up->AddRegexCommand(
             "^(.+)$", "process connect --plugin kdp-remote udp://%1:41139")) {
       CommandObjectSP command_sp(connect_kdp_remote_cmd_up.release());