This is the mail archive of the gdb-patches@sources.redhat.com mailing list for the GDB project.


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]
Other format: [Raw text]

Re: [rfa:doco] Doco problems with level two annotations


> Date: Fri, 16 May 2003 20:18:44 -0400
> From: Andrew Cagney <ac131313@redhat.com>
> 
> The attached updates the gdb/doc/annotate.texi file (renaming it to
> annotate.texinfo) so that it is a standalone document that:
> 
> - notes the limitations of level two annotations
> - points the user at gdb/mi
> - mentions the mi features that have replaced level two annotation
> functionality

I have several comments about this.

Is it really useful to have this as a separate manual?  Why not move
the text into an appendix instead?  It would simplify the change, for
starters.  You didn't show the Makefile.in patch, but it would become
unnecessary.  The changes of @section to @chapter would also become
unnecessary.  Finally, when we eventually remove level-2 annotations
entirely, you won't need to modify any configury, just delete the
appendix and all references to it.

> +Permission is granted to copy, distribute and/or modify this document
> +under the terms of the GNU Free Documentation License, Version 1.1 or
> +any later version published by the Free Software Foundation; with the
> +Invariant Sections being ``Free Software'' and ``Free Software Needs
> +Free Documentation'', with the Front-Cover Texts being ``A GNU Manual,''
> +and with the Back-Cover Texts as in (a) below.

This text seems to be wrong, since there are no sections named ``Free
Software'' and ``Free Software Needs Free Documentation'' in
annotate.texi.  Did I miss something?

> +In a graphical environment, where many values can be displayed
> +simultaneously, a serious performance problem occures when the client
                                                 ^^^^^^^
This should be "occurs".


Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]