Re: RFA: add_setshow_cmd_full

Tom Tromey
2002-06-26T18:23:41Z

>>>>> "Eli" == Eli Zaretskii <eliz@is.elta.co.il> writes:

Eli> Sounds good, but could you please add this function to
Eli> gdbint.texinfo?

Assuming Andrew approves my most recent patch in this area, what do
you think of the appended documentation patch? I didn't list the
arguments as the other entries don't seem to, and anyway they are
documented in the source.

In Java it is standard to extract special comments in the source and
use those to construct API documentation. I know a long time ago gdb
did this, but it was abandoned. Anyway, wouldn't it be simpler to
keep the docs up to date with something like this in place?

Tom

Index: ChangeLog
from Tom Tromey <tromey@redhat.com>

* gdbint.texinfo (User Interface): Mention add_setshow_cmd and
add_setshow_cmd_full.

Index: gdbint.texinfo
===================================================================
RCS file: /cvs/src/src/gdb/doc/gdbint.texinfo,v
retrieving revision 1.91
diff -u -r1.91 gdbint.texinfo
--- gdbint.texinfo 9 Jun 2002 17:15:40 -0000 1.91
+++ gdbint.texinfo 26 Jun 2002 18:13:36 -0000
@@ -50,7 +50,7 @@
@end tex

@vskip 0pt plus 1filll
-Copyright @copyright{} 1990,1991,1992,1993,1994,1996,1998,1999,2000,2001
+Copyright @copyright{} 1990,1991,1992,1993,1994,1996,1998,1999,2000,2001, 2002
Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document
@@ -721,6 +721,14 @@
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.
+
+@findex add_setshow_cmd
+@findex add_setshow_cmd_full
+To add paired @samp{set} and @samp{show} commands, use
+@code{add_setshow_cmd} or @code{add_setshow_cmd_full}. The former is
+a slightly simpler interface which is useful when you don't need to
+further modify the new command structures, while the latter returns
+the new command structures for manipulation.

@cindex deprecating commands
@findex deprecate_cmd