[RFA v2 2/2] Update usage text for load, symbol-file

Tom Tromey tom@tromey.com
Sat Nov 25 20:35:00 GMT 2017


This updates the usage text for the load and symbol-file commands.

ChangeLog
2017-11-25  Tom Tromey  <tom@tromey.com>

	* symfile.c (_initialize_symfile): Update usage text for
	symbol-file, load.
---
 gdb/ChangeLog |  5 +++++
 gdb/symfile.c | 15 +++++++++++----
 2 files changed, 16 insertions(+), 4 deletions(-)

diff --git a/gdb/symfile.c b/gdb/symfile.c
index c19cdd20eb..4bbe0b5a62 100644
--- a/gdb/symfile.c
+++ b/gdb/symfile.c
@@ -3878,10 +3878,16 @@ _initialize_symfile (void)
 
   observer_attach_free_objfile (symfile_free_objfile);
 
+#define READNOW_HELP \
+  "The '-readnow' option will cause GDB to read the entire symbol file\n\
+immediately.  This makes the command slower, but may make future operations\n\
+faster."
+
   c = add_cmd ("symbol-file", class_files, symbol_file_command, _("\
 Load symbol table from executable file FILE.\n\
+Usage: symbol-file [-readnow] FILE\n\
 The `file' command can also load symbol tables, as well as setting the file\n\
-to execute."), &cmdlist);
+to execute.\n" READNOW_HELP), &cmdlist);
   set_cmd_completer (c, filename_completer);
 
   c = add_cmd ("add-symbol-file", class_files, add_symbol_file_command, _("\
@@ -3890,7 +3896,8 @@ Usage: add-symbol-file FILE ADDR [-readnow | -s SECT-NAME SECT-ADDR]...\n\
 ADDR is the starting address of the file's text.\n\
 Each '-s' argument provides a section name and address, and\n\
 should be specified if the data and bss segments are not contiguous\n\
-with the text.  SECT-NAME is a section name to be loaded at SECT-ADDR."),
+with the text.  SECT-NAME is a section name to be loaded at SECT-ADDR.\n"
+READNOW_HELP),
 	       &cmdlist);
   set_cmd_completer (c, filename_completer);
 
@@ -3906,10 +3913,10 @@ that lies within the boundaries of this symbol file in memory."),
   c = add_cmd ("load", class_files, load_command, _("\
 Dynamically load FILE into the running program, and record its symbols\n\
 for access from GDB.\n\
+Usage: load [FILE] [OFFSET]\n\
 An optional load OFFSET may also be given as a literal address.\n\
 When OFFSET is provided, FILE must also be provided.  FILE can be provided\n\
-on its own.\n\
-Usage: load [FILE] [OFFSET]"), &cmdlist);
+on its own."), &cmdlist);
   set_cmd_completer (c, filename_completer);
 
   add_prefix_cmd ("overlay", class_support, overlay_command,
-- 
2.13.6



More information about the Gdb-patches mailing list