bug#3101: marked as done (23.0.92; Emacs manual, node Tags)

[Emacs bug Tracking System]

Your message dated Sat, 25 Apr 2009 10:23:34 +0300
with message-id <83skjxfb7t.fsf@gnu.org>
and subject line Re: bug#3101: 23.0.92; Emacs manual, node Tags
has caused the Emacs bug report #3101,
regarding 23.0.92; Emacs manual, node Tags
to be marked as done.

This means that you claim that the problem has been dealt with.
If this is not the case it is now your responsibility to reopen the
bug report if necessary, and/or fix the problem forthwith.

(NB: If you are a system administrator and have no idea what this
message is talking about, this may indicate a serious mail system
misconfiguration somewhere. Please contact owner@emacsbugs.donarmstrong.com
immediately.)


-- 
3101: http://emacsbugs.donarmstrong.com/cgi-bin/bugreport.cgi?bug=3101
Emacs Bug Tracking System
Contact owner@emacsbugs.donarmstrong.com with problems
> --- Begin Message ---
>
>
>
> Subject: 
>
> 23.0.92; Emacs manual, node Tags
>
>
>
>
> Date: 
>
> Fri, 24 Apr 2009 13:36:31 -0700
>
>
>
>
> The first sentence of this node doesn't sound right to me. At least
> it's not clear what is meant.
>  
>   "A "tags table" is a description of how a multi-file
>    program is broken up into files."
>  
> A multi-file program? What program would that be? There is no further
> mention of this.  I don't understand this sentence, and I cannot
> imagine how it describes what a tags table is.
>  
> Also confusing is the part that starts "When a file parsed by `etags'
> is generated from a different source file, like a C file generated
> from a Cweb source file,..." To understand this (and I don't), a
> reader needs to already understand what `etags' is and what its
> parsing amounts to, and s?he needs to know what Cweb is (I don't). Not
> to mention that it is mysterious what is meant by "a different source
> file" - different from what?
>  
> One cannot understand this text without knowing how tags work, the
> role of "source files" in that, and so on. IOW, this doesn't help; it
> confuses.
>  
>
> In GNU Emacs 23.0.92.1 (i386-mingw-nt5.1.2600)
>  of 2009-03-30 on SOFT-MJASON
> Windowing system distributor `Microsoft Corp.', version 5.1.2600
> configured using `configure --with-gcc (3.4)'
>  
>
>
>
>
> --- End Message ---
> --- Begin Message ---
>
>
>
> Subject: 
>
> Re: bug#3101: 23.0.92; Emacs manual, node Tags
>
>
>
>
> Date: 
>
> Sat, 25 Apr 2009 10:23:34 +0300
>
>
>
>
> > From: "Drew Adams" <drew.adams@oracle.com>
> > Date: Fri, 24 Apr 2009 13:36:31 -0700
> > Cc: 
> > 
> > The first sentence of this node doesn't sound right to me. At least
> > it's not clear what is meant.
> >  
> >   "A "tags table" is a description of how a multi-file
> >    program is broken up into files."
> >  
> > A multi-file program? What program would that be? There is no further
> > mention of this.  I don't understand this sentence, and I cannot
> > imagine how it describes what a tags table is.
>
> I changed this to
>
>     A @dfn{tags table} is a description of how program's sources are
>   broken up into individual source files.
>
> I hope this is more clear.
>
> > Also confusing is the part that starts "When a file parsed by `etags'
> > is generated from a different source file, like a C file generated
> > from a Cweb source file,..." To understand this (and I don't), a
> > reader needs to already understand what `etags' is and what its
> > parsing amounts to, and s?he needs to know what Cweb is (I don't). Not
> > to mention that it is mysterious what is meant by "a different source
> > file" - different from what?
>
> The text reads now
>
>     Each entry in the tags table records the name of a tag, the name of
>   the file that the tag is defined in (implicitly), and the position in
>   that file of the tag's definition.  If the file is a generated file,
>   its tags reference the originating source file.  Examples of generated
>   files include C files generated from Cweb source files or from a Yacc
>   parser or Lex scanner definitions, @file{.i} preprocessed C files, and
>   Fortran files produced by preprocessing @file{.fpp} source files.
>
> OK?
>
>
> --- End Message ---