gdb/thread: fine-tune 'info threads' help text
authorTankut Baris Aktemur <tankut.baris.aktemur@intel.com>
Mon, 19 Oct 2020 15:23:26 +0000 (17:23 +0200)
committerTankut Baris Aktemur <tankut.baris.aktemur@intel.com>
Mon, 19 Oct 2020 16:01:36 +0000 (18:01 +0200)
The help text of 'info threads' is below:

  (gdb) help info threads
  Display currently known threads.
  Usage: info threads [OPTION]... [ID]...

  Options:
    -gid
      Show global thread IDs.If ID is given, it is a space-separated list of IDs of threads to display.
  Otherwise, all threads are displayed.
  (gdb)

I think the "If ID is given ..." info should have come right below
the the usage line.  This patch reorganizes the text so that we get

  (gdb) help info threads
  Display currently known threads.
  Usage: info threads [OPTION]... [ID]...
  If ID is given, it is a space-separated list of IDs of threads to display.
  Otherwise, all threads are displayed.

  Options:
    -gid
      Show global thread IDs.
  (gdb)

gdb/ChangeLog:
2020-10-19  Tankut Baris Aktemur  <tankut.baris.aktemur@intel.com>

* thread.c (_initialize_thread): Fine-tune the help text of
'info threads'.

gdb/ChangeLog
gdb/thread.c

index 5bfe185e0ec1f94ce9118cd2982e0a1fcd7d27c8..428ced4d35cc57e8d9388976bbe6e9a7d752462e 100644 (file)
@@ -1,3 +1,8 @@
+2020-10-19  Tankut Baris Aktemur  <tankut.baris.aktemur@intel.com>
+
+       * thread.c (_initialize_thread): Fine-tune the help text of
+       'info threads'.
+
 2020-10-19  Tankut Baris Aktemur  <tankut.baris.aktemur@intel.com>
 
        * frame.c: Remove the unused 'uinteger_option_def' type alias.
index d499400544929e9158adf89868af7a3831344e45..d83244383d3074820fe4f2d5d844f13c92ca2a20 100644 (file)
@@ -2183,11 +2183,11 @@ _initialize_thread ()
     = gdb::option::build_help (_("\
 Display currently known threads.\n\
 Usage: info threads [OPTION]... [ID]...\n\
+If ID is given, it is a space-separated list of IDs of threads to display.\n\
+Otherwise, all threads are displayed.\n\
 \n\
 Options:\n\
-%OPTIONS%\
-If ID is given, it is a space-separated list of IDs of threads to display.\n\
-Otherwise, all threads are displayed."),
+%OPTIONS%"),
                               info_threads_opts);
 
   c = add_info ("threads", info_threads_command, info_threads_help.c_str ());