Re: [RFA] Improve help set/unset/show substitute-path

Joel Brobecker
2007-01-13T14:02:43Z

[-- Attachment #1: Type: text/plain, Size: 327 bytes --]

Thanks for the feedback, Eli. With your help, I think this second version
is a huge improvement.

2007-01-13 Joel Brobecker <brobecker@adacore.com>

* source.c (_initialize_source): Improve the help text of
the substitute-path commands.

Tested on x86-linux, no regression.
OK to commit?

Thank you,
--
Joel

[-- Attachment #2: help.diff --]
[-- Type: text/plain, Size: 1616 bytes --]

Index: source.c
===================================================================
RCS file: /cvs/src/src/gdb/source.c,v
retrieving revision 1.77
diff -u -p -r1.77 source.c
--- source.c 9 Jan 2007 17:58:58 -0000 1.77
+++ source.c 13 Jan 2007 14:00:42 -0000
@@ -1997,16 +1997,24 @@ Show number of source lines gdb will lis

add_cmd ("substitute-path", class_files, set_substitute_path_command,
_("\
-Add a source path substitution rule. If a substitution rule was previously\n\
-set, it is overridden."), &setlist);
+Usage: set substitute-path FROM TO\n\
+Add a substitution rule replacing FROM into TO in source file names.\n\
+If a substitution rule was previously set for FROM, the old rule\n\
+is replaced by the new one."),
+ &setlist);

add_cmd ("substitute-path", class_files, unset_substitute_path_command,
_("\
-Remove the current source path substitution rule. This has no effect\n\
-if no path substitution rule was previously specified."),
+Usage: unset substitute-path [FROM]\n\
+Delete the rule for substituting FROM in source file names. If FROM\n\
+is not specified, all substituting rules are deleted.\n\
+If the debugger cannot find a rule for FROM, it will display a warning."),
&unsetlist);

add_cmd ("substitute-path", class_files, show_substitute_path_command,
- _("Show the current source path substitution rule."),
+ _("\
+Usage: show substitute-path [FROM]\n\
+Print the rule for substituting FROM in source file names. If FROM\n\
+is not specified, print all substitution rules."),
&showlist);
}