diff options
| author | Eli Zaretskii | 2018-02-17 19:48:23 +0200 |
|---|---|---|
| committer | Eli Zaretskii | 2018-02-17 19:48:23 +0200 |
| commit | 258135ff5d9d3f41a6d98a5d04484646824db035 (patch) | |
| tree | 4500107cbebf8f32c4c1a68a006f1ec394819982 | |
| parent | f138bca8ca2db89d663a2cf8d80e6368437e4e3c (diff) | |
| download | emacs-258135ff5d9d3f41a6d98a5d04484646824db035.tar.gz emacs-258135ff5d9d3f41a6d98a5d04484646824db035.zip | |
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.
| -rw-r--r-- | doc/emacs/maintaining.texi | 30 |
1 files changed, 22 insertions, 8 deletions
diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi index 541bf9708ba..7712fb2d696 100644 --- a/doc/emacs/maintaining.texi +++ b/doc/emacs/maintaining.texi | |||
| @@ -1611,7 +1611,7 @@ To change this, customize @code{change-log-directory-files}. | |||
| 1611 | 1611 | ||
| 1612 | @vindex add-log-keep-changes-together | 1612 | @vindex add-log-keep-changes-together |
| 1613 | When the variable @code{add-log-keep-changes-together} is | 1613 | When the variable @code{add-log-keep-changes-together} is |
| 1614 | non-@code{nil}, @kbd{C-x 4 a} adds to any existing item for the file | 1614 | non-@code{nil}, @kbd{C-x 4 a} adds to any existing item for the file, |
| 1615 | rather than starting a new item. | 1615 | rather than starting a new item. |
| 1616 | 1616 | ||
| 1617 | You can combine multiple changes of the same nature. If you don't | 1617 | You can combine multiple changes of the same nature. If you don't |
| @@ -1883,28 +1883,34 @@ the special XREF mode: | |||
| 1883 | @item @key{RET} | 1883 | @item @key{RET} |
| 1884 | @itemx mouse-2 | 1884 | @itemx mouse-2 |
| 1885 | Display the reference on the current line. | 1885 | Display the reference on the current line. |
| 1886 | |||
| 1886 | @item n | 1887 | @item n |
| 1887 | @itemx . | 1888 | @itemx . |
| 1888 | @findex xref-next-line | 1889 | @findex xref-next-line |
| 1889 | Move to the next reference and display it in the other window | 1890 | Move to the next reference and display it in the other window |
| 1890 | (@code{xref-next-line}). | 1891 | (@code{xref-next-line}). |
| 1892 | |||
| 1891 | @item p | 1893 | @item p |
| 1892 | @itemx , | 1894 | @itemx , |
| 1893 | @findex xref-prev-line | 1895 | @findex xref-prev-line |
| 1894 | Move to the previous reference and display it in the other window | 1896 | Move to the previous reference and display it in the other window |
| 1895 | (@code{xref-prev-line}). | 1897 | (@code{xref-prev-line}). |
| 1898 | |||
| 1896 | @item C-o | 1899 | @item C-o |
| 1897 | @findex xref-show-location-at-point | 1900 | @findex xref-show-location-at-point |
| 1898 | Display the reference on the current line in the other window | 1901 | Display the reference on the current line in the other window |
| 1899 | (@code{xref-show-location-at-point}). | 1902 | (@code{xref-show-location-at-point}). |
| 1903 | |||
| 1900 | @item @key{TAB} | 1904 | @item @key{TAB} |
| 1901 | @findex xref-quit-and-goto-xref | 1905 | @findex xref-quit-and-goto-xref |
| 1902 | Display the reference on the current line and bury the @file{*xref*} | 1906 | Display the reference on the current line and bury the @file{*xref*} |
| 1903 | buffer (@code{xref-quit-and-goto-xref}). | 1907 | buffer (@code{xref-quit-and-goto-xref}). |
| 1908 | |||
| 1904 | @item r @var{pattern} @key{RET} @var{replacement} @key{RET} | 1909 | @item r @var{pattern} @key{RET} @var{replacement} @key{RET} |
| 1905 | Perform interactive query-replace on references that match | 1910 | Perform interactive query-replace on references that match |
| 1906 | @var{pattern} (@code{xref-query-replace-in-results}), replacing | 1911 | @var{pattern} (@code{xref-query-replace-in-results}), replacing |
| 1907 | the match with @var{replacement}. @xref{Identifier Search}. | 1912 | the match with @var{replacement}. @xref{Identifier Search}. |
| 1913 | |||
| 1908 | @findex xref-quit | 1914 | @findex xref-quit |
| 1909 | @item q | 1915 | @item q |
| 1910 | Quit the window showing the @file{*xref*} buffer (@code{xref-quit}). | 1916 | Quit the window showing the @file{*xref*} buffer (@code{xref-quit}). |
| @@ -1926,14 +1932,18 @@ them. | |||
| 1926 | @table @kbd | 1932 | @table @kbd |
| 1927 | @item M-? | 1933 | @item M-? |
| 1928 | Find all the references for the identifier at point. | 1934 | Find all the references for the identifier at point. |
| 1935 | |||
| 1929 | @item M-x xref-query-replace-in-results @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET} | 1936 | @item M-x xref-query-replace-in-results @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET} |
| 1930 | Interactively replace @var{regexp} with @var{replacement} in the names | 1937 | Interactively replace @var{regexp} with @var{replacement} in the names |
| 1931 | of all the identifiers shown in the @file{*xref*} buffer. | 1938 | of all the identifiers shown in the @file{*xref*} buffer. |
| 1939 | |||
| 1932 | @item M-x tags-search @key{RET} @var{regexp} @key{RET} | 1940 | @item M-x tags-search @key{RET} @var{regexp} @key{RET} |
| 1933 | Search for @var{regexp} through the files in the selected tags | 1941 | Search for @var{regexp} through the files in the selected tags |
| 1934 | table. | 1942 | table. |
| 1943 | |||
| 1935 | @item M-x tags-query-replace @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET} | 1944 | @item M-x tags-query-replace @key{RET} @var{regexp} @key{RET} @var{replacement} @key{RET} |
| 1936 | Perform a @code{query-replace-regexp} on each file in the selected tags table. | 1945 | Perform a @code{query-replace-regexp} on each file in the selected tags table. |
| 1946 | |||
| 1937 | @item M-x tags-loop-continue | 1947 | @item M-x tags-loop-continue |
| 1938 | Restart one of the last 2 commands above, from the current location of point. | 1948 | Restart one of the last 2 commands above, from the current location of point. |
| 1939 | @end table | 1949 | @end table |
| @@ -1967,7 +1977,7 @@ available (@pxref{Tags Tables}). | |||
| 1967 | 1977 | ||
| 1968 | @findex tags-loop-continue | 1978 | @findex tags-loop-continue |
| 1969 | Having found one match with @code{tags-search}, you probably want to | 1979 | Having found one match with @code{tags-search}, you probably want to |
| 1970 | find all the rest. Type @kbd{M-x tags-loop-continue} to resume the | 1980 | find all the rest. @kbd{M-x tags-loop-continue} resumes the |
| 1971 | @code{tags-search}, finding one more match. This searches the rest of | 1981 | @code{tags-search}, finding one more match. This searches the rest of |
| 1972 | the current buffer, followed by the remaining files of the tags table. | 1982 | the current buffer, followed by the remaining files of the tags table. |
| 1973 | 1983 | ||
| @@ -2017,11 +2027,14 @@ Searching}. | |||
| 2017 | @itemx M-@key{TAB} | 2027 | @itemx M-@key{TAB} |
| 2018 | Perform completion on the text around point, possibly using the | 2028 | Perform completion on the text around point, possibly using the |
| 2019 | selected tags table if one is loaded (@code{completion-at-point}). | 2029 | selected tags table if one is loaded (@code{completion-at-point}). |
| 2030 | |||
| 2020 | @item M-x xref-find-apropos @key{RET} @var{regexp} @key{RET} | 2031 | @item M-x xref-find-apropos @key{RET} @var{regexp} @key{RET} |
| 2021 | Display a list of all known identifiers matching @var{regexp}. | 2032 | Display a list of all known identifiers matching @var{regexp}. |
| 2033 | |||
| 2022 | @item M-x list-tags @key{RET} @var{file} @key{RET} | 2034 | @item M-x list-tags @key{RET} @var{file} @key{RET} |
| 2023 | Display a list of the identifiers defined in the program file | 2035 | Display a list of the identifiers defined in the program file |
| 2024 | @var{file}. | 2036 | @var{file}. |
| 2037 | |||
| 2025 | @item M-x next-file | 2038 | @item M-x next-file |
| 2026 | Visit files recorded in the selected tags table. | 2039 | Visit files recorded in the selected tags table. |
| 2027 | @end table | 2040 | @end table |
| @@ -2435,11 +2448,12 @@ matches at the beginning of a line. If you want to allow indented | |||
| 2435 | tags, use a regexp that matches initial whitespace; start it with | 2448 | tags, use a regexp that matches initial whitespace; start it with |
| 2436 | @samp{[ \t]*}. | 2449 | @samp{[ \t]*}. |
| 2437 | 2450 | ||
| 2438 | In these regular expressions, @samp{\} quotes the next character, and | 2451 | In these regular expressions, @samp{\} quotes the next character, |
| 2439 | all the GCC character escape sequences are supported (@samp{\a} for | 2452 | and all the C character escape sequences are supported: @samp{\a} for |
| 2440 | bell, @samp{\b} for back space, @samp{\d} for delete, @samp{\e} for | 2453 | bell, @samp{\b} for back space, @samp{\e} for escape, @samp{\f} for |
| 2441 | escape, @samp{\f} for formfeed, @samp{\n} for newline, @samp{\r} for | 2454 | formfeed, @samp{\n} for newline, @samp{\r} for carriage return, |
| 2442 | carriage return, @samp{\t} for tab, and @samp{\v} for vertical tab). | 2455 | @samp{\t} for tab, and @samp{\v} for vertical tab. In addition, |
| 2456 | @samp{\d} stands for the @code{DEL} character. | ||
| 2443 | 2457 | ||
| 2444 | Ideally, @var{tagregexp} should not match more characters than are | 2458 | Ideally, @var{tagregexp} should not match more characters than are |
| 2445 | needed to recognize what you want to tag. If the syntax requires you | 2459 | 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. | |||
| 2607 | @example | 2621 | @example |
| 2608 | @group | 2622 | @group |
| 2609 | (setq tags-table-list | 2623 | (setq tags-table-list |
| 2610 | '("~/emacs" "/usr/local/lib/emacs/src")) | 2624 | '("~/emacs.d/init.el" "/usr/local/lib/emacs/src")) |
| 2611 | @end group | 2625 | @end group |
| 2612 | @end example | 2626 | @end example |
| 2613 | 2627 | ||