aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFernando Nasser <fnasser@redhat.com>2000-03-23 23:50:51 +0000
committerFernando Nasser <fnasser@redhat.com>2000-03-23 23:50:51 +0000
commitcfeada605e69656df0aebec270630805d0c83e8e (patch)
treee867e1ad657b4f7a8335afbbddf70b124a4ea443
parent003ba2901f8c7c58d5d7b9059ed91b331466c532 (diff)
downloadgdb-cfeada605e69656df0aebec270630805d0c83e8e.zip
gdb-cfeada605e69656df0aebec270630805d0c83e8e.tar.gz
gdb-cfeada605e69656df0aebec270630805d0c83e8e.tar.bz2
2000-03-23 Fernando Nasser <fnasser@totem.to.cygnus.com>
From David Whedon <dwhedon@gordian.com> * gdbint.texinfo : Added paragraphs about command deprecation.
-rw-r--r--gdb/doc/ChangeLog5
-rw-r--r--gdb/doc/gdbint.texinfo16
2 files changed, 19 insertions, 2 deletions
diff --git a/gdb/doc/ChangeLog b/gdb/doc/ChangeLog
index 48efadf..b3043d1 100644
--- a/gdb/doc/ChangeLog
+++ b/gdb/doc/ChangeLog
@@ -1,3 +1,8 @@
+2000-03-23 Fernando Nasser <fnasser@totem.to.cygnus.com>
+
+ From David Whedon <dwhedon@gordian.com>
+ * gdbint.texinfo : Added paragraphs about command deprecation.
+
2000-03-22 Daniel Berlin <dan@cgsoftware.com>
* gdb.texinfo: Add documentation for the apropos command.
diff --git a/gdb/doc/gdbint.texinfo b/gdb/doc/gdbint.texinfo
index 15dc2aa..b104060 100644
--- a/gdb/doc/gdbint.texinfo
+++ b/gdb/doc/gdbint.texinfo
@@ -332,8 +332,20 @@ to the @code{set_thread_cmd_list}.
To add commands in general, use @code{add_cmd}. @code{add_com} adds to
the main command list, and should be used for those commands. The usual
-place to add commands is in the @code{_initialize_@var{xyz}} routines at the
-ends of most source files.
+place to add commands is in the @code{_initialize_@var{xyz}} routines at
+the ends of most source files.
+
+Before removing commands from the command set it is a good idea to
+deprecate them for some time. Use @code{deprecate_cmd} on commands or
+aliases to set the deprecated flag. @code{deprecate_cmd} takes a
+@code{struct cmd_list_element} as it's first argument. You can use the
+return value from @code{add_com} or @code{add_cmd} to deprecate the
+command immediately after it is created.
+
+The first time a comamnd is used the user will be warned and offered a
+replacement (if one exists). Note that the replacement string passed to
+@code{deprecate_cmd} should be the full name of the command, i.e. the
+entire string the user should type at the command line.
@section Console Printing