From: Eli Zaretskii Date: Sat, 25 Apr 2009 07:19:58 +0000 (+0000) Subject: (Tags): Clarify text. (Bug#3101) X-Git-Tag: emacs-pretest-23.0.93~57 X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=f1a4788495fe65611d8d9ba02080595b14f6ff7f;p=emacs.git (Tags): Clarify text. (Bug#3101) --- diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index ae57d3f74a9..54ae69f9728 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,3 +1,7 @@ +2009-04-25 Eli Zaretskii + + * maintaining.texi (Tags): Clarify text. (Bug#3101) + 2009-04-22 Chong Yidong * entering.texi (Entering Emacs): Document initial-buffer-choice. diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi index 543ffae9eb9..13fdb123135 100644 --- a/doc/emacs/maintaining.texi +++ b/doc/emacs/maintaining.texi @@ -1480,23 +1480,27 @@ Of course, you should substitute the proper years and copyright holder. @section Tags Tables @cindex tags and tag tables - A @dfn{tags table} is a description of how a multi-file program is -broken up into files. It lists the names of the component files and the -names and positions of the functions (or other named subunits) in each -file. Grouping the related files makes it possible to search or replace -through all the files with one command. Recording the function names -and positions makes possible the @kbd{M-.} command which finds the -definition of a function by looking up which of the files it is in. + A @dfn{tags table} is a description of how program's sources are +broken up into individual source files. It lists the names of the +component files and the names and positions of the functions (or other +named subunits) in each file. Commands that search or replace through +multiple files use the list of source files to know which files to +search. Commands such as @kbd{M-.}, which finds the definition of a +function, uses the recorded information about the function names and +positions to find the source file and the position within that file +where the function is defined. Tags tables are stored in files called @dfn{tags table files}. The conventional name for a tags table file is @file{TAGS}. - Each entry in the tags table records the name of one tag, the name of the -file that the tag is defined in (implicitly), and the position in that -file of the tag's definition. When a file parsed by @code{etags} is -generated from a different source file, like a C file generated from a -Cweb source file, the tags of the parsed file reference the source -file. + 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, +the tags for the generated file 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. Just what names from the described files are recorded in the tags table depends on the programming language of the described file. They