Github/emacs
2
0
Fork 1
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-16 09:14:18 +00:00
Code Issues Projects Releases Packages Wiki Activity

; Improve documentation of 'etags-regen-mode'

Browse source 
* doc/emacs/maintaining.texi (Xref, Tags Tables)
(Create Tags Table, Select Tags Table): Improve documentation and
cross-references for 'etags-regen-mode'.
This commit is contained in:
Eli Zaretskii 2026-02-07 09:12:42 +02:00
parent df517aa958
commit cdc390d992
1 changed files with 20 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
doc/emacs/maintaining.texi
View file

@ -2572,10 +2572,10 @@ identifier definitions in programs, which supports many programming
languages and other major modes, such as HTML, by extracting references languages and other major modes, such as HTML, by extracting references
into @dfn{tags tables}. Major modes for languages supported by into @dfn{tags tables}. Major modes for languages supported by
@command{etags} can use tags tables as basis for their backend. Enable @command{etags} can use tags tables as basis for their backend. Enable
@code{etags-regen-mode} to have tags generated across the current @code{etags-regen-mode} to have tags tables generated across the current
project for supported file types and updated automatically on edit. Or project for supported file types and updated automatically upon edit.
build the table manually to control the set of files and when it is Alternatively, you can build the table manually to control the set of
updated, see @xref{Create Tags Table}. files and when it is updated, see @ref{Create Tags Table}.
@end enumerate @end enumerate
@menu @menu
@ -3032,7 +3032,9 @@ writes the tags to a @dfn{tags table file}, or @dfn{tags file} in
short. The conventional name for a tags file is @file{TAGS}@. short. The conventional name for a tags file is @file{TAGS}@.
@xref{Create Tags Table}. (It is also possible to create a tags table @xref{Create Tags Table}. (It is also possible to create a tags table
by using one of the commands from other packages that can produce such by using one of the commands from other packages that can produce such
tables in the same format.) tables in the same format.) If you enable the @code{etags-regen-mode}
global minor mode, Emacs will generate and update the tags tables
automatically as needed.
Emacs uses the tags tables via the @code{etags} package as one of Emacs uses the tags tables via the @code{etags} package as one of
the supported backends for @code{xref}. Because tags tables are the supported backends for @code{xref}. Because tags tables are
@ -3314,6 +3316,10 @@ You should update a tags table when you define new tags that you want
to have listed, or when you move tag definitions from one file to to have listed, or when you move tag definitions from one file to
another, or when changes become substantial. another, or when changes become substantial.
If the @code{etags-regen-mode} minor mode, described below, is
enabled, Emacs will automatically keep the tags tables up-to-date as
needed.
You can make a tags table @dfn{include} another tags table, by You can make a tags table @dfn{include} another tags table, by
passing the @samp{--include=@var{file}} option to @command{etags}. It passing the @samp{--include=@var{file}} option to @command{etags}. It
then covers all the files covered by the included tags file, as well then covers all the files covered by the included tags file, as well
@ -3422,11 +3428,11 @@ Command-line options to pass to the program which regenerates tags
tables. tables.
@item etags-regen-ignores @item etags-regen-ignores
List of glob patterns which specify files to ignore when regenerating List of glob wildcard patterns which specify files to ignore when
tags tables. regenerating tags tables.
@end vtable @end vtable
@cindex tags-reset-tags-tables @findex tags-reset-tags-tables
If you select a tags table manually, with @kbd{M-x visit-tags-table} If you select a tags table manually, with @kbd{M-x visit-tags-table}
(@pxref{Select Tags Table}), @code{etags-regen-mode} effectively (@pxref{Select Tags Table}), @code{etags-regen-mode} effectively
disables itself: it will no longer automatically create and update disables itself: it will no longer automatically create and update
@ -3611,6 +3617,12 @@ to the first directory that contains a file named @file{TAGS}
encountered when recursively searching upward from the default encountered when recursively searching upward from the default
directory. directory.
If you enable the @code{etags-regen-mode} global minor mode, it will
automatically find and visit the tags table file when needed. If you
then invoke @code{visit-tags-table} manually to select a tags table,
@code{etags-regen-mode} will disable automatic regeneration of the tags
table. @xref{Create Tags Table}.
@vindex tags-file-name @vindex tags-file-name
Emacs does not actually read in the tags table contents until you Emacs does not actually read in the tags table contents until you
try to use them; all @code{visit-tags-table} does is store the file try to use them; all @code{visit-tags-table} does is store the file