[RFA/DOCO] annotate.texinfo

[RFA/DOCO] annotate.texinfo

[Elena Zannoni]

A patch to annotate.texinfo. This fixes a warning when installing the
info files.

w/o the patch:

 install-info --info-dir=/usr/local/info /usr/local/info/gdb.info
 install-info --info-dir=/usr/local/info /usr/local/info/gdbint.info
 install-info --info-dir=/usr/local/info /usr/local/info/stabs.info
 install-info --info-dir=/usr/local/info /usr/local/info/annotate.info
 install-info: warning: no info dir entry in `/usr/local/info/annotate.info'

w/ the patch:
 install-info --info-dir=/usr/local/info /usr/local/info/gdb.info
 install-info --info-dir=/usr/local/info /usr/local/info/gdbint.info
 install-info --info-dir=/usr/local/info /usr/local/info/stabs.info
 install-info --info-dir=/usr/local/info /usr/local/info/annotate.info

I.e. no warning anymore.

I am not sure what the rule for this is, actually. I see that the
other texinfo files don't have START-INFO-DIR-ENTRY and
END-INFO-DIR-ENTRY (except for stabs.texinfo).
But the warning was messing up the rpm install.

elena

2003-11-06  Elena Zannoni  <ezannoni@redhat.com>

	* annotate.texinfo: Add START-INFO-DIR-ENTRY and END-INFO-DIR-ENTRY.

Index: annotate.texinfo
===================================================================
RCS file: /cvs/uberbaum/gdb/doc/annotate.texinfo,v
retrieving revision 1.2
diff -u -p -r1.2 annotate.texinfo
--- annotate.texinfo    24 Oct 2003 17:37:04 -0000      1.2
+++ annotate.texinfo    7 Nov 2003 00:24:49 -0000
@@ -1,6 +1,15 @@
 \input texinfo   @c -*-texinfo-*-
 @c %**start of header
 @setfilename annotate.info
+
+@ifinfo
+@format
+START-INFO-DIR-ENTRY
+* Annotate: (gdb).                 The obsolete annotation interface.
+END-INFO-DIR-ENTRY
+@end format
+@end ifinfo
+
 @c
 @include gdb-cfg.texi
 @c

Re: [RFA/DOCO] annotate.texinfo

[Eli Zaretskii]

> From: Elena Zannoni <ezannoni@redhat.com>
> Date: Thu, 6 Nov 2003 19:25:24 -0500
> 
> A patch to annotate.texinfo. This fixes a warning when installing the
> info files.

Thanks for catching this!

> +@ifinfo
> +@format
> +START-INFO-DIR-ENTRY
> +* Annotate: (gdb).                 The obsolete annotation interface.
> +END-INFO-DIR-ENTRY
> +@end format
> +@end ifinfo

However, this isn't how the problem should be solved.  Please use the
@dircategory and @direntry Texinfo directives, described in the
Texinfo manual.

Re: [RFA/DOCO] annotate.texinfo

[Elena Zannoni]

Eli Zaretskii writes:
 > > From: Elena Zannoni <ezannoni@redhat.com>
 > > Date: Thu, 6 Nov 2003 19:25:24 -0500
 > > 
 > > A patch to annotate.texinfo. This fixes a warning when installing the
 > > info files.
 > 
 > Thanks for catching this!
 > 
 > > +@ifinfo
 > > +@format
 > > +START-INFO-DIR-ENTRY
 > > +* Annotate: (gdb).                 The obsolete annotation interface.
 > > +END-INFO-DIR-ENTRY
 > > +@end format
 > > +@end ifinfo
 > 
 > However, this isn't how the problem should be solved.  Please use the
 > @dircategory and @direntry Texinfo directives, described in the
 > Texinfo manual.

Ah, then also stabs.texinfo is wrong. How's this?
elena

2003-11-10  Elena Zannoni  <ezannoni@redhat.com>

	* stabs.texinfo: Add dircategory and direntry commands.
	* annotate.texinfo: Ditto.

Index: annotate.texinfo
===================================================================
RCS file: /cvs/uberbaum/gdb/doc/annotate.texinfo,v
retrieving revision 1.2
diff -u -p -r1.2 annotate.texinfo
--- annotate.texinfo	24 Oct 2003 17:37:04 -0000	1.2
+++ annotate.texinfo	10 Nov 2003 22:53:38 -0000
@@ -1,6 +1,14 @@
 \input texinfo   @c -*-texinfo-*-
 @c %**start of header
 @setfilename annotate.info
+
+@c This is a dir.info fragment to support semi-automated addition of
+@c manuals to an info tree.
+@dircategory Programming & development tools.
+@direntry
+* Annotate: (gdb).                 The obsolete annotation interface.
+@end direntry
+
 @c
 @include gdb-cfg.texi
 @c
Index: stabs.texinfo
===================================================================
RCS file: /cvs/uberbaum/gdb/doc/stabs.texinfo,v
retrieving revision 1.11
diff -u -p -r1.11 stabs.texinfo
--- stabs.texinfo	4 Aug 2003 20:43:57 -0000	1.11
+++ stabs.texinfo	10 Nov 2003 22:53:43 -0000
@@ -3,13 +3,12 @@
 
 @c @finalout
 
-@ifinfo
-@format
-START-INFO-DIR-ENTRY
-* Stabs: (stabs).                 The "stabs" debugging information format.
-END-INFO-DIR-ENTRY
-@end format
-@end ifinfo
+@c This is a dir.info fragment to support semi-automated addition of
+@c manuals to an info tree.
+@dircategory Programming & development tools.
+@direntry
+* Stabs: (stabs).                 The "stabs" debugging information format.   
+@end direntry
 
 @ifinfo
 This document describes the stabs debugging symbol tables.

Re: [RFA/DOCO] annotate.texinfo

[Eli Zaretskii]

> From: Elena Zannoni <ezannoni@redhat.com>
> Date: Mon, 10 Nov 2003 17:54:15 -0500
> 
> +@c This is a dir.info fragment to support semi-automated addition of
> +@c manuals to an info tree.
> +@dircategory Programming & development tools.
> +@direntry
> +* Annotate: (gdb).                 The obsolete annotation interface.
> +@end direntry

Okay, but shouldn't we have "(annotate)." rather than "(gdb)." here?

Does the link from info/dir work?  I'd expect it to get you to the
wrong manual.

Re: [RFA/DOCO] annotate.texinfo

[Elena Zannoni]

Eli Zaretskii writes:
 > > From: Elena Zannoni <ezannoni@redhat.com>
 > > Date: Mon, 10 Nov 2003 17:54:15 -0500
 > > 
 > > +@c This is a dir.info fragment to support semi-automated addition of
 > > +@c manuals to an info tree.
 > > +@dircategory Programming & development tools.
 > > +@direntry
 > > +* Annotate: (gdb).                 The obsolete annotation interface.
 > > +@end direntry
 > 
 > Okay, but shouldn't we have "(annotate)." rather than "(gdb)." here?
 > 
 > Does the link from info/dir work?  I'd expect it to get you to the
 > wrong manual.

doh. Indeed you are right. "info annotate" would show the gdb info manual.

fixed and committed:

2003-11-11  Elena Zannoni  <ezannoni@redhat.com>

       * stabs.texinfo: Add dircategory and direntry commands.
       * annotate.texinfo: Ditto.

Index: annotate.texinfo
===================================================================
RCS file: /cvs/uberbaum/gdb/doc/annotate.texinfo,v
retrieving revision 1.2
diff -u -p -r1.2 annotate.texinfo
--- annotate.texinfo    24 Oct 2003 17:37:04 -0000      1.2
+++ annotate.texinfo    11 Nov 2003 14:07:28 -0000
@@ -1,6 +1,14 @@
 \input texinfo   @c -*-texinfo-*-
 @c %**start of header
 @setfilename annotate.info
+
+@c This is a dir.info fragment to support semi-automated addition of
+@c manuals to an info tree.
+@dircategory Programming & development tools.
+@direntry
+* Annotate: (annotate).                 The obsolete annotation interface.
+@end direntry
+
 @c
 @include gdb-cfg.texi
 @c
Index: stabs.texinfo
===================================================================
RCS file: /cvs/uberbaum/gdb/doc/stabs.texinfo,v
retrieving revision 1.11
diff -u -p -r1.11 stabs.texinfo
--- stabs.texinfo       4 Aug 2003 20:43:57 -0000       1.11
+++ stabs.texinfo       11 Nov 2003 14:07:33 -0000
@@ -3,13 +3,12 @@
  
 @c @finalout
  
-@ifinfo
-@format
-START-INFO-DIR-ENTRY
-* Stabs: (stabs).                 The "stabs" debugging information format.
-END-INFO-DIR-ENTRY
-@end format
-@end ifinfo
+@c This is a dir.info fragment to support semi-automated addition of
+@c manuals to an info tree.
+@dircategory Programming & development tools.
+@direntry
+* Stabs: (stabs).                 The "stabs" debugging information format.
+@end direntry
  
 @ifinfo
 This document describes the stabs debugging symbol tables.