From f982b37104acdd2b3aee4fe3bb08ae052990f869 Mon Sep 17 00:00:00 2001 From: Eli Zaretskii Date: Mon, 21 Apr 2014 17:50:19 +0300 Subject: [PATCH] Minor fixes to the docs. doc/emacs/buffers.texi (Uniquify): Clarify the default uniquification. doc/emacs/indent.texi (Tab Stops): Improve wording. doc/emacs/cmdargs.texi (General Variables): Improve docs of EMACSLOADPATH. Index all the environment variables. (Misc Variables): Index all the environment variables. doc/lispref/text.texi (Registers): Document register-read-with-preview. doc/lispref/internals.texi (Building Emacs): Improve indexing. --- doc/emacs/ChangeLog | 10 ++++++++++ doc/emacs/buffers.texi | 8 ++++++-- doc/emacs/cmdargs.texi | 12 +++++++----- doc/emacs/indent.texi | 10 +++++----- doc/lispref/ChangeLog | 6 ++++++ doc/lispref/internals.texi | 2 ++ doc/lispref/text.texi | 12 ++++++++++++ 7 files changed, 48 insertions(+), 12 deletions(-) diff --git a/doc/emacs/ChangeLog b/doc/emacs/ChangeLog index a589558236a..12037aae275 100644 --- a/doc/emacs/ChangeLog +++ b/doc/emacs/ChangeLog @@ -1,3 +1,13 @@ +2014-04-21 Eli Zaretskii + + * buffers.texi (Uniquify): Clarify the default uniquification. + + * indent.texi (Tab Stops): Improve wording. + + * cmdargs.texi (General Variables): Improve docs of + EMACSLOADPATH. Index all the environment variables. + (Misc Variables): Index all the environment variables. + 2014-04-13 Eli Zaretskii * display.texi (Cursor Display): Explain better how to customize diff --git a/doc/emacs/buffers.texi b/doc/emacs/buffers.texi index c96b657b481..3f55cf7076e 100644 --- a/doc/emacs/buffers.texi +++ b/doc/emacs/buffers.texi @@ -611,8 +611,12 @@ convenient to switch between buffers. the buffers distinct names. The default method (@code{uniquify-buffer-name-style} set to @code{post-forward-angle-brackets}) for making buffer names unique -adds @samp{}, @samp{}, etc. to the end of the buffer -names. +adds @samp{}, @samp{}, etc.@: to the end of the buffer +names, where @file{dir1} and @file{dir2} are the minimal parts of the +leading directories needed to make the buffer name unique. For +example, if you have files @file{/foo/bar/mumble/name} and +@file{/baz/quux/mumble/name} visited, their buffers will be named +@samp{name} and @samp{name} correspondingly. @vindex uniquify-buffer-name-style There are several styles to make buffer names unique. To select diff --git a/doc/emacs/cmdargs.texi b/doc/emacs/cmdargs.texi index 06e41a57681..ce7af79076e 100644 --- a/doc/emacs/cmdargs.texi +++ b/doc/emacs/cmdargs.texi @@ -439,7 +439,7 @@ special meanings in Emacs. Most of these variables are also used by some other programs. Emacs does not require any of these environment variables to be set, but it uses their values if they are set. -@table @env +@vtable @env @item CDPATH Used by the @code{cd} command to search for the directory you specify, when you specify a relative directory name. @@ -464,7 +464,9 @@ Emacs Lisp files. If set, it modifies the usual initial value of the @code{load-path} variable (@pxref{Lisp Libraries}). An empty element stands for the default value of @code{load-path}; e.g., using @samp{EMACSLOADPATH="/tmp:"} adds @file{/tmp} to the front of -the default @code{load-path}. +the default @code{load-path}. To specify an empty element in the +middle of the list, use 2 colons in a row, as in +@samp{EMACSLOADPATH="/tmp::/foo"}. @item EMACSPATH A colon-separated list of directories to search for executable files. If set, Emacs uses this in addition to @env{PATH} (see below) when @@ -598,14 +600,14 @@ defaults to @samp{root}. @item VERSION_CONTROL Used to initialize the @code{version-control} variable (@pxref{Backup Names}). -@end table +@end vtable @node Misc Variables @appendixsubsec Miscellaneous Variables These variables are used only on particular configurations: -@table @env +@vtable @env @item COMSPEC On MS-DOS and MS-Windows, the name of the command interpreter to use when invoking batch files and commands internal to the shell. On MS-DOS @@ -657,7 +659,7 @@ rather than hard-coding an absolute path. This allows multiple versions of Emacs to share the same environment variable settings, and it allows you to move the Emacs installation directory, without changing any environment or registry settings. -@end table +@end vtable @node MS-Windows Registry @appendixsubsec The MS-Windows System Registry diff --git a/doc/emacs/indent.texi b/doc/emacs/indent.texi index 4b44b9289b5..b254cfca43e 100644 --- a/doc/emacs/indent.texi +++ b/doc/emacs/indent.texi @@ -153,11 +153,11 @@ C-u -999 C-x @key{TAB} are used as stopping points by @key{TAB} when inserting whitespace in Text mode and related modes (@pxref{Indentation}), and by commands like @kbd{M-i} (@pxref{Indentation Commands}). The variable -@code{tab-stop-list} controls these positions. The default value -is @code{nil}, which means a tab stop every 8 columns. The value -can also be a list of column numbers (in increasing order) at which to -place tab stops. Emacs extends the list forever by repeating the -difference between the last and next-to-last elements. +@code{tab-stop-list} controls these positions. The default value is +@code{nil}, which means a tab stop every 8 columns. The value can +also be a list of zero-based column numbers (in increasing order) at +which to place tab stops. Emacs extends the list forever by repeating +the difference between the last and next-to-last elements. @findex edit-tab-stops @kindex C-c C-c @r{(Edit Tab Stops)} diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index b31398fffc4..de3b1ddb20c 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog @@ -1,3 +1,9 @@ +2014-04-21 Eli Zaretskii + + * text.texi (Registers): Document register-read-with-preview. + + * internals.texi (Building Emacs): Improve indexing. + 2014-04-05 Glenn Morris * os.texi (Recording Input): Dribble files may contain passwords. diff --git a/doc/lispref/internals.texi b/doc/lispref/internals.texi index d91b0349810..f85701f5396 100644 --- a/doc/lispref/internals.texi +++ b/doc/lispref/internals.texi @@ -111,6 +111,8 @@ drawback that the documentation strings take up space in Emacs all the time.) @end itemize +@cindex change @code{load-path} at configure time +@cindex @option{--enable-locallisppath} option to @command{configure} It is not advisable to put anything in @file{site-load.el} or @file{site-init.el} that would alter any of the features that users expect in an ordinary unmodified Emacs. If you feel you must override diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 7c5603fd645..3c70f5f96b0 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -4117,6 +4117,18 @@ a rectangle (a list), currently useless things happen. This may be changed in the future. @end deffn +@defun register-read-with-preview prompt +@cindex register preview +This function reads and returns a register name, prompting with +@var{prompt} and possibly showing a preview of the existing registers +and their contents. The preview is shown in a temporary window, after +the delay specified by the user option @code{register-preview-delay}, +if its value and @code{register-alist} are both non-@code{nil}. The +preview is also shown if the user requests help (e.g., by typing the +help character). We recommend that all interactive commands which +read register names use this function. +@end defun + @node Transposition @section Transposition of Text -- 2.11.4.GIT