This is the mail archive of the
gdb@sourceware.cygnus.com
mailing list for the GDB project.
Re: annotate.texi
- To: Andrew Cagney <ac131313 at cygnus dot com>
- Subject: Re: annotate.texi
- From: Eli Zaretskii <eliz at delorie dot com>
- Date: Thu, 9 Mar 2000 07:54:00 -0500 (EST)
- CC: gdb at sourceware dot cygnus dot com
- References: <38C74298.B562FDD1@cygnus.com><200003070832.DAA14451@indy.delorie.com>
- Reply-to: Eli Zaretskii <eliz at is dot elta dot co dot il>
> > Is there any reason why annotate.texi shouldn't be @include'd by
> > gdb.texinfo and be part of the manual? Right now, "set annotate" is
> > not documented at all, and annotate.texi seems to be just what the
> > doctor ordered...
>
> I just wonder if we want to encourage its use :-)
Any user who types "gdb --help" will see the --annotate switch
advertised, and will want to know what that does. Without
annotate.texi in the manual, this switch cannot be documented
properly. The same goes for the "set annotate" command. I think
undocumented features should be generally avoided.
Here's a case in point. I'm going through the test suite trying to
make sure the DJGPP version passes all the tests. When I bumped into
the test which tests annotations, I wanted to know what does that
command do. Naturally, I looked it up in gdb.info, and when that
failed in gdbint.info. You can guess what I found ;-).
In other words, undocumented features in the long run haunt
maintainers as well.
If we want to discourage use of --annotate, we can say that explicitly
in the manual.
Comments?