More improvements in the Emacs manual

* doc/emacs/maintaining.texi (Xref Commands, Identifier Search)
(List Identifiers): Insert blank lines between @item's in a
@table.
(Etags Regexps): More accurate description of escape sequences.
(Select Tags Table): Prefer "~/emacs.d/init.el" to "~/.emacs".
Suggested by Michael Albinus <michael.albinus@gmx.de> in
emacs-manual-bugs@gnu.org.
This commit is contained in:
Eli Zaretskii 2018-02-17 19:48:23 +02:00
parent f138bca8ca
commit 258135ff5d

View file

@ -1611,7 +1611,7 @@ To change this, customize @code{change-log-directory-files}.
@vindex add-log-keep-changes-together @vindex add-log-keep-changes-together
When the variable @code{add-log-keep-changes-together} is When the variable @code{add-log-keep-changes-together} is
non-@code{nil}, @kbd{C-x 4 a} adds to any existing item for the file non-@code{nil}, @kbd{C-x 4 a} adds to any existing item for the file,
rather than starting a new item. rather than starting a new item.
You can combine multiple changes of the same nature. If you don't You can combine multiple changes of the same nature. If you don't
@ -1883,28 +1883,34 @@ the special XREF mode:
@item @key{RET} @item @key{RET}
@itemx mouse-2 @itemx mouse-2
Display the reference on the current line. Display the reference on the current line.
@item n @item n
@itemx . @itemx .
@findex xref-next-line @findex xref-next-line
Move to the next reference and display it in the other window Move to the next reference and display it in the other window
(@code{xref-next-line}). (@code{xref-next-line}).
@item p @item p
@itemx , @itemx ,
@findex xref-prev-line @findex xref-prev-line
Move to the previous reference and display it in the other window Move to the previous reference and display it in the other window
(@code{xref-prev-line}). (@code{xref-prev-line}).
@item C-o @item C-o
@findex xref-show-location-at-point @findex xref-show-location-at-point
Display the reference on the current line in the other window Display the reference on the current line in the other window
(@code{xref-show-location-at-point}). (@code{xref-show-location-at-point}).
@item @key{TAB} @item @key{TAB}
@findex xref-quit-and-goto-xref @findex xref-quit-and-goto-xref
Display the reference on the current line and bury the @file{*xref*} Display the reference on the current line and bury the @file{*xref*}
buffer (@code{xref-quit-and-goto-xref}). buffer (@code{xref-quit-and-goto-xref}).
@item r @var{pattern} @key{RET} @var{replacement} @key{RET} @item r @var{pattern} @key{RET} @var{replacement} @key{RET}
Perform interactive query-replace on references that match Perform interactive query-replace on references that match
@var{pattern} (@code{xref-query-replace-in-results}), replacing @var{pattern} (@code{xref-query-replace-in-results}), replacing
the match with @var{replacement}. @xref{Identifier Search}. the match with @var{replacement}. @xref{Identifier Search}.
@findex xref-quit @findex xref-quit
@item q @item q
Quit the window showing the @file{*xref*} buffer (@code{xref-quit}). Quit the window showing the @file{*xref*} buffer (@code{xref-quit}).
@ -1926,14 +1932,18 @@ them.
@table @kbd @table @kbd
@item M-? @item M-?
Find all the references for the identifier at point. Find all the references for the identifier at point.
@item M-x xref-query-replace-in-results @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET} @item M-x xref-query-replace-in-results @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET}
Interactively replace @var{regexp} with @var{replacement} in the names Interactively replace @var{regexp} with @var{replacement} in the names
of all the identifiers shown in the @file{*xref*} buffer. of all the identifiers shown in the @file{*xref*} buffer.
@item M-x tags-search @key{RET} @var{regexp} @key{RET} @item M-x tags-search @key{RET} @var{regexp} @key{RET}
Search for @var{regexp} through the files in the selected tags Search for @var{regexp} through the files in the selected tags
table. table.
@item M-x tags-query-replace @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET} @item M-x tags-query-replace @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET}
Perform a @code{query-replace-regexp} on each file in the selected tags table. Perform a @code{query-replace-regexp} on each file in the selected tags table.
@item M-x tags-loop-continue @item M-x tags-loop-continue
Restart one of the last 2 commands above, from the current location of point. Restart one of the last 2 commands above, from the current location of point.
@end table @end table
@ -1967,7 +1977,7 @@ available (@pxref{Tags Tables}).
@findex tags-loop-continue @findex tags-loop-continue
Having found one match with @code{tags-search}, you probably want to Having found one match with @code{tags-search}, you probably want to
find all the rest. Type @kbd{M-x tags-loop-continue} to resume the find all the rest. @kbd{M-x tags-loop-continue} resumes the
@code{tags-search}, finding one more match. This searches the rest of @code{tags-search}, finding one more match. This searches the rest of
the current buffer, followed by the remaining files of the tags table. the current buffer, followed by the remaining files of the tags table.
@ -2017,11 +2027,14 @@ Searching}.
@itemx M-@key{TAB} @itemx M-@key{TAB}
Perform completion on the text around point, possibly using the Perform completion on the text around point, possibly using the
selected tags table if one is loaded (@code{completion-at-point}). selected tags table if one is loaded (@code{completion-at-point}).
@item M-x xref-find-apropos @key{RET} @var{regexp} @key{RET} @item M-x xref-find-apropos @key{RET} @var{regexp} @key{RET}
Display a list of all known identifiers matching @var{regexp}. Display a list of all known identifiers matching @var{regexp}.
@item M-x list-tags @key{RET} @var{file} @key{RET} @item M-x list-tags @key{RET} @var{file} @key{RET}
Display a list of the identifiers defined in the program file Display a list of the identifiers defined in the program file
@var{file}. @var{file}.
@item M-x next-file @item M-x next-file
Visit files recorded in the selected tags table. Visit files recorded in the selected tags table.
@end table @end table
@ -2435,11 +2448,12 @@ matches at the beginning of a line. If you want to allow indented
tags, use a regexp that matches initial whitespace; start it with tags, use a regexp that matches initial whitespace; start it with
@samp{[ \t]*}. @samp{[ \t]*}.
In these regular expressions, @samp{\} quotes the next character, and In these regular expressions, @samp{\} quotes the next character,
all the GCC character escape sequences are supported (@samp{\a} for and all the C character escape sequences are supported: @samp{\a} for
bell, @samp{\b} for back space, @samp{\d} for delete, @samp{\e} for bell, @samp{\b} for back space, @samp{\e} for escape, @samp{\f} for
escape, @samp{\f} for formfeed, @samp{\n} for newline, @samp{\r} for formfeed, @samp{\n} for newline, @samp{\r} for carriage return,
carriage return, @samp{\t} for tab, and @samp{\v} for vertical tab). @samp{\t} for tab, and @samp{\v} for vertical tab. In addition,
@samp{\d} stands for the @code{DEL} character.
Ideally, @var{tagregexp} should not match more characters than are Ideally, @var{tagregexp} should not match more characters than are
needed to recognize what you want to tag. If the syntax requires you needed to recognize what you want to tag. If the syntax requires you
@ -2607,7 +2621,7 @@ current list, it is used @emph{as well as} the others.
@example @example
@group @group
(setq tags-table-list (setq tags-table-list
'("~/emacs" "/usr/local/lib/emacs/src")) '("~/emacs.d/init.el" "/usr/local/lib/emacs/src"))
@end group @end group
@end example @end example