diff options
| author | Eli Zaretskii | 2009-04-25 07:19:58 +0000 |
|---|---|---|
| committer | Eli Zaretskii | 2009-04-25 07:19:58 +0000 |
| commit | f1a4788495fe65611d8d9ba02080595b14f6ff7f (patch) | |
| tree | f16cfec4af003feaa38add2b3d60171f91656cb7 | |
| parent | b7053016e44dbeef02915ee3392079fd7846be17 (diff) | |
| download | emacs-f1a4788495fe65611d8d9ba02080595b14f6ff7f.tar.gz emacs-f1a4788495fe65611d8d9ba02080595b14f6ff7f.zip | |
(Tags): Clarify text. (Bug#3101)
| -rw-r--r-- | doc/emacs/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/emacs/maintaining.texi | 30 |
2 files changed, 21 insertions, 13 deletions
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 @@ | |||
| 1 | 2009-04-25 Eli Zaretskii <eliz@gnu.org> | ||
| 2 | |||
| 3 | * maintaining.texi (Tags): Clarify text. (Bug#3101) | ||
| 4 | |||
| 1 | 2009-04-22 Chong Yidong <cyd@stupidchicken.com> | 5 | 2009-04-22 Chong Yidong <cyd@stupidchicken.com> |
| 2 | 6 | ||
| 3 | * entering.texi (Entering Emacs): Document initial-buffer-choice. | 7 | * 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. | |||
| 1480 | @section Tags Tables | 1480 | @section Tags Tables |
| 1481 | @cindex tags and tag tables | 1481 | @cindex tags and tag tables |
| 1482 | 1482 | ||
| 1483 | A @dfn{tags table} is a description of how a multi-file program is | 1483 | A @dfn{tags table} is a description of how program's sources are |
| 1484 | broken up into files. It lists the names of the component files and the | 1484 | broken up into individual source files. It lists the names of the |
| 1485 | names and positions of the functions (or other named subunits) in each | 1485 | component files and the names and positions of the functions (or other |
| 1486 | file. Grouping the related files makes it possible to search or replace | 1486 | named subunits) in each file. Commands that search or replace through |
| 1487 | through all the files with one command. Recording the function names | 1487 | multiple files use the list of source files to know which files to |
| 1488 | and positions makes possible the @kbd{M-.} command which finds the | 1488 | search. Commands such as @kbd{M-.}, which finds the definition of a |
| 1489 | definition of a function by looking up which of the files it is in. | 1489 | function, uses the recorded information about the function names and |
| 1490 | positions to find the source file and the position within that file | ||
| 1491 | where the function is defined. | ||
| 1490 | 1492 | ||
| 1491 | Tags tables are stored in files called @dfn{tags table files}. The | 1493 | Tags tables are stored in files called @dfn{tags table files}. The |
| 1492 | conventional name for a tags table file is @file{TAGS}. | 1494 | conventional name for a tags table file is @file{TAGS}. |
| 1493 | 1495 | ||
| 1494 | Each entry in the tags table records the name of one tag, the name of the | 1496 | Each entry in the tags table records the name of a tag, the name of |
| 1495 | file that the tag is defined in (implicitly), and the position in that | 1497 | the file that the tag is defined in (implicitly), and the position in |
| 1496 | file of the tag's definition. When a file parsed by @code{etags} is | 1498 | that file of the tag's definition. If the file is a generated file, |
| 1497 | generated from a different source file, like a C file generated from a | 1499 | the tags for the generated file reference the originating source file. |
| 1498 | Cweb source file, the tags of the parsed file reference the source | 1500 | Examples of generated files include C files generated from Cweb source |
| 1499 | file. | 1501 | files or from a Yacc parser or Lex scanner definitions, @file{.i} |
| 1502 | preprocessed C files, and Fortran files produced by preprocessing | ||
| 1503 | @file{.fpp} source files. | ||
| 1500 | 1504 | ||
| 1501 | Just what names from the described files are recorded in the tags table | 1505 | Just what names from the described files are recorded in the tags table |
| 1502 | depends on the programming language of the described file. They | 1506 | depends on the programming language of the described file. They |