From 9bd2af866badb59801dd3a81ff63a42a9f8ad97f Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Wed, 27 Apr 2016 20:40:59 +0200 Subject: Clarify doc string of internal compilation function * lisp/progmodes/compile.el (compilation-get-file-structure): Clarify doc string (bug#3137). (cherry picked from commit 123191decb7428db3b32a6c01631fa755088393a) --- lisp/progmodes/compile.el | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index dbda8a9d5b8..f060b571b7c 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -2753,7 +2753,9 @@ FILE should be (FILENAME) or (RELATIVE-FILENAME . DIRNAME). In the former case, FILENAME may be relative or absolute. The file-structure looks like this: - ((FILENAME [DIR-FROM-PREV-MSG]) FMT LINE-STRUCT...)" + ((FILENAME [TRUE-DIRNAME]) FMT ...) + +TRUE-DIRNAME is the `file-truename' of DIRNAME, if given." (or (gethash file compilation-locs) ;; File was not previously encountered, at least not in the form passed. ;; Let's normalize it and look again. @@ -2808,7 +2810,7 @@ The file-structure looks like this: (let ((fs (compilation-get-file-structure file))) (cl-assert (eq fs (gethash file compilation-locs))) (cl-assert (eq fs (gethash (cons (caar fs) (cadr (car fs))) - compilation-locs))) + compilation-locs))) (maphash (lambda (k v) (if (eq v fs) (remhash k compilation-locs))) compilation-locs))) -- cgit v1.2.1 From 3fc1ed8e010fdb8c98ee2aed54f39f7bb52fb2cc Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Wed, 27 Apr 2016 20:48:30 +0200 Subject: Mention `lisp-indent-function' in the lispref manual * doc/lispref/macros.texi (Indenting Macros): Mention `lisp-indent-function' (bug#3393). (cherry picked from commit a1627691a896b2afaa264f93534178bc763564c9) --- doc/lispref/macros.texi | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/lispref/macros.texi b/doc/lispref/macros.texi index 3f9db8ce375..6472bd1b03a 100644 --- a/doc/lispref/macros.texi +++ b/doc/lispref/macros.texi @@ -594,6 +594,11 @@ calls to the macro. An indentation specification is written like this: (declare (indent @var{indent-spec})) @end example +@noindent +@cindex @code{lisp-indent-function} property +This results in the @code{lisp-indent-function} property being set on +the macro name. + @noindent Here are the possibilities for @var{indent-spec}: -- cgit v1.2.1 From 351c079cf69d41b473edba43e0e960bd5a175273 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Thu, 28 Apr 2016 00:53:04 +0200 Subject: Add some concept index entries for custom types * doc/lispref/customize.texi (Composite Types): Add concept index entries for restricted-sexp, radio and choice (bug#7385). (cherry picked from commit 388bb723fa078158d3148de05e942f9c01e95dd8) --- doc/lispref/customize.texi | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/lispref/customize.texi b/doc/lispref/customize.texi index 994c346331f..14e6eb3ab25 100644 --- a/doc/lispref/customize.texi +++ b/doc/lispref/customize.texi @@ -841,6 +841,7 @@ most general last. Here's an example of proper usage: This way, the special value @code{nil} is not treated like other symbols, and symbols are not treated like other Lisp expressions. +@cindex radio, customization types @item (radio @var{element-types}@dots{}) This is similar to @code{choice}, except that the choices are displayed using radio buttons rather than a menu. This has the advantage of @@ -936,6 +937,7 @@ The value must be a list and each element of the list must fit the type list of elements, with @samp{[INS]} and @samp{[DEL]} buttons for adding more elements or removing elements. +@cindex restricted-sexp, customization types @item (restricted-sexp :match-alternatives @var{criteria}) This is the most general composite type construct. The value may be any Lisp object that satisfies one of @var{criteria}. @var{criteria} @@ -1020,6 +1022,7 @@ and whose remaining arguments should be zero or more of @code{foo} and This matches values such as @code{(baz)}, @code{(baz foo)}, @code{(baz bar)} and @code{(baz foo bar)}. +@cindex choice, customization types When the element-type is a @code{choice}, you use @code{:inline} not in the @code{choice} itself, but in (some of) the alternatives of the @code{choice}. For example, to match a list which must start with a -- cgit v1.2.1 From 0a14d84150e7728ff1461d3f25b1b5bdc6e0cf08 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Thu, 28 Apr 2016 13:00:11 +0200 Subject: Clarify some doc strings * lisp/emacs-lisp/syntax.el (syntax-propertize-via-font-lock): Clarify doc string (bug#8693). (syntax-propertize): Clarify doc string. (cherry picked from commit ad3ef417f3c40f086de9c547d6272e5685595e42) --- lisp/emacs-lisp/syntax.el | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/lisp/emacs-lisp/syntax.el b/lisp/emacs-lisp/syntax.el index e20a210de71..33f644191b6 100644 --- a/lisp/emacs-lisp/syntax.el +++ b/lisp/emacs-lisp/syntax.el @@ -272,9 +272,10 @@ Note: back-references in REGEXPs do not work." (cond ,@(nreverse branches)))))) (defun syntax-propertize-via-font-lock (keywords) - "Propertize for syntax in START..END using font-lock syntax. + "Propertize for syntax using font-lock syntax. KEYWORDS obeys the format used in `font-lock-syntactic-keywords'. -The return value is a function suitable for `syntax-propertize-function'." +The return value is a function (with two paremeters, START and +END) suitable for `syntax-propertize-function'." (lambda (start end) (with-no-warnings (let ((font-lock-syntactic-keywords keywords)) @@ -283,7 +284,7 @@ The return value is a function suitable for `syntax-propertize-function'." (setq keywords font-lock-syntactic-keywords))))) (defun syntax-propertize (pos) - "Ensure that syntax-table properties are set until POS." + "Ensure that syntax-table properties are set until POS (a buffer point)." (when (< syntax-propertize--done pos) (if (null syntax-propertize-function) (setq syntax-propertize--done (max (point-max) pos)) -- cgit v1.2.1 From cf33ae0c1286efb7acee8b1c0076048d5d3e3543 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 00:17:50 +0200 Subject: Clarify the `interactive' doc string slightly * src/callint.c (Finteractive): Clarify the doc string slightly (bug#14577). (cherry picked from commit cd993be60da2d12db0d390001373d486c1091c47) --- src/callint.c | 30 +++++++++++++++++------------- 1 file changed, 17 insertions(+), 13 deletions(-) diff --git a/src/callint.c b/src/callint.c index 3bcf2c8476b..e56f7cd1b84 100644 --- a/src/callint.c +++ b/src/callint.c @@ -41,20 +41,24 @@ For example, write (defun foo (arg buf) "Doc string" (interactive "P\\nbbuffer: ") .... ) to make ARG be the raw prefix argument, and set BUF to an existing buffer, when `foo' is called as a command. -The "call" to `interactive' is actually a declaration rather than a function; - it tells `call-interactively' how to read arguments - to pass to the function. -When actually called, `interactive' just returns nil. - -Usually the argument of `interactive' is a string containing a code letter - followed optionally by a prompt. (Some code letters do not use I/O to get - the argument and do not use prompts.) To get several arguments, concatenate - the individual strings, separating them by newline characters. -Prompts are passed to format, and may use % escapes to print the + +The "call" to `interactive' is actually a declaration rather than a + function; it tells `call-interactively' how to read arguments to pass + to the function. When actually called, `interactive' just returns + nil. + +Usually the argument of `interactive' is a string containing a code + letter followed optionally by a prompt. (Some code letters do not + use I/O to get the argument and do not use prompts.) To pass several + arguments to the command, concatenate the individual strings, + separating them by newline characters. + +Prompts are passed to `format', and may use % escapes to print the arguments that have already been read. If the argument is not a string, it is evaluated to get a list of - arguments to pass to the function. -Just `(interactive)' means pass no args when calling interactively. + arguments to pass to the command. +Just `(interactive)' means pass no arguments to the command when + calling interactively. Code letters available are: a -- Function name: symbol with a function definition. @@ -99,7 +103,7 @@ If the string begins with `^' and `shift-select-mode' is non-nil, Emacs first calls the function `handle-shift-selection'. You may use `@', `*', and `^' together. They are processed in the order that they appear, before reading any arguments. -usage: (interactive &optional ARGS) */ +usage: (interactive &optional ARG-DESCRIPTOR) */ attributes: const) (Lisp_Object args) { -- cgit v1.2.1 From de8349e125d24e1e53cdb5c54d45a32582682ff2 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 01:19:49 +0200 Subject: Doc string change to enable-recursive-minibuffers * src/minibuf.c (syms_of_minibuf): Mention minibuffer-depth-indicator-mode in the doc string to enable-recursive-minibuffers (bug#14147). (cherry picked from commit 23ba488a5e8290c4de91e0ff4161641efa364c0d) --- src/minibuf.c | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/minibuf.c b/src/minibuf.c index 238a04a8ad2..d85a7a9b103 100644 --- a/src/minibuf.c +++ b/src/minibuf.c @@ -1966,7 +1966,9 @@ controls the behavior, rather than this variable. */); DEFVAR_BOOL ("enable-recursive-minibuffers", enable_recursive_minibuffers, doc: /* Non-nil means to allow minibuffer commands while in the minibuffer. -This variable makes a difference whenever the minibuffer window is active. */); +This variable makes a difference whenever the minibuffer window is active. +Also see `minibuffer-depth-indicator-mode', which may be handy if this +variable is non-nil. */); enable_recursive_minibuffers = 0; DEFVAR_LISP ("minibuffer-completion-table", Vminibuffer_completion_table, -- cgit v1.2.1 From 3cbc1e342791ce11b1fe2ce9e3d66f7431c656c2 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 14:36:23 +0200 Subject: Change all occurrences of "Mouse-[0-9]" to "mouse-[0-9]" * doc/emacs/*.texi: Change all occurrences of "Mouse-[0-9]" to "mouse-[0-9]". These are case sensitive, and the keys are lower case (bug#14554). (cherry picked from commit e4c26271f2c2fe08f8490e25c63a436ab2a804ca) --- doc/emacs/buffers.texi | 4 +- doc/emacs/building.texi | 46 ++++++++-------- doc/emacs/calendar.texi | 20 +++---- doc/emacs/dired.texi | 4 +- doc/emacs/fixit.texi | 2 +- doc/emacs/frames.texi | 134 ++++++++++++++++++++++----------------------- doc/emacs/help.texi | 8 +-- doc/emacs/killing.texi | 26 ++++----- doc/emacs/macos.texi | 6 +- doc/emacs/maintaining.texi | 8 +-- doc/emacs/mark.texi | 4 +- doc/emacs/mini.texi | 6 +- doc/emacs/misc.texi | 18 +++--- doc/emacs/msdos-xtra.texi | 4 +- doc/emacs/mule.texi | 4 +- doc/emacs/programs.texi | 4 +- doc/emacs/rmail.texi | 4 +- doc/emacs/search.texi | 8 +-- doc/emacs/text.texi | 8 +-- doc/emacs/windows.texi | 14 ++--- doc/lispref/display.texi | 4 +- doc/lispref/text.texi | 42 +++++++------- doc/misc/ebrowse.texi | 10 ++-- doc/misc/efaq.texi | 4 +- doc/misc/idlwave.texi | 14 ++--- doc/misc/info.texi | 16 +++--- doc/misc/mh-e.texi | 44 +++++++-------- doc/misc/sem-user.texi | 4 +- doc/misc/speedbar.texi | 28 +++++----- doc/misc/viper.texi | 14 ++--- doc/misc/widget.texi | 6 +- doc/misc/woman.texi | 8 +-- 32 files changed, 263 insertions(+), 263 deletions(-) diff --git a/doc/emacs/buffers.texi b/doc/emacs/buffers.texi index 1efd1d98d7b..2eb837f1510 100644 --- a/doc/emacs/buffers.texi +++ b/doc/emacs/buffers.texi @@ -699,10 +699,10 @@ C-b}. To customize this buffer list, use the @code{bs} Custom group @cindex mode, MSB @cindex MSB mode @findex mouse-buffer-menu -@kindex C-Down-Mouse-1 +@kindex C-Down-mouse-1 MSB global minor mode (``MSB'' stands for ``mouse select buffer'') provides a different and customizable mouse buffer menu which you may prefer. It replaces the bindings of @code{mouse-buffer-menu}, -normally on @kbd{C-Down-Mouse-1} and @kbd{C-@key{F10}}, and the menu +normally on @kbd{C-Down-mouse-1} and @kbd{C-@key{F10}}, and the menu bar buffer menu. You can customize the menu in the @code{msb} Custom group. diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi index 3fa89d9062d..df0764ee6b7 100644 --- a/doc/emacs/building.texi +++ b/doc/emacs/building.texi @@ -921,23 +921,23 @@ still in the right places. @cindex fringes, for debugging @table @asis -@item @kbd{Mouse-1} (in fringe) +@item @kbd{mouse-1} (in fringe) Set or clear a breakpoint on that line. -@item @kbd{C-Mouse-1} (in fringe) +@item @kbd{C-mouse-1} (in fringe) Enable or disable a breakpoint on that line. -@item @kbd{Mouse-3} (in fringe) +@item @kbd{mouse-3} (in fringe) Continue execution to that line. -@item @kbd{C-Mouse-3} (in fringe) +@item @kbd{C-mouse-3} (in fringe) Jump to that line. @end table - On a graphical display, you can click @kbd{Mouse-1} in the fringe of + On a graphical display, you can click @kbd{mouse-1} in the fringe of a source buffer, to set a breakpoint on that line (@pxref{Fringes}). A red dot appears in the fringe, where you clicked. If a breakpoint -already exists there, the click removes it. A @kbd{C-Mouse-1} click +already exists there, the click removes it. A @kbd{C-mouse-1} click enables or disables an existing breakpoint; a breakpoint that is disabled, but not unset, is indicated by a gray dot. @@ -949,10 +949,10 @@ of the window. Disabled breakpoints are indicated with @samp{b}. A solid arrow in the left fringe of a source buffer indicates the line of the innermost frame where the debugged program has stopped. A hollow arrow indicates the current execution line of a higher-level -frame. If you drag the arrow in the fringe with @kbd{Mouse-1}, that +frame. If you drag the arrow in the fringe with @kbd{mouse-1}, that causes execution to advance to the line where you release the button. -Alternatively, you can click @kbd{Mouse-3} in the fringe to advance to -that line. You can click @kbd{C-Mouse-3} in the fringe to jump to +Alternatively, you can click @kbd{mouse-3} in the fringe to advance to +that line. You can click @kbd{C-mouse-3} in the fringe to jump to that line without executing the intermediate lines. This command allows you to go backwards, which can be useful for running through code that has already executed, in order to examine its execution in @@ -986,15 +986,15 @@ Delete the current breakpoint (@code{gdb-delete-breakpoint}). Visit the source line for the current breakpoint (@code{gdb-goto-breakpoint}). -@item Mouse-2 -@kindex Mouse-2 @r{(GDB Breakpoints buffer)} +@item mouse-2 +@kindex mouse-2 @r{(GDB Breakpoints buffer)} Visit the source line for the breakpoint you click on. @end table @vindex gdb-show-threads-by-default When @code{gdb-many-windows} is non-@code{nil}, the GDB Breakpoints buffer shares its window with the GDB Threads buffer. To switch from -one to the other click with @kbd{Mouse-1} on the relevant button in +one to the other click with @kbd{mouse-1} on the relevant button in the header line. If @code{gdb-show-threads-by-default} is non-@code{nil}, the GDB Threads buffer is the one shown by default. @@ -1006,7 +1006,7 @@ non-@code{nil}, the GDB Threads buffer is the one shown by default. debugged program. @xref{Threads, Threads, Debugging programs with multiple threads, gdb, The GNU debugger}. To select a thread, move point there and press @key{RET} (@code{gdb-select-thread}), or click on -it with @kbd{Mouse-2}. This also displays the associated source +it with @kbd{mouse-2}. This also displays the associated source buffer, and updates the contents of the other GDB buffers. You can customize variables under @code{gdb-buffers} group to select @@ -1087,7 +1087,7 @@ debugger}. arrow in the fringe. On text terminals, or when fringes are disabled, the selected stack frame is displayed in reverse contrast. To select a stack frame, move point in its line and type @key{RET} -(@code{gdb-frames-select}), or click @kbd{Mouse-2} on it. Doing so +(@code{gdb-frames-select}), or click @kbd{mouse-2} on it. Doing so also updates the Locals buffer @ifnottex (@pxref{Other GDB Buffers}). @@ -1104,19 +1104,19 @@ also updates the Locals buffer This buffer displays the values of local variables of the current frame for simple data types (@pxref{Frame Info, Frame Info, Information on a frame, gdb, The GNU debugger}). Press @key{RET} or -click @kbd{Mouse-2} on the value if you want to edit it. +click @kbd{mouse-2} on the value if you want to edit it. Arrays and structures display their type only. With GDB 6.4 or later, you can examine the value of the local variable at point by typing -@key{RET}, or with a @kbd{Mouse-2} click. With earlier versions of -GDB, use @key{RET} or @kbd{Mouse-2} on the type description +@key{RET}, or with a @kbd{mouse-2} click. With earlier versions of +GDB, use @key{RET} or @kbd{mouse-2} on the type description (@samp{[struct/union]} or @samp{[array]}). @xref{Watch Expressions}. @item Registers Buffer @findex toggle-gdb-all-registers This buffer displays the values held by the registers (@pxref{Registers,,, gdb, The GNU debugger}). Press @key{RET} or -click @kbd{Mouse-2} on a register if you want to edit its value. With +click @kbd{mouse-2} on a register if you want to edit its value. With GDB 6.4 or later, recently changed register values display with @code{font-lock-warning-face}. @@ -1129,17 +1129,17 @@ the fringe or margin. @item Memory Buffer The memory buffer lets you examine sections of program memory (@pxref{Memory, Memory, Examining memory, gdb, The GNU debugger}). -Click @kbd{Mouse-1} on the appropriate part of the header line to +Click @kbd{mouse-1} on the appropriate part of the header line to change the starting address or number of data items that the buffer displays. Alternatively, use @kbd{S} or @kbd{N} respectively. Click -@kbd{Mouse-3} on the header line to select the display format or unit +@kbd{mouse-3} on the header line to select the display format or unit size for these data items. @end table When @code{gdb-many-windows} is non-@code{nil}, the locals buffer shares its window with the registers buffer, just like breakpoints and threads buffers. To switch from one to the other, click with -@kbd{Mouse-1} on the relevant button in the header line. +@kbd{mouse-1} on the relevant button in the header line. @node Watch Expressions @subsubsection Watch Expressions @@ -1163,7 +1163,7 @@ name and type otherwise. Root expressions also display the frame address as a tooltip to help identify the frame in which they were defined. - To expand or contract a complex data type, click @kbd{Mouse-2} or + To expand or contract a complex data type, click @kbd{mouse-2} or press @key{SPC} on the tag to the left of the expression. Emacs asks for confirmation before expanding the expression if its number of immediate children exceeds the value of the variable @@ -1178,7 +1178,7 @@ expression in the speedbar and type @kbd{D} (@code{gdb-var-delete}). @findex gdb-edit-value To edit a variable with a simple data type, or a simple element of a complex data type, move point there in the speedbar and type @key{RET} -(@code{gdb-edit-value}). Or you can click @kbd{Mouse-2} on a value to +(@code{gdb-edit-value}). Or you can click @kbd{mouse-2} on a value to edit it. Either way, this reads the new value using the minibuffer. @vindex gdb-show-changed-values diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi index 0fc18fcbbcf..60d323be840 100644 --- a/doc/emacs/calendar.texi +++ b/doc/emacs/calendar.texi @@ -19,8 +19,8 @@ prompts you for the month and year to be the center of the three-month calendar. The calendar uses its own buffer, whose major mode is Calendar mode. - @kbd{Mouse-3} in the calendar brings up a menu of operations on a -particular date; @kbd{Mouse-2} brings up a menu of commonly used + @kbd{mouse-3} in the calendar brings up a menu of operations on a +particular date; @kbd{mouse-2} brings up a menu of commonly used calendar features that are independent of any particular date. To exit the calendar, type @kbd{q}. @@ -460,7 +460,7 @@ to. and can display them. You can add your own holidays to the default list. @table @kbd -@item Mouse-3 Holidays +@item mouse-3 Holidays @itemx h Display holidays for the selected date (@code{calendar-cursor-holidays}). @@ -483,7 +483,7 @@ List holidays in another window for a specified range of years. @vindex calendar-view-holidays-initially-flag To see if any holidays fall on a given date, position point on that date in the calendar window and use the @kbd{h} command. Alternatively, -click on that date with @kbd{Mouse-3} and then choose @kbd{Holidays} +click on that date with @kbd{mouse-3} and then choose @kbd{Holidays} from the menu that appears. Either way, this displays the holidays for that date, in the echo area if they fit there, otherwise in a separate window. @@ -548,7 +548,7 @@ practice}, not historical fact. For example Veteran's Day began in times of sunrise and sunset for any date. @table @kbd -@item Mouse-3 Sunrise/sunset +@item mouse-3 Sunrise/sunset @itemx S Display times of sunrise and sunset for the selected date (@code{calendar-sunrise-sunset}). @@ -565,7 +565,7 @@ Display times of sunrise and sunset for the selected month. @findex sunrise-sunset Within the calendar, to display the @emph{local times} of sunrise and sunset in the echo area, move point to the date you want, and type -@kbd{S}. Alternatively, click @kbd{Mouse-3} on the date, then choose +@kbd{S}. Alternatively, click @kbd{mouse-3} on the date, then choose @samp{Sunrise/sunset} from the menu that appears. The command @kbd{M-x sunrise-sunset} is available outside the calendar to display this information for today's date or a specified date. To specify a date @@ -777,7 +777,7 @@ in various other calendar systems: @table @kbd @kindex p @r{(Calendar mode)} @findex calendar-print-other-dates -@item Mouse-3 Other calendars +@item mouse-3 Other calendars @itemx p o Display the selected date in various other calendars. (@code{calendar-print-other-dates}). @@ -831,7 +831,7 @@ Display Mayan date for selected day (@code{calendar-mayan-print-date}). appropriate command starting with @kbd{p} from the table above. The prefix @kbd{p} is a mnemonic for ``print'', since Emacs ``prints'' the equivalent date in the echo area. @kbd{p o} displays the -date in all forms known to Emacs. You can also use @kbd{Mouse-3} and +date in all forms known to Emacs. You can also use @kbd{mouse-3} and then choose @kbd{Other calendars} from the menu that appears. This displays the equivalent forms of the date in all the calendars Emacs understands, in the form of a menu. (Choosing an alternative from @@ -1020,7 +1020,7 @@ it. You can also view today's events outside of Calendar mode. In the following, key bindings refer to the Calendar buffer. @table @kbd -@item Mouse-3 Diary +@item mouse-3 Diary @itemx d Display all diary entries for the selected date (@code{diary-view-entries}). @@ -1058,7 +1058,7 @@ entries for that many successive days. Thus, @kbd{2 d} displays all the entries for the selected date and for the following day. Another way to display the diary entries for a date is to click -@kbd{Mouse-3} on the date, and then choose @kbd{Diary entries} from +@kbd{mouse-3} on the date, and then choose @kbd{Diary entries} from the menu that appears. If the variable @code{calendar-view-diary-initially-flag} is non-@code{nil}, creating the calendar lists the diary entries for the current date (provided the diff --git a/doc/emacs/dired.texi b/doc/emacs/dired.texi index ea48a26500c..089b1091618 100644 --- a/doc/emacs/dired.texi +++ b/doc/emacs/dired.texi @@ -353,8 +353,8 @@ file. @xref{Windows}. Visit the file described on the current line, and display the buffer in another window, but do not select that window (@code{dired-display-file}). -@item Mouse-1 -@itemx Mouse-2 +@item mouse-1 +@itemx mouse-2 @findex dired-mouse-find-file-other-window Visit the file whose name you clicked on (@code{dired-mouse-find-file-other-window}). This uses another window diff --git a/doc/emacs/fixit.texi b/doc/emacs/fixit.texi index b398a7dbfb8..584efc68116 100644 --- a/doc/emacs/fixit.texi +++ b/doc/emacs/fixit.texi @@ -408,7 +408,7 @@ buffers, add @code{flyspell-mode} to @code{text-mode-hook}. @findex flyspell-auto-correct-word @findex flyspell-correct-word-before-point When Flyspell mode highlights a word as misspelled, you can click on -it with @kbd{Mouse-2} (@code{flyspell-correct-word}) to display a menu +it with @kbd{mouse-2} (@code{flyspell-correct-word}) to display a menu of possible corrections and actions. In addition, @kbd{C-.} or @kbd{@key{ESC}-@key{TAB}} (@code{flyspell-auto-correct-word}) will propose various successive corrections for the word at point, and diff --git a/doc/emacs/frames.texi b/doc/emacs/frames.texi index 383ae7fd6ee..23ccd6a8f41 100644 --- a/doc/emacs/frames.texi +++ b/doc/emacs/frames.texi @@ -70,22 +70,22 @@ for doing so on MS-DOS). Menus are supported on all text terminals. @cindex mouse buttons (what they do) @cindex mouse, selecting text using -@kindex Mouse-1 -@kindex Mouse-2 -@kindex Mouse-3 +@kindex mouse-1 +@kindex mouse-2 +@kindex mouse-3 @table @kbd -@item Mouse-1 +@item mouse-1 Move point to where you click (@code{mouse-set-point}). -@item Drag-Mouse-1 +@item Drag-mouse-1 Activate the region around the text selected by dragging, and put the text in the primary selection (@code{mouse-set-region}). -@item Mouse-2 +@item mouse-2 Move point to where you click, and insert the contents of the primary selection there (@code{mouse-yank-primary}). -@item Mouse-3 +@item mouse-3 If the region is active, move the nearer end of the region to the click position; otherwise, set mark at the current value of point and point at the click position. Save the resulting region in the kill @@ -94,7 +94,7 @@ ring; on a second click, kill it (@code{mouse-save-then-kill}). @findex mouse-set-point The most basic mouse command is @code{mouse-set-point}, which is -invoked by clicking with the left mouse button, @kbd{Mouse-1}, in the +invoked by clicking with the left mouse button, @kbd{mouse-1}, in the text area of a window. This moves point to the position where you clicked. If that window was not the selected window, it becomes the selected window. @@ -110,7 +110,7 @@ the window and sets the cursor position. @cindex mouse, dragging @findex mouse-set-region - Holding down @kbd{Mouse-1} and dragging the mouse over a stretch + Holding down @kbd{mouse-1} and dragging the mouse over a stretch of text activates the region around that text (@code{mouse-set-region}), placing the mark where you started holding down the mouse button, and point where you release it (@pxref{Mark}). @@ -132,49 +132,49 @@ on how far away from the window edge the mouse has gone; the variable @findex mouse-yank-primary @findex mouse-yank-at-click - Clicking with the middle mouse button, @kbd{Mouse-2}, moves point to + Clicking with the middle mouse button, @kbd{mouse-2}, moves point to the position where you clicked and inserts the contents of the primary selection (@code{mouse-yank-primary}). @xref{Primary Selection}. This behavior is consistent with other X applications. Alternatively, -you can rebind @kbd{Mouse-2} to @code{mouse-yank-at-click}, which +you can rebind @kbd{mouse-2} to @code{mouse-yank-at-click}, which performs a yank at the position you click. @vindex mouse-yank-at-point If you change the variable @code{mouse-yank-at-point} to a -non-@code{nil} value, @kbd{Mouse-2} does not move point; it inserts +non-@code{nil} value, @kbd{mouse-2} does not move point; it inserts the text at point, regardless of where you clicked or even which of the frame's windows you clicked on. This variable affects both @code{mouse-yank-primary} and @code{mouse-yank-at-click}. @findex mouse-save-then-kill - Clicking with the right mouse button, @kbd{Mouse-3}, runs the + Clicking with the right mouse button, @kbd{mouse-3}, runs the command @code{mouse-save-then-kill}. This performs several actions depending on where you click and the status of the region: @itemize @bullet @item -If no region is active, clicking @kbd{Mouse-3} activates the region, +If no region is active, clicking @kbd{mouse-3} activates the region, placing the mark where point was and point at the clicked position. @item -If a region is active, clicking @kbd{Mouse-3} adjusts the nearer end +If a region is active, clicking @kbd{mouse-3} adjusts the nearer end of the region by moving it to the clicked position. The adjusted region's text is copied to the kill ring; if the text in the original region was already on the kill ring, it replaces it there. @item If you originally specified the region using a double or triple -@kbd{Mouse-1}, so that the region is defined to consist of entire +@kbd{mouse-1}, so that the region is defined to consist of entire words or lines (@pxref{Word and Line Mouse}), then adjusting the -region with @kbd{Mouse-3} also proceeds by entire words or lines. +region with @kbd{mouse-3} also proceeds by entire words or lines. @item -If you use @kbd{Mouse-3} a second time consecutively, at the same +If you use @kbd{mouse-3} a second time consecutively, at the same place, that kills the region already selected. Thus, the simplest way -to kill text with the mouse is to click @kbd{Mouse-1} at one end, then -click @kbd{Mouse-3} twice at the other end. To copy the text into the -kill ring without deleting it from the buffer, press @kbd{Mouse-3} -just once---or just drag across the text with @kbd{Mouse-1}. Then you +to kill text with the mouse is to click @kbd{mouse-1} at one end, then +click @kbd{mouse-3} twice at the other end. To copy the text into the +kill ring without deleting it from the buffer, press @kbd{mouse-3} +just once---or just drag across the text with @kbd{mouse-1}. Then you can copy it elsewhere by yanking it. @end itemize @@ -209,12 +209,12 @@ speed is linked to how fast you move the wheel. @node Word and Line Mouse @section Mouse Commands for Words and Lines - These variants of @kbd{Mouse-1} select entire words or lines at a + These variants of @kbd{mouse-1} select entire words or lines at a time. Emacs activates the region around the selected text, which is also copied to the kill ring. @table @kbd -@item Double-Mouse-1 +@item Double-mouse-1 Select the text around the word which you click on. Double-clicking on a character with symbol syntax (such as @@ -226,20 +226,20 @@ ends. Double-clicking on a character with string-delimiter syntax constant (Emacs uses heuristics to figure out whether that character is the beginning or the end of it). -@item Double-Drag-Mouse-1 +@item Double-Drag-mouse-1 Select the text you drag across, in the form of whole words. -@item Triple-Mouse-1 +@item Triple-mouse-1 Select the line you click on. -@item Triple-Drag-Mouse-1 +@item Triple-Drag-mouse-1 Select the text you drag across, in the form of whole lines. @end table @node Mouse References @section Following References with the Mouse -@kindex Mouse-1 @r{(on buttons)} -@kindex Mouse-2 @r{(on buttons)} +@kindex mouse-1 @r{(on buttons)} +@kindex mouse-2 @r{(on buttons)} @cindex hyperlinks @cindex links @cindex text buttons @@ -256,14 +256,14 @@ cursor changes and the button lights up. If you change the variable highlighting. You can activate a button by moving point to it and typing -@key{RET}, or by clicking either @kbd{Mouse-1} or @kbd{Mouse-2} on the +@key{RET}, or by clicking either @kbd{mouse-1} or @kbd{mouse-2} on the button. For example, in a Dired buffer, each file name is a button; activating it causes Emacs to visit that file (@pxref{Dired}). In a @file{*Compilation*} buffer, each error message is a button, and activating it visits the source code for that error (@pxref{Compilation}). - Although clicking @kbd{Mouse-1} on a button usually activates the + Although clicking @kbd{mouse-1} on a button usually activates the button, if you hold the mouse button down for a period of time before releasing it (specifically, for more than 450 milliseconds), then Emacs moves point where you clicked, without activating the button. @@ -271,20 +271,20 @@ In this way, you can use the mouse to move point over a button without activating it. Dragging the mouse over or onto a button has its usual behavior of setting the region, and does not activate the button. - You can change how @kbd{Mouse-1} applies to buttons by customizing + You can change how @kbd{mouse-1} applies to buttons by customizing the variable @code{mouse-1-click-follows-link}. If the value is a positive integer, that determines how long you need to hold the mouse button down for, in milliseconds, to cancel button activation; the default is 450, as described in the previous paragraph. If the value -is @code{nil}, @kbd{Mouse-1} just sets point where you clicked, and +is @code{nil}, @kbd{mouse-1} just sets point where you clicked, and does not activate buttons. If the value is @code{double}, double clicks activate buttons but single clicks just set point. @vindex mouse-1-click-in-non-selected-windows - Normally, @kbd{Mouse-1} on a button activates the button even if it + Normally, @kbd{mouse-1} on a button activates the button even if it is in a non-selected window. If you change the variable @code{mouse-1-click-in-non-selected-windows} to @code{nil}, -@kbd{Mouse-1} on a button in an unselected window moves point to the +@kbd{mouse-1} on a button in an unselected window moves point to the clicked position and selects that window, without activating the button. @@ -295,21 +295,21 @@ button. bring up menus. @table @kbd -@item C-Mouse-1 -@kindex C-Mouse-1 +@item C-mouse-1 +@kindex C-mouse-1 This menu is for selecting a buffer. The MSB (``mouse select buffer'') global minor mode makes this menu smarter and more customizable. @xref{Buffer Menus}. -@item C-Mouse-2 -@kindex C-Mouse-2 +@item C-mouse-2 +@kindex C-mouse-2 This menu contains entries for examining faces and other text properties, and well as for setting them (the latter is mainly useful when editing enriched text; @pxref{Enriched Text}). -@item C-Mouse-3 -@kindex C-Mouse-3 +@item C-mouse-3 +@kindex C-mouse-3 This menu is mode-specific. For most modes if Menu-bar mode is on, this menu has the same items as all the mode-specific menu-bar menus put together. Some modes may specify a different menu for this @@ -318,15 +318,15 @@ which would be present in the menu bar---not just the mode-specific ones---so that you can access them without having to display the menu bar. -@item S-Mouse-1 +@item S-mouse-1 This menu is for changing the default face within the window's buffer. @xref{Text Scale}. @end table - Some graphical applications use @kbd{Mouse-3} for a mode-specific -menu. If you prefer @kbd{Mouse-3} in Emacs to bring up such a menu + Some graphical applications use @kbd{mouse-3} for a mode-specific +menu. If you prefer @kbd{mouse-3} in Emacs to bring up such a menu instead of running the @code{mouse-save-then-kill} command, rebind -@kbd{Mouse-3} by adding the following line to your init file +@kbd{mouse-3} by adding the following line to your init file (@pxref{Init Rebinding}): @c FIXME: `mouse-popup-menubar-stuff' is obsolete since 23.1. @@ -349,32 +349,32 @@ the special bindings will be displayed (@pxref{Tooltips}). This section's commands do not apply in those areas. @table @kbd -@item Mouse-1 -@kindex Mouse-1 @r{(mode line)} -@kbd{Mouse-1} on a mode line selects the window it belongs to. By -dragging @kbd{Mouse-1} on the mode line, you can move it, thus +@item mouse-1 +@kindex mouse-1 @r{(mode line)} +@kbd{mouse-1} on a mode line selects the window it belongs to. By +dragging @kbd{mouse-1} on the mode line, you can move it, thus changing the height of the windows above and below. Changing heights with the mouse in this way never deletes windows, it just refuses to make any window smaller than the minimum height. -@item Mouse-2 -@kindex Mouse-2 @r{(mode line)} -@kbd{Mouse-2} on a mode line expands that window to fill its frame. +@item mouse-2 +@kindex mouse-2 @r{(mode line)} +@kbd{mouse-2} on a mode line expands that window to fill its frame. -@item Mouse-3 -@kindex Mouse-3 @r{(mode line)} -@kbd{Mouse-3} on a mode line deletes the window it belongs to. If the +@item mouse-3 +@kindex mouse-3 @r{(mode line)} +@kbd{mouse-3} on a mode line deletes the window it belongs to. If the frame has only one window, it does nothing. -@item C-Mouse-2 +@item C-mouse-2 @kindex C-mouse-2 @r{(mode line)} -@kbd{C-Mouse-2} on a mode line splits that window, producing two +@kbd{C-mouse-2} on a mode line splits that window, producing two side-by-side windows with the boundary running through the click position (@pxref{Split Window}). @end table -@kindex Mouse-1 @r{(scroll bar)} - Furthermore, by clicking and dragging @kbd{Mouse-1} on the divider +@kindex mouse-1 @r{(scroll bar)} + Furthermore, by clicking and dragging @kbd{mouse-1} on the divider between two side-by-side mode lines, you can move the vertical boundary to the left or right. @@ -919,17 +919,17 @@ those are drawn by the toolkit and not directly by Emacs. @cindex Vertical Scroll Bar On graphical displays, there is a @dfn{vertical scroll bar} on the -side of each Emacs window. Clicking @kbd{Mouse-1} on the scroll bar's +side of each Emacs window. Clicking @kbd{mouse-1} on the scroll bar's up and down buttons scrolls the window by one line at a time. Clicking -@kbd{Mouse-1} above or below the scroll bar's inner box scrolls the +@kbd{mouse-1} above or below the scroll bar's inner box scrolls the window by nearly the entire height of the window, like @kbd{M-v} and @kbd{C-v} respectively (@pxref{Moving Point}). Dragging the inner box scrolls continuously. If Emacs is compiled on the X Window System without X toolkit -support, the scroll bar behaves differently. Clicking @kbd{Mouse-1} +support, the scroll bar behaves differently. Clicking @kbd{mouse-1} anywhere on the scroll bar scrolls forward like @kbd{C-v}, while -@kbd{Mouse-3} scrolls backward like @kbd{M-v}. Clicking @kbd{Mouse-2} +@kbd{mouse-3} scrolls backward like @kbd{M-v}. Clicking @kbd{mouse-2} in the scroll bar lets you drag the inner box up and down. @findex scroll-bar-mode @@ -975,8 +975,8 @@ when the entire buffer is visible. @cindex Horizontal Scroll Bar mode On graphical displays with toolkit support, Emacs may also supply a @dfn{horizontal scroll bar} on the bottom of each window. Clicking -@kbd{Mouse-1} on the that scroll bar's left and right buttons scrolls -the window horizontally by one column at a time. Clicking @kbd{Mouse-1} +@kbd{mouse-1} on the that scroll bar's left and right buttons scrolls +the window horizontally by one column at a time. Clicking @kbd{mouse-1} on the left or right of the scroll bar's inner box scrolls the window by four columns. Dragging the inner box scrolls the window continuously. @@ -1066,11 +1066,11 @@ argument is positive, off if the argument is not positive. To control the use of menu bars at startup, customize the variable @code{menu-bar-mode}. -@kindex C-Mouse-3 @r{(when menu bar is disabled)} +@kindex C-mouse-3 @r{(when menu bar is disabled)} Expert users often turn off the menu bar, especially on text terminals, where this makes one additional line available for text. If the menu bar is off, you can still pop up a menu of its contents -with @kbd{C-Mouse-3} on a display which supports pop-up menus. +with @kbd{C-mouse-3} on a display which supports pop-up menus. @xref{Menu Mouse Clicks}. @xref{Menu Bar}, for information on how to invoke commands with the diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi index 172d058f857..4b7b7fc6315 100644 --- a/doc/emacs/help.texi +++ b/doc/emacs/help.texi @@ -343,7 +343,7 @@ invoke it with. In our example, it would say that you can invoke For more information about a function definition, variable or symbol property listed in an apropos buffer, you can click on it with -@kbd{Mouse-1} or @kbd{Mouse-2}, or move there and type @key{RET}. +@kbd{mouse-1} or @kbd{mouse-2}, or move there and type @key{RET}. When you specify more than one word in the apropos pattern, a name must contain at least two of the words in order to match. Thus, if @@ -404,8 +404,8 @@ Follow a cross reference at point (@code{help-follow}). Move point forward to the next hyperlink (@code{forward-button}). @item S-@key{TAB} Move point back to the previous hyperlink (@code{backward-button}). -@item Mouse-1 -@itemx Mouse-2 +@item mouse-1 +@itemx mouse-2 Follow a hyperlink that you click on. @item C-c C-c Show all documentation about the symbol at point @@ -427,7 +427,7 @@ Go back to the previous help topic (@code{help-go-back}). appears in the documentation in the help buffer, it is normally an underlined @dfn{hyperlink}. To view the associated documentation, move point there and type @key{RET} (@code{help-follow}), or click on -the hyperlink with @kbd{Mouse-1} or @kbd{Mouse-2}. Doing so replaces +the hyperlink with @kbd{mouse-1} or @kbd{mouse-2}. Doing so replaces the contents of the help buffer; to retrace your steps, type @kbd{C-c C-b} (@code{help-go-back}). While retracing your steps, you can go forward by using @kbd{C-c C-b} (@code{help-go-forward}). diff --git a/doc/emacs/killing.texi b/doc/emacs/killing.texi index dd3671c95f1..107adb99ec4 100644 --- a/doc/emacs/killing.texi +++ b/doc/emacs/killing.texi @@ -587,9 +587,9 @@ you can access it using the following Emacs commands: @table @kbd @findex mouse-set-secondary -@kindex M-Drag-Mouse-1 +@kindex M-Drag-mouse-1 @cindex secondary-selection face -@item M-Drag-Mouse-1 +@item M-Drag-mouse-1 Set the secondary selection, with one end at the place where you press down the button, and the other end at the place where you release it (@code{mouse-set-secondary}). The selected text is highlighted, using @@ -600,31 +600,31 @@ window, just like @code{mouse-set-region} (@pxref{Mouse Commands}). This command does not alter the kill ring. @findex mouse-start-secondary -@kindex M-Mouse-1 -@item M-Mouse-1 +@kindex M-mouse-1 +@item M-mouse-1 Set one endpoint for the @dfn{secondary selection} (@code{mouse-start-secondary}). @findex mouse-secondary-save-then-kill -@kindex M-Mouse-3 -@item M-Mouse-3 +@kindex M-mouse-3 +@item M-mouse-3 Set the secondary selection, with one end at the position clicked and -the other at the position specified with @kbd{M-Mouse-1} +the other at the position specified with @kbd{M-mouse-1} (@code{mouse-secondary-save-then-kill}). This also puts the selected -text in the kill ring. A second @kbd{M-Mouse-3} at the same place +text in the kill ring. A second @kbd{M-mouse-3} at the same place kills the secondary selection just made. @findex mouse-yank-secondary -@kindex M-Mouse-2 -@item M-Mouse-2 +@kindex M-mouse-2 +@item M-mouse-2 Insert the secondary selection where you click, placing point at the end of the yanked text (@code{mouse-yank-secondary}). @end table -Double or triple clicking of @kbd{M-Mouse-1} operates on words and -lines, much like @kbd{Mouse-1}. +Double or triple clicking of @kbd{M-mouse-1} operates on words and +lines, much like @kbd{mouse-1}. -If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-Mouse-2} yanks +If @code{mouse-yank-at-point} is non-@code{nil}, @kbd{M-mouse-2} yanks at point. Then it does not matter precisely where you click, or even which of the frame's windows you click on. @xref{Mouse Commands}. diff --git a/doc/emacs/macos.texi b/doc/emacs/macos.texi index 71d2e99950c..b0597dc2499 100644 --- a/doc/emacs/macos.texi +++ b/doc/emacs/macos.texi @@ -51,9 +51,9 @@ modifier keys; a value to @code{left} means be the same key as @code{ns-alternate-modifier}; a value of @code{none} tells Emacs to ignore them. - @kbd{S-Mouse-1} adjusts the region to the click position, -just like @kbd{Mouse-3} (@code{mouse-save-then-kill}); it does not pop -up a menu for changing the default face, as @kbd{S-Mouse-1} normally + @kbd{S-mouse-1} adjusts the region to the click position, +just like @kbd{mouse-3} (@code{mouse-save-then-kill}); it does not pop +up a menu for changing the default face, as @kbd{S-mouse-1} normally does (@pxref{Text Scale}). This change makes Emacs behave more like other Mac / GNUstep applications. diff --git a/doc/emacs/maintaining.texi b/doc/emacs/maintaining.texi index 797b53f16e8..aca29910b7d 100644 --- a/doc/emacs/maintaining.texi +++ b/doc/emacs/maintaining.texi @@ -432,7 +432,7 @@ to the master repository. On a graphical display, you can move the mouse over this mode line indicator to pop up a tool-tip, which displays a more verbose -description of the version control status. Pressing @kbd{Mouse-1} +description of the version control status. Pressing @kbd{mouse-1} over the indicator pops up a menu of VC commands, identical to @samp{Tools / Version Control} on the menu bar. @@ -1335,7 +1335,7 @@ their single-buffer counterparts (@pxref{Search}). @cindex stashes in version control @cindex shelves in version control The above commands are also available via the menu bar, and via a -context menu invoked by @kbd{Mouse-2}. Furthermore, some VC backends +context menu invoked by @kbd{mouse-2}. Furthermore, some VC backends use the menu to provide extra backend-specific commands. For example, Git and Bazaar allow you to manipulate @dfn{stashes} and @dfn{shelves} (where are a way to temporarily put aside uncommitted changes, and @@ -1806,7 +1806,7 @@ object-oriented language, or if there's a function and a variable by the same name), the command shows the candidate definitions in a @file{*xref*} buffer, together with the files in which these definitions are found. Selecting one of these candidates by typing -@kbd{@key{RET}} or clicking @kbd{Mouse-2} will pop a buffer showing +@kbd{@key{RET}} or clicking @kbd{mouse-2} will pop a buffer showing the corresponding definition. When entering the identifier argument to @kbd{M-.}, the usual @@ -1858,7 +1858,7 @@ the special XREF mode: @table @kbd @item @key{RET} -@itemx Mouse-2 +@itemx mouse-2 Display the reference on the current line and bury the @file{*xref*} buffer. @item n diff --git a/doc/emacs/mark.texi b/doc/emacs/mark.texi index dd47532e7ed..fdba0a47461 100644 --- a/doc/emacs/mark.texi +++ b/doc/emacs/mark.texi @@ -69,9 +69,9 @@ The same. @item C-x C-x Set the mark at point, and activate it; then move point where the mark used to be (@code{exchange-point-and-mark}). -@item Drag-Mouse-1 +@item Drag-mouse-1 Set point and the mark around the text you drag across. -@item Mouse-3 +@item mouse-3 Set the mark at point, then move point to where you click (@code{mouse-save-then-kill}). @item @samp{Shifted cursor motion keys} diff --git a/doc/emacs/mini.texi b/doc/emacs/mini.texi index 6ab716d909a..be4206cb60c 100644 --- a/doc/emacs/mini.texi +++ b/doc/emacs/mini.texi @@ -219,7 +219,7 @@ set the variable @code{enable-recursive-minibuffers} to @code{t}. @findex minibuffer-inactive-mode When not active, the minibuffer is in @code{minibuffer-inactive-mode}, -and clicking @kbd{Mouse-1} there shows the @file{*Messages*} buffer. +and clicking @kbd{mouse-1} there shows the @file{*Messages*} buffer. If you use a dedicated frame for minibuffers, Emacs also recognizes certain keys there, for example @kbd{n} to make a new frame. @@ -337,8 +337,8 @@ used with the completion list: @table @kbd @findex mouse-choose-completion -@item Mouse-1 -@itemx Mouse-2 +@item mouse-1 +@itemx mouse-2 Clicking mouse button 1 or 2 on a completion alternative chooses it (@code{mouse-choose-completion}). diff --git a/doc/emacs/misc.texi b/doc/emacs/misc.texi index b5a21500fcb..af2b6acd8a4 100644 --- a/doc/emacs/misc.texi +++ b/doc/emacs/misc.texi @@ -1217,7 +1217,7 @@ submit the copy as input with @key{RET}. If you wish, you can edit the copy before resubmitting it. If you use this command on an output line, it copies that line to the end of the buffer. -@item Mouse-2 +@item mouse-2 If @code{comint-use-prompt-regexp} is @code{nil} (the default), copy the old input command that you click on, inserting the copy at the end of the buffer (@code{comint-insert-input}). If @@ -1226,7 +1226,7 @@ not over old input, just yank as usual. @end table Moving to a previous input and then copying it with @kbd{C-c -@key{RET}} or @kbd{Mouse-2} produces the same results---the same +@key{RET}} or @kbd{mouse-2} produces the same results---the same buffer contents---that you would get by using @kbd{M-p} enough times to fetch that previous input from the history list. However, @kbd{C-c @key{RET}} copies the text from the buffer, which can be different @@ -2097,7 +2097,7 @@ You can also type @kbd{M-x pr-interface @key{RET}}; this creates a @file{*Printing Interface*} buffer, similar to a customization buffer, where you can set the printing options. After selecting what and how to print, you start the print job using the @samp{Print} button (click -@kbd{Mouse-2} on it, or move point over it and type @key{RET}). For +@kbd{mouse-2} on it, or move point over it and type @key{RET}). For further information on the various options, use the @samp{Interface Help} button. @@ -2606,8 +2606,8 @@ typing @kbd{M-x goto-address-mode}. When this buffer-local minor mode is enabled, it finds all the URLs in the buffer, highlights them, and turns them into clickable buttons. You can follow the URL by typing @kbd{C-c @key{RET}} (@code{goto-address-at-point}) while point is on -its text; or by clicking with @kbd{Mouse-2}, or by clicking -@kbd{Mouse-1} quickly (@pxref{Mouse References}). Following a URL is +its text; or by clicking with @kbd{mouse-2}, or by clicking +@kbd{mouse-1} quickly (@pxref{Mouse References}). Following a URL is done by calling @code{browse-url} as a subroutine (@pxref{Browse-URL}). @@ -2680,12 +2680,12 @@ point (@code{dired-at-point}). @code{ffap-dired-other-frame}, analogous to @code{dired-other-frame}. @item M-x ffap-next Search buffer for next file name or URL, then find that file or URL. -@item S-Mouse-3 -@kindex S-Mouse-3 @r{(FFAP)} +@item S-mouse-3 +@kindex S-mouse-3 @r{(FFAP)} @code{ffap-at-mouse} finds the file guessed from text around the position of a mouse click. -@item C-S-Mouse-3 -@kindex C-S-Mouse-3 @r{(FFAP)} +@item C-S-mouse-3 +@kindex C-S-mouse-3 @r{(FFAP)} Display a menu of files and URLs mentioned in current buffer, then find the one you select (@code{ffap-menu}). @end table diff --git a/doc/emacs/msdos-xtra.texi b/doc/emacs/msdos-xtra.texi index 45edd6cb7f9..89c14d23914 100644 --- a/doc/emacs/msdos-xtra.texi +++ b/doc/emacs/msdos-xtra.texi @@ -122,8 +122,8 @@ and the menu bar (@pxref{Menu Bar}). @end ifnottex Scroll bars don't work in MS-DOS Emacs. PC mice usually have only -two buttons; these act as @kbd{Mouse-1} and @kbd{Mouse-2}, but if you -press both of them together, that has the effect of @kbd{Mouse-3}. If +two buttons; these act as @kbd{mouse-1} and @kbd{mouse-2}, but if you +press both of them together, that has the effect of @kbd{mouse-3}. If the mouse does have 3 buttons, Emacs detects that at startup, and all the 3 buttons function normally, as on X. diff --git a/doc/emacs/mule.texi b/doc/emacs/mule.texi index a0b1d626a7b..e735343cc75 100644 --- a/doc/emacs/mule.texi +++ b/doc/emacs/mule.texi @@ -499,7 +499,7 @@ the alternative. Typing a number selects the associated alternative of the current row and uses it as input. @key{TAB} in these Chinese input methods displays a buffer showing -all the possible characters at once; then clicking @kbd{Mouse-2} on +all the possible characters at once; then clicking @kbd{mouse-2} on one of them selects that alternative. The keys @kbd{C-f}, @kbd{C-b}, @kbd{C-n}, @kbd{C-p}, and digits continue to work as usual, but they do the highlighting in the buffer showing the possible characters, @@ -1036,7 +1036,7 @@ decoding it using coding system @var{right} instead. the current buffer (i.e., the coding system to use when saving or reverting the file). You specify which coding system using the minibuffer. You can also invoke this command by clicking with -@kbd{Mouse-3} on the coding system indicator in the mode line +@kbd{mouse-3} on the coding system indicator in the mode line (@pxref{Mode Line}). If you specify a coding system that cannot handle all the characters diff --git a/doc/emacs/programs.texi b/doc/emacs/programs.texi index 780e00ca681..0c79d9c3de1 100644 --- a/doc/emacs/programs.texi +++ b/doc/emacs/programs.texi @@ -1305,7 +1305,7 @@ count as blocks. @kindex C-c @@ C-M-s @kindex C-c @@ C-r @kindex C-c @@ C-l -@kindex S-Mouse-2 +@kindex S-mouse-2 @table @kbd @item C-c @@ C-h Hide the current block (@code{hs-hide-block}). @@ -1313,7 +1313,7 @@ Hide the current block (@code{hs-hide-block}). Show the current block (@code{hs-show-block}). @item C-c @@ C-c Either hide or show the current block (@code{hs-toggle-hiding}). -@item S-Mouse-2 +@item S-mouse-2 Toggle hiding for the block you click on (@code{hs-mouse-toggle-hiding}). @item C-c @@ C-M-h Hide all top-level blocks (@code{hs-hide-all}). diff --git a/doc/emacs/rmail.texi b/doc/emacs/rmail.texi index ef9894d6f26..a8cf5e4a512 100644 --- a/doc/emacs/rmail.texi +++ b/doc/emacs/rmail.texi @@ -1252,8 +1252,8 @@ Address mode: @end example @noindent -Then you can browse these URLs by clicking on them with @kbd{Mouse-2} -(or @kbd{Mouse-1} quickly) or by moving to one and typing @kbd{C-c +Then you can browse these URLs by clicking on them with @kbd{mouse-2} +(or @kbd{mouse-1} quickly) or by moving to one and typing @kbd{C-c @key{RET}}. @xref{Goto Address mode, Activating URLs, Activating URLs}. @node Rmail Coding diff --git a/doc/emacs/search.texi b/doc/emacs/search.texi index 459e8446937..7958a4a2bfa 100644 --- a/doc/emacs/search.texi +++ b/doc/emacs/search.texi @@ -203,10 +203,10 @@ saved in the search ring is specified by the variable @cindex incremental search, edit search string @cindex interactively edit search string @kindex M-e @r{(Incremental search)} -@kindex Mouse-1 @r{in the minibuffer (Incremental Search)} +@kindex mouse-1 @r{in the minibuffer (Incremental Search)} To edit the current search string in the minibuffer without replacing it with items from the search ring, type @kbd{M-e} or click -@kbd{Mouse-1} in the minibuffer. Type @key{RET}, @kbd{C-s} or +@kbd{mouse-1} in the minibuffer. Type @key{RET}, @kbd{C-s} or @kbd{C-r} to finish editing the string and search for it. Type @kbd{C-f} or @kbd{@key{RIGHT}} to add to the search string characters following point from the buffer from which you started the search. @@ -234,7 +234,7 @@ end of a line, it appends the next line. With a prefix argument @kindex C-y @r{(Incremental search)} @kindex M-y @r{(Incremental search)} -@kindex Mouse-2 @r{in the minibuffer (Incremental search)} +@kindex mouse-2 @r{in the minibuffer (Incremental search)} @findex isearch-yank-kill @findex isearch-yank-pop @findex isearch-yank-x-selection @@ -242,7 +242,7 @@ end of a line, it appends the next line. With a prefix argument appends the current kill to the search string. @kbd{M-y} (@code{isearch-yank-pop}), if called after @kbd{C-y}, replaces that appended text with an earlier kill, similar to the usual @kbd{M-y} -(@code{yank-pop}) command (@pxref{Yanking}). Clicking @kbd{Mouse-2} +(@code{yank-pop}) command (@pxref{Yanking}). Clicking @kbd{mouse-2} in the echo area appends the current X selection (@pxref{Primary Selection}) to the search string (@code{isearch-yank-x-selection}). diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi index 41abb42fb5d..e19925025d7 100644 --- a/doc/emacs/text.texi +++ b/doc/emacs/text.texi @@ -1255,7 +1255,7 @@ C-x} exits two folds and leaves the text and subheadings exposed. folds, and for showing and hiding text: @table @asis -@item @kbd{C-M-Mouse-1} zooms in on the heading clicked on +@item @kbd{C-M-mouse-1} zooms in on the heading clicked on @itemize @w{} @item single click: expose body. @@ -1266,7 +1266,7 @@ triple click: expose body and subheadings. @item quad click: expose entire subtree. @end itemize -@item @kbd{C-M-Mouse-2} exposes text under the heading clicked on +@item @kbd{C-M-mouse-2} exposes text under the heading clicked on @itemize @w{} @item single click: expose body. @@ -1277,7 +1277,7 @@ triple click: expose body and subheadings. @item quad click: expose entire subtree. @end itemize -@item @kbd{C-M-Mouse-3} hides text under the heading clicked on or exits fold +@item @kbd{C-M-mouse-3} hides text under the heading clicked on or exits fold @itemize @w{} @item single click: hide subtree. @@ -2156,7 +2156,7 @@ want to set the justification style to @code{unfilled} The easiest way to alter properties is with the @samp{Text Properties} menu. You can get to this menu from the @samp{Edit} menu -in the menu bar (@pxref{Menu Bar}), or with @kbd{C-Mouse-2} +in the menu bar (@pxref{Menu Bar}), or with @kbd{C-mouse-2} (@pxref{Menu Mouse Clicks}). Some of the commands in the @samp{Text Properties} menu are listed below (you can also invoke them with @kbd{M-x}): diff --git a/doc/emacs/windows.texi b/doc/emacs/windows.texi index 702963f75c5..bb8b68bf5f4 100644 --- a/doc/emacs/windows.texi +++ b/doc/emacs/windows.texi @@ -71,7 +71,7 @@ Split the selected window into two windows, one above the other @item C-x 3 Split the selected window into two windows, positioned side by side (@code{split-window-right}). -@item C-Mouse-2 +@item C-mouse-2 In the mode line of a window, split that window. @end table @@ -129,12 +129,12 @@ truncation glyphs, the margins, and the scroll bar. On text terminals, side-by-side windows are separated by a vertical divider which is drawn using the @code{vertical-border} face. -@kindex C-Mouse-2 @r{(mode line)} -@kindex C-Mouse-2 @r{(scroll bar)} - If you click @kbd{C-Mouse-2} in the mode line of a window, that +@kindex C-mouse-2 @r{(mode line)} +@kindex C-mouse-2 @r{(scroll bar)} + If you click @kbd{C-mouse-2} in the mode line of a window, that splits the window, putting a vertical divider where you click. Depending on how Emacs is compiled, you can also split a window by -clicking @kbd{C-Mouse-2} in the scroll bar, which puts a horizontal +clicking @kbd{C-mouse-2} in the scroll bar, which puts a horizontal divider where you click (this feature does not work when Emacs uses GTK+ scroll bars). @@ -158,8 +158,8 @@ this option is @code{nil}. Select another window (@code{other-window}). @item C-M-v Scroll the next window (@code{scroll-other-window}). -@item Mouse-1 -@kbd{Mouse-1}, in the text area of a window, selects the window and +@item mouse-1 +@kbd{mouse-1}, in the text area of a window, selects the window and moves point to the position clicked. Clicking in the mode line selects the window without moving point in it. @end table diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 010dcb2fd1f..c80f78c0e3b 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi @@ -5820,7 +5820,7 @@ A string displayed by the Emacs tool-tip help system; by default, @item follow-link @kindex follow-link @r{(button property)} -The follow-link property, defining how a @key{Mouse-1} click behaves +The follow-link property, defining how a @key{mouse-1} click behaves on this button, @xref{Clickable Text}. @item button @@ -6007,7 +6007,7 @@ additionally available in the keymap stored in @code{button-buffer-map} as a parent keymap for its keymap. If the button has a non-@code{nil} @code{follow-link} property, and -@code{mouse-1-click-follows-link} is set, a quick @key{Mouse-1} click +@code{mouse-1-click-follows-link} is set, a quick @key{mouse-1} click will also activate the @code{push-button} command. @xref{Clickable Text}. diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index 1ad665f0e5b..ab55c2037d7 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -3707,7 +3707,7 @@ properties. For simplicity, we will refer to the clickable text as a Implementing a link involves three separate steps: (1) indicating clickability when the mouse moves over the link; (2) making @key{RET} -or @kbd{Mouse-2} on that link do something; and (3) setting up a +or @kbd{mouse-2} on that link do something; and (3) setting up a @code{follow-link} condition so that the link obeys @code{mouse-1-click-follows-link}. @@ -3729,10 +3729,10 @@ names are clickable: help-echo "mouse-2: visit this file in other window"))) @end smallexample - To make the link clickable, bind @key{RET} and @kbd{Mouse-2} to + To make the link clickable, bind @key{RET} and @kbd{mouse-2} to commands that perform the desired action. Each command should check to see whether it was called on a link, and act accordingly. For -instance, Dired's major mode keymap binds @kbd{Mouse-2} to the +instance, Dired's major mode keymap binds @kbd{mouse-2} to the following command: @smallexample @@ -3775,12 +3775,12 @@ bind it within the link text, using the @code{keymap} text property @noindent With this method, you can easily define different commands for different links. Furthermore, the global definition of @key{RET} and -@kbd{Mouse-2} remain available for the rest of the text in the buffer. +@kbd{mouse-2} remain available for the rest of the text in the buffer. @vindex mouse-1-click-follows-link - The basic Emacs command for clicking on links is @kbd{Mouse-2}. + The basic Emacs command for clicking on links is @kbd{mouse-2}. However, for compatibility with other graphical applications, Emacs -also recognizes @kbd{Mouse-1} clicks on links, provided the user +also recognizes @kbd{mouse-1} clicks on links, provided the user clicks on the link quickly without moving the mouse. This behavior is controlled by the user option @code{mouse-1-click-follows-link}. @xref{Mouse References,,, emacs, The GNU Emacs Manual}. @@ -3794,9 +3794,9 @@ mode keymap or a local keymap specified via the @code{keymap} text property). The value of the @code{follow-link} property, or the binding for the @code{follow-link} event, acts as a condition for the link action. This condition tells Emacs two things: the -circumstances under which a @kbd{Mouse-1} click should be regarded as +circumstances under which a @kbd{mouse-1} click should be regarded as occurring inside the link, and how to compute an action code -that says what to translate the @kbd{Mouse-1} click into. The link +that says what to translate the @kbd{mouse-1} click into. The link action condition can be one of the following: @table @asis @@ -3805,7 +3805,7 @@ If the condition is the symbol @code{mouse-face}, a position is inside a link if there is a non-@code{nil} @code{mouse-face} property at that position. The action code is always @code{t}. -For example, here is how Info mode handles @key{Mouse-1}: +For example, here is how Info mode handles @key{mouse-1}: @smallexample (define-key Info-mode-map [follow-link] 'mouse-face) @@ -3817,7 +3817,7 @@ is inside a link if @code{(@var{func} @var{pos})} evaluates to non-@code{nil}. The value returned by @var{func} serves as the action code. -For example, here is how pcvs enables @kbd{Mouse-1} to follow links on +For example, here is how pcvs enables @kbd{mouse-1} to follow links on file names only: @smallexample @@ -3835,27 +3835,27 @@ to the entire buffer). @end table @noindent -The action code tells @kbd{Mouse-1} how to follow the link: +The action code tells @kbd{mouse-1} how to follow the link: @table @asis @item a string or vector -If the action code is a string or vector, the @kbd{Mouse-1} event is +If the action code is a string or vector, the @kbd{mouse-1} event is translated into the first element of the string or vector; i.e., the -action of the @kbd{Mouse-1} click is the local or global binding of +action of the @kbd{mouse-1} click is the local or global binding of that character or symbol. Thus, if the action code is @code{"foo"}, -@kbd{Mouse-1} translates into @kbd{f}. If it is @code{[foo]}, -@kbd{Mouse-1} translates into @key{foo}. +@kbd{mouse-1} translates into @kbd{f}. If it is @code{[foo]}, +@kbd{mouse-1} translates into @key{foo}. @item anything else -For any other non-@code{nil} action code, the @kbd{Mouse-1} event is -translated into a @kbd{Mouse-2} event at the same position. +For any other non-@code{nil} action code, the @kbd{mouse-1} event is +translated into a @kbd{mouse-2} event at the same position. @end table - To define @kbd{Mouse-1} to activate a button defined with + To define @kbd{mouse-1} to activate a button defined with @code{define-button-type}, give the button a @code{follow-link} property. The property value should be a link action condition, as described above. @xref{Buttons}. For example, here is how Help mode -handles @kbd{Mouse-1}: +handles @kbd{mouse-1}: @smallexample (define-button-type 'help-xref @@ -3863,11 +3863,11 @@ handles @kbd{Mouse-1}: 'action #'help-button-action) @end smallexample - To define @kbd{Mouse-1} on a widget defined with + To define @kbd{mouse-1} on a widget defined with @code{define-widget}, give the widget a @code{:follow-link} property. The property value should be a link action condition, as described above. For example, here is how the @code{link} widget specifies that -a @key{Mouse-1} click shall be translated to @key{RET}: +a @key{mouse-1} click shall be translated to @key{RET}: @smallexample (define-widget 'link 'item diff --git a/doc/misc/ebrowse.texi b/doc/misc/ebrowse.texi index 28fa42b33ef..816cb562555 100644 --- a/doc/misc/ebrowse.texi +++ b/doc/misc/ebrowse.texi @@ -421,9 +421,9 @@ regions in the buffer. Please notice the help strings in the echo area when the mouse moves over a sensitive region. @cindex context menu -A click with @kbd{Mouse-3} on a mouse-sensitive region opens a context +A click with @kbd{mouse-3} on a mouse-sensitive region opens a context menu. In addition to this, each buffer also has a buffer-specific menu -that is opened with a click with @kbd{Mouse-3} somewhere in the buffer +that is opened with a click with @kbd{mouse-3} somewhere in the buffer where no highlight is displayed. @@ -488,7 +488,7 @@ editing. @end table The same functionality is available from the menu opened with -@kbd{Mouse-3} on the class name. +@kbd{mouse-3} on the class name. @@ -551,7 +551,7 @@ Display a list of types. @end table These lists are also available from the class' context menu invoked with -@kbd{Mouse-3} on the class name. +@kbd{mouse-3} on the class name. @@ -898,7 +898,7 @@ You can install a hook function to perform actions after a member or class declaration or definition has been found, or when it is not found. All the commands described above can also be found in the context menu -displayed when clicking @kbd{Mouse-2} on a member name. +displayed when clicking @kbd{mouse-2} on a member name. diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi index 1fa46492080..fd4fd4f3798 100644 --- a/doc/misc/efaq.texi +++ b/doc/misc/efaq.texi @@ -2408,7 +2408,7 @@ error messages, inserts them into a special buffer called the source. Type @kbd{C-x `} to step through the offending lines one by one (starting with Emacs 22, you can also use @kbd{M-g M-p} and @kbd{M-g M-n} to go to the previous and next matches directly). Click -@kbd{Mouse-2} or press @key{RET} on a message text in the +@kbd{mouse-2} or press @key{RET} on a message text in the @file{*compilation*} buffer to go to the line whose number is mentioned in that message. @@ -3888,7 +3888,7 @@ is how to make @kbd{H-M-RIGHT} move forward a word: Not all modifiers are permitted in all situations. @key{Hyper}, @key{Super}, and @key{Alt} are not available on Unix character terminals. Non-@acronym{ASCII} keys and mouse events (e.g., @kbd{C-=} and -@kbd{Mouse-1}) also fall under this category. +@kbd{mouse-1}) also fall under this category. @end itemize diff --git a/doc/misc/idlwave.texi b/doc/misc/idlwave.texi index 64b1585c5ce..26c81d65948 100644 --- a/doc/misc/idlwave.texi +++ b/doc/misc/idlwave.texi @@ -1281,7 +1281,7 @@ the routine documentation header and/or routine source. @kindex M-? In any IDL program (or, as with most IDLWAVE commands, in the IDL Shell), press @kbd{M-?} (@code{idlwave-context-help}), or click with -@kbd{S-Mouse-3} to access context sensitive online help. The following +@kbd{S-mouse-3} to access context sensitive online help. The following locations are recognized context for help: @cindex Context, for online help @@ -1327,11 +1327,11 @@ which online help can be accessed. @itemize @bullet @item Online help for routines and keywords can be accessed through the -Routine Info display. Click with @kbd{Mouse-3} on an item to see the +Routine Info display. Click with @kbd{mouse-3} on an item to see the corresponding help (@pxref{Routine Info}). @item When using completion and Emacs pops up a @file{*Completions*} buffer -with possible completions, clicking with @kbd{Mouse-3} on a completion +with possible completions, clicking with @kbd{mouse-3} on a completion item invokes help on that item (@pxref{Completion}). Items for which help is available in the online system documentation (vs. just the program source itself) will be emphasized (e.g., colored blue). @@ -1577,7 +1577,7 @@ search for a procedure matching a regexp. If the list of completions is too long to fit in the @file{*Completions*} window, the window can be scrolled by pressing @kbd{M-@key{TAB}} repeatedly. Online help (if installed) for each -possible completion is available by clicking with @kbd{Mouse-3} on the +possible completion is available by clicking with @kbd{mouse-3} on the item. Items for which system online help (from the IDL manual) is available will be emphasized (e.g., colored blue). For other items, the corresponding source code or DocLib header will be used as the help @@ -2811,7 +2811,7 @@ you add or remove some on the command line) using @kbd{C-c C-d C-l}. In recent IDLWAVE versions, the breakpoint line is highlighted when the mouse is moved over it, and a tooltip pops up describing the break -details. @kbd{Mouse-3} on the breakpoint line pops up a menu of +details. @kbd{mouse-3} on the breakpoint line pops up a menu of breakpoint actions, including clearing, disabling, and adding or changing break conditions or ``after'' break count. @@ -3151,7 +3151,7 @@ print, only an initial portion of long arrays will be printed, up to For added speed and convenience, there are mouse bindings which allow you to click on expressions and examine their values. Use -@kbd{S-Mouse-2} to print an expression and @kbd{C-M-Mouse-2} to invoke +@kbd{S-mouse-2} to print an expression and @kbd{C-M-mouse-2} to invoke help (i.e., you need to hold down @key{META} and @key{CONTROL} while clicking with the middle mouse button). If you simply click, the nearest expression will be selected in the same manner as described @@ -3219,7 +3219,7 @@ mouse examine command, and two macros for generating your own examine key and mouse bindings. The most powerful and flexible mouse examine command of all is -available on @kbd{C-S-Mouse-2}. Just as for all the other mouse +available on @kbd{C-S-mouse-2}. Just as for all the other mouse examine commands, it permits click or drag expression selection, but instead of sending hard-coded commands to the shell, it pops-up a customizable selection list of examine functions to choose among, diff --git a/doc/misc/info.texi b/doc/misc/info.texi index 135c443c075..0a8100fec46 100644 --- a/doc/misc/info.texi +++ b/doc/misc/info.texi @@ -671,7 +671,7 @@ the @key{Shift} key and then press @key{TAB}). that subtopic's node. @cindex mouse support in Info mode -@kindex Mouse-2 @r{(Info mode)} +@kindex mouse-2 @r{(Info mode)} If your terminal supports a mouse, you have yet another way of going to a subtopic. Move your mouse pointer to the subtopic line, somewhere between the beginning @samp{*} and the colon @samp{:} which @@ -679,22 +679,22 @@ ends the subtopic's brief name. You will see the subtopic's name change its appearance (usually, its background color will change), and the shape of the mouse pointer will change if your platform supports that. After a while, if you leave the mouse on that spot, a small -window will pop up, saying ``Mouse-2: go to that node,'' or the same +window will pop up, saying ``mouse-2: go to that node,'' or the same message may appear at the bottom of the screen. - @kbd{Mouse-2} is the second button of your mouse counting from the + @kbd{mouse-2} is the second button of your mouse counting from the left---the middle button on a 3-button mouse. (On a 2-button mouse, you may have to press both buttons together to ``press the middle -button''.) The message tells you pressing @kbd{Mouse-2} with the +button''.) The message tells you pressing @kbd{mouse-2} with the current position of the mouse pointer (on subtopic in the menu) will go to that subtopic. @findex Info-mouse-follow-nearest-node - More generally, @kbd{Mouse-2} in an Info buffer finds the nearest + More generally, @kbd{mouse-2} in an Info buffer finds the nearest link to another node and goes there. For example, near a cross reference it acts like @kbd{f}, in a menu it acts like @kbd{m}, on the node's header line it acts like @kbd{n}, @kbd{p}, or @kbd{u}, etc. At -end of the node's text @kbd{Mouse-2} moves to the next node, or up if +end of the node's text @kbd{mouse-2} moves to the next node, or up if there's no next node. @format @@ -719,7 +719,7 @@ to the subnode that the @kbd{u} command brought you from. (Some Info readers may put you at the @emph{front} of the node instead---to get back to where you were reading, you have to type some @key{SPC}s.) - Another way to go Up is to click @kbd{Mouse-2} on the @samp{Up} + Another way to go Up is to click @kbd{mouse-2} on the @samp{Up} pointer shown in the header line (provided that you have a mouse). @format @@ -740,7 +740,7 @@ in Emacs. Do @kbd{M-x visible-mode} to show or hide it.) @findex Info-follow-reference You can follow a cross reference by moving the cursor to it and press @key{RET}, just as in a menu. In Emacs, you can also click -@kbd{Mouse-1} on a cross reference to follow it; you can see that the +@kbd{mouse-1} on a cross reference to follow it; you can see that the cross reference is mouse-sensitive by moving the mouse pointer to the reference and watching how the underlying text and the mouse pointer change in response. diff --git a/doc/misc/mh-e.texi b/doc/misc/mh-e.texi index d1fd8f76118..c48e4a40ea9 100644 --- a/doc/misc/mh-e.texi +++ b/doc/misc/mh-e.texi @@ -1566,7 +1566,7 @@ M-x mh-rmail @key{RET} bob @key{RET}}). @xref{Folders}.}. @findex display-time @vindex read-mail-command -There are some commands that need to read mail, such as @kbd{Mouse-2} +There are some commands that need to read mail, such as @kbd{mouse-2} over the @samp{Mail} button that @code{display-time} adds to the mode line. You can configure Emacs to have these commands use MH-E by setting the option @code{read-mail-command} to @samp{mh-rmail}. @@ -1835,9 +1835,9 @@ minibuffer (@code{mh-prefix-help}). Unpack message created with @command{uudecode} or @command{shar} (@code{mh-store-msg}). @c ------------------------- -@kindex Mouse-2 +@kindex mouse-2 @findex mh-show-mouse -@item Mouse-2 +@item mouse-2 Move point to mouse event and show message (@code{mh-show-mouse}). @end table @@ -1845,12 +1845,12 @@ Within the MH-Show buffer, the following command is defined. @table @kbd @kindex @key{RET} -@kindex Mouse-1 -@kindex Mouse-2 +@kindex mouse-1 +@kindex mouse-2 @findex mh-press-button @item @key{RET} -@itemx Mouse-1 -@itemx Mouse-2 +@itemx mouse-1 +@itemx mouse-2 View contents of button (@code{mh-press-button}). @end table @@ -2022,10 +2022,10 @@ detail in the following sections. @kindex @key{BS} @kindex @key{RET} @kindex @key{SPC} -@kindex Mouse-2 +@kindex mouse-2 The command @key{RET} (@code{mh-show}) displays the message that the -cursor is on while @kbd{Mouse-2} (@code{mh-show-mouse}) displays the +cursor is on while @kbd{mouse-2} (@code{mh-show-mouse}) displays the message that the mouse cursor is on. If the message is already displayed, it scrolls to the beginning of the message. Use @key{SPC} (@code{mh-page-msg}) and @key{BS} (@code{mh-previous-page}) to move @@ -2201,13 +2201,13 @@ highlighting of citations entirely, choose @samp{None}. @cindex links, following @findex goto-address-at-point @kindex C-c @key{RET} -@kindex Mouse-2 +@kindex mouse-2 @vindex goto-address-highlight-p Email addresses and URLs in the message are highlighted if the option @code{goto-address-highlight-p} is on, which it is by default. To view the web page for a highlighted URL or to send a message using a -highlighted email address, use @kbd{Mouse-2} or @kbd{C-c @key{RET}} +highlighted email address, use @kbd{mouse-2} or @kbd{C-c @key{RET}} (@code{goto-address-at-point}). @xref{Sending Mail}, to see how to configure Emacs to send the message using MH-E. @@ -2337,11 +2337,11 @@ Attachments in MH-E are indicated by @dfn{buttons} like this: @kindex @key{RET} @kindex K @key{TAB} @kindex K S-@key{TAB} -@kindex Mouse-1 -@kindex Mouse-2 +@kindex mouse-1 +@kindex mouse-2 -To view the contents of the button, use either @kbd{Mouse-1} or -@kbd{Mouse-2} on the button or @key{RET} (@code{mh-press-button}) when +To view the contents of the button, use either @kbd{mouse-1} or +@kbd{mouse-2} on the button or @key{RET} (@code{mh-press-button}) when the cursor is over the button. This command is a toggle so if you use it again on the same attachment, it is hidden. If Emacs does not know how to display the attachment, then Emacs offers to save the @@ -2561,11 +2561,11 @@ includes the results of a quick poll of MH-E users from 2005-12-23. @table @asis @cindex browser, @samp{w3m} @cindex @samp{w3m} -@kindex Mouse-2 +@kindex mouse-2 @item @samp{w3m} 7 The @samp{w3m} browser requires an external program. It's quick, produces pretty nice output, and best of all, it's the only browser -that highlights links. These can be clicked with @kbd{Mouse-2} to view +that highlights links. These can be clicked with @kbd{mouse-2} to view the content of the link in @samp{w3m}. The @samp{w3m} browser handles tables well and actually respects the table's width parameter (which can cause text to wrap if the author didn't anticipate that the page @@ -2650,7 +2650,7 @@ documentation for the Gnus command @kbd{W h} (see section @cindex @file{.emacs} @cindex files, @file{.emacs} @findex browse-url-at-mouse -@kindex S-Mouse-2 +@kindex S-mouse-2 A useful key binding that you can add to @file{~/.emacs} is the following which displays an HTML link or textual URL in an external @@ -6261,7 +6261,7 @@ containing the value for the field is given. @findex mh-visit-folder @kindex F v @kindex M-x speedbar -@kindex Mouse-2 +@kindex mouse-2 You can also use the speedbar @ifnothtml @@ -6275,7 +6275,7 @@ Speedbar Frames} in @cite{The GNU Emacs Manual}) to view your folders. To bring up the speedbar, run @kbd{M-x speedbar @key{RET}}. You will see a new frame appear with all of your MH folders. Folders with unseen messages appear in boldface. Click on a -folder name with @kbd{Mouse-2} to visit that folder in a similar +folder name with @kbd{mouse-2} to visit that folder in a similar fashion to the command @kbd{F v} (@code{mh-visit-folder}) (@pxref{Folders}). Click on the @samp{+} icon to expand and view the sub-folders of that folder. @@ -6310,9 +6310,9 @@ count before the next automatic update (@code{mh-speed-refresh}). @findex delete-frame @kindex C-x 5 0 -@kindex Mouse-3 +@kindex mouse-3 -You can click on @kbd{Mouse-3} to bring up a context menu that +You can click on @kbd{mouse-3} to bring up a context menu that contains these items. Dismiss the speedbar with @kbd{C-x 5 0} (@code{delete-frame}). diff --git a/doc/misc/sem-user.texi b/doc/misc/sem-user.texi index f11e0b83fa1..a8684a40b3a 100644 --- a/doc/misc/sem-user.texi +++ b/doc/misc/sem-user.texi @@ -1173,7 +1173,7 @@ the declaration line of the function or tag on the topmost line in the text area. This allows you to keep that declaration line in view at all times, even if it is scrolls off the ``top'' of the screen. -In addition, clicking @kbd{Mouse-1} on the header line opens a context +In addition, clicking @kbd{mouse-1} on the header line opens a context menu that contains menu items for copying, killing, or narrowing to that tag. @@ -1199,7 +1199,7 @@ Semantic Highlight Function minor mode highlights the declaration line of the current function or tag (that is to say, the first line that describes the rest of the construct). -In addition, clicking @kbd{Mouse-3} on the highlighted declaration +In addition, clicking @kbd{mouse-3} on the highlighted declaration line opens a context menu that contains menu items for copying, killing, or narrowing to that tag. diff --git a/doc/misc/speedbar.texi b/doc/misc/speedbar.texi index 377e412bb30..d43c521f76a 100644 --- a/doc/misc/speedbar.texi +++ b/doc/misc/speedbar.texi @@ -62,7 +62,7 @@ authors of other packages to provide speedbar summaries customized to the needs of that mode. Throughout this manual, activities are defined as ``clicking on'', or -``expanding'' items. Clicking means using @kbd{Mouse-2} on a +``expanding'' items. Clicking means using @kbd{mouse-2} on a button. Expanding refers to clicking on an expansion button to display an expanded summary of the entry the expansion button is on. @xref{Basic Navigation}. @@ -316,29 +316,29 @@ with the mouse, or affected by the menu. The mouse bindings are: @table @kbd -@item Mouse-1 +@item mouse-1 Move cursor to that location. -@item Mouse-2 -@itemx Double-Mouse-1 -Activate the current button. @kbd{Double-Mouse-1} is called a @dfn{double +@item mouse-2 +@itemx Double-mouse-1 +Activate the current button. @kbd{Double-mouse-1} is called a @dfn{double click} on other platforms, and is useful for windows users with two button mice. -@c Isn't it true that with two-button mice, the right button is Mouse-2? -@c On GNU/Linux, the right button is Mouse-3. -@item S-Mouse-2 -@itemx S-Double-Mouse-1 +@c Isn't it true that with two-button mice, the right button is mouse-2? +@c On GNU/Linux, the right button is mouse-3. +@item S-mouse-2 +@itemx S-Double-mouse-1 @cindex power click -This has the same effect as @kbd{Mouse-2}, except it is called a power +This has the same effect as @kbd{mouse-2}, except it is called a power click. This means that if a group with an expansion button @samp{+} is clicked, any caches are flushed, and subitems re-read. If it is a name, it will be opened in a new frame. -@item Mouse-3 +@item mouse-3 Activate the speedbar menu. The item selected affects the line clicked, not the line where the cursor was. -@item Mouse-1 @r{(mode line)} +@item mouse-1 @r{(mode line)} Activate the menu. This affects the item the cursor is on before the click, since the mouse was not clicked on anything. -@item C-Mouse-1 +@item C-mouse-1 Buffers sub-menu. The buffer in the attached frame is switched. @end table @@ -355,7 +355,7 @@ You can display different data by using different display modes. These specialized modes make it easier to navigate the relevant pieces of information, such as files and directories, or buffers. -In the main menu, found by clicking @kbd{Mouse-3}, there is a submenu +In the main menu, found by clicking @kbd{mouse-3}, there is a submenu labeled @samp{Displays}. This submenu lets you easily choose between different display modes. diff --git a/doc/misc/viper.texi b/doc/misc/viper.texi index 3f81f67beb4..6b169f3c8e6 100644 --- a/doc/misc/viper.texi +++ b/doc/misc/viper.texi @@ -2591,7 +2591,7 @@ occurrence of the pattern to search for. Note: while loading initially, Viper binds this mouse action only if it is not already bound to something else. If you want to use the mouse-search -feature, and the @kbd{Meta-Shift-Mouse-1} mouse action is already bound to +feature, and the @kbd{Meta-Shift-mouse-1} mouse action is already bound to something else, you can rebind the mouse-search feature by setting @code{viper-mouse-search-key} to something else in your Viper customization file: @@ -2669,8 +2669,8 @@ purpose of mouse search and mouse insert. By default, this is set to @code{double-click-time} in Emacs and to @code{mouse-track-multi-click-time} milliseconds in XEmacs. @end table -@kindex @kbd{S-Mouse-1} -@kindex @kbd{S-Mouse-2} +@kindex @kbd{S-mouse-1} +@kindex @kbd{S-mouse-2} @kindex @kbd{meta shift button1up} @kindex @kbd{meta shift button2up} @vindex @code{viper-multiclick-timeout} @@ -4428,7 +4428,7 @@ The following two mouse actions are normally bound to special search and insert commands in of Viper: @table @kbd -@item S-Mouse-1 +@item S-mouse-1 Holding Shift and clicking mouse button 1 will initiate search for a region under the mouse pointer. @@ -4437,7 +4437,7 @@ binding only if this mouse action is not already bound to something else. @xref{Viper Specials}, for more information. -@item S-Mouse-2 +@item S-mouse-2 Holding Shift and clicking button 2 of the mouse will insert a region surrounding the mouse pointer. This command can also take a prefix argument. @@ -4445,8 +4445,8 @@ Note: Viper sets this binding only if this mouse action is not already bound to something else. @xref{Viper Specials}, for more details. @end table -@kindex @kbd{S-Mouse-1} -@kindex @kbd{S-Mouse-2} +@kindex @kbd{S-mouse-1} +@kindex @kbd{S-mouse-2} @kindex @kbd{meta button1up} @kindex @kbd{meta button2up} diff --git a/doc/misc/widget.texi b/doc/misc/widget.texi index 49606ed9692..953bcae3ef2 100644 --- a/doc/misc/widget.texi +++ b/doc/misc/widget.texi @@ -243,8 +243,8 @@ If point is not located on a button, invoke the binding in @code{widget-global-map} (by default the global map). @end deffn -@kindex Mouse-2 @r{(on button widgets}) -@item Mouse-2 +@kindex mouse-2 @r{(on button widgets}) +@item mouse-2 @deffn Command widget-button-click @var{event} Invoke the button at the location of the mouse pointer. If the mouse pointer is located in an editable text field, invoke the binding in @@ -456,7 +456,7 @@ There is a standard widget keymap which you might find useful. @findex widget-button-click @defvr Const widget-keymap @key{TAB} and @kbd{C-@key{TAB}} are bound to @code{widget-forward} and -@code{widget-backward}, respectively. @key{RET} and @kbd{Mouse-2} +@code{widget-backward}, respectively. @key{RET} and @kbd{mouse-2} are bound to @code{widget-button-press} and @code{widget-button-click}. @end defvr diff --git a/doc/misc/woman.texi b/doc/misc/woman.texi index 59320d23684..f1fbba6151b 100644 --- a/doc/misc/woman.texi +++ b/doc/misc/woman.texi @@ -671,19 +671,19 @@ to other man pages. If these man pages are installed then WoMan can easily be directed to follow the reference, i.e., to find and format the man page. When the mouse is passed over a correctly formatted reference it is highlighted, in which case clicking the middle button -@kbd{Mouse-2} will cause WoMan to follow the reference. Alternatively, +@kbd{mouse-2} will cause WoMan to follow the reference. Alternatively, when point is over such a reference the key @key{RET} will follow the reference. Any word in the buffer can be used as a reference by clicking -@kbd{Mouse-2} over it provided the Meta key is also used (although in +@kbd{mouse-2} over it provided the Meta key is also used (although in general such a ``reference'' will not lead to a man page). Alternatively, the key @kbd{r} allows completion to be used to select a reference to follow, based on the word at point as default. @table @kbd -@item @kbd{Mouse-2} -@kindex Mouse-2 +@item @kbd{mouse-2} +@kindex mouse-2 @findex woman-mouse-2 Run WoMan with word under mouse as topic (@code{woman-mouse-2}). The word must be mouse-highlighted unless @code{woman-mouse-2} is used with -- cgit v1.2.1 From 396747d0ba6cee400b10850886c8d04b5718e20e Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 15:26:25 +0200 Subject: Don't have the manual claim that it lists all CL incompatibilities * doc/misc/cl.texi (Common Lisp Compatibility): The list of incompatibilities isn't exhaustive, so don't say that it is (bug#15171). (cherry picked from commit fb685bc91a72508c97ce7e30f970d4157677f371) --- doc/misc/cl.texi | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi index 572124d452d..4137a95b3b2 100644 --- a/doc/misc/cl.texi +++ b/doc/misc/cl.texi @@ -4501,8 +4501,9 @@ referenced by @code{cl-return} or @code{cl-return-from} inside the block. @appendix Common Lisp Compatibility @noindent -The following is a list of all known incompatibilities between this -package and Common Lisp as documented in Steele (2nd edition). +The following is a list of some of the most important +incompatibilities between this package and Common Lisp as documented +in Steele (2nd edition). The word @code{cl-defun} is required instead of @code{defun} in order to use extended Common Lisp argument lists in a function. Likewise, -- cgit v1.2.1 From cc00738ff274c523d3b7ff479c35a1c4b213719d Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 15:37:08 +0200 Subject: find-lisp doc touchups * lisp/find-lisp.el (find-lisp-format): Copy over the doc string (bug#15047). (find-lisp-find-files): Clarify doc. (cherry picked from commit e4c7657b0d1a31d64ca24bc64b5480cd7687e332) --- lisp/find-lisp.el | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/lisp/find-lisp.el b/lisp/find-lisp.el index 475001f5707..8591eb841c1 100644 --- a/lisp/find-lisp.el +++ b/lisp/find-lisp.el @@ -118,7 +118,7 @@ Argument DIR is the directory containing FILE." ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defun find-lisp-find-files (directory regexp) - "Find files in DIRECTORY which match REGEXP." + "Find files under DIRECTORY, recursively, that match REGEXP." (let ((file-predicate 'find-lisp-default-file-predicate) (directory-predicate 'find-lisp-default-directory-predicate) (find-lisp-regexp regexp)) @@ -297,6 +297,9 @@ It is a function which takes two arguments, the directory and its parent." ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; (defun find-lisp-format (file-name file-attr switches now) + "Format one line of long ls output for file FILE-NAME. +FILE-ATTR and FILE-SIZE give the file's attributes and size. +SWITCHES and TIME-INDEX give the full switch list and time data." (let ((file-type (nth 0 file-attr))) (concat (if (memq ?i switches) ; inode number (format "%6d " (nth 10 file-attr))) @@ -325,7 +328,7 @@ It is a function which takes two arguments, the directory and its parent." "\n"))) (defun find-lisp-time-index (switches) - ;; Return index into file-attributes according to ls SWITCHES. + "Return index into file-attributes according to ls SWITCHES." (cond ((memq ?c switches) 6) ; last mode change ((memq ?u switches) 4) ; last access @@ -333,10 +336,11 @@ It is a function which takes two arguments, the directory and its parent." (t 5))) (defun find-lisp-format-time (file-attr switches now) - ;; Format time string for file with attributes FILE-ATTR according - ;; to SWITCHES (a list of ls option letters of which c and u are recognized). - ;; Use the same method as `ls' to decide whether to show time-of-day or year, - ;; depending on distance between file date and NOW. + "Format time string for file. +This is done with attributes FILE-ATTR according to SWITCHES (a +list of ls option letters of which c and u are recognized). Use +the same method as \"ls\" to decide whether to show time-of-day or +year, depending on distance between file date and NOW." (let* ((time (nth (find-lisp-time-index switches) file-attr)) (diff16 (- (car time) (car now))) (diff (+ (ash diff16 16) (- (car (cdr time)) (car (cdr now))))) -- cgit v1.2.1 From 92559c74ab7e7d0131c4512e22ed292e1f1e7fb6 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 15:52:18 +0200 Subject: Link from (emacs)Exiting to (lisp)Killing Emacs * doc/emacs/entering.texi (Exiting): Link to the lispref manual for further customisations (bug#15445). (cherry picked from commit bc5f27aa099cdde02ca66e71501b89300685ab28) --- doc/emacs/entering.texi | 3 +++ 1 file changed, 3 insertions(+) diff --git a/doc/emacs/entering.texi b/doc/emacs/entering.texi index 3e936e73944..66817e3067f 100644 --- a/doc/emacs/entering.texi +++ b/doc/emacs/entering.texi @@ -133,6 +133,9 @@ run. One convenient function to use as the value of @code{confirm-kill-emacs} is the function @code{yes-or-no-p}. The default value of @code{confirm-kill-emacs} is @code{nil}. + To further customize what happens when Emacs is exiting, see +@ref{Killing Emacs,,, elisp, The GNU Emacs Lisp Reference Manual}. + @findex kill-emacs To kill Emacs without being prompted about saving, type @kbd{M-x kill-emacs}. -- cgit v1.2.1 From 28ef870c7a0936648cb0bc1ae721f2caa575391e Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 17:54:55 +0200 Subject: Doc tweak * lisp/simple.el (use-empty-active-region): Doc tweak. There's only one region (bug#16513). (cherry picked from commit 35fb7897f161d5e5a87e039dc1e427094640b0c8) --- lisp/simple.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lisp/simple.el b/lisp/simple.el index d7743eea596..8965eb716be 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -5211,7 +5211,7 @@ This macro does what `save-excursion' did before Emacs 25.1." (defcustom use-empty-active-region nil "Whether \"region-aware\" commands should act on empty regions. -If nil, region-aware commands treat empty regions as inactive. +If nil, region-aware commands treat the empty region as inactive. If non-nil, region-aware commands treat the region as active as long as the mark is active, even if the region is empty. -- cgit v1.2.1 From bc6c294d606266a410abdb8954bf6d4acbd21df9 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 20:27:22 +0200 Subject: Doc fix for `kbd' * lisp/subr.el (kbd): Describe more fully the format of the parameter (bug#17039). (cherry picked from commit 3a33afe25d8518f194fa4706eaccdb2a786a0348) --- lisp/subr.el | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lisp/subr.el b/lisp/subr.el index 0fb4a2ec256..ce49604f811 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -619,8 +619,10 @@ side-effects, and the argument LIST is not modified." (defun kbd (keys) "Convert KEYS to the internal Emacs key representation. -KEYS should be a string constant in the format used for -saving keyboard macros (see `edmacro-mode')." +KEYS should be a string in the format returned by commands such +as `C-h k' (`describe-key'). +This is the same format used for saving keyboard macros (see +`edmacro-mode')." ;; Don't use a defalias, since the `pure' property is only true for ;; the calling convention of `kbd'. (read-kbd-macro keys)) -- cgit v1.2.1 From 02c1aa8fe52959df140dd1c0ab8467f00c946a5c Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 22:14:05 +0200 Subject: Doc fix for align-newline-and-indent * lisp/align.el (align-newline-and-indent): Mention that alignment is done by `align' (bug#17707). (cherry picked from commit 340a224ec3e01706112a07164da9a9f3f369a5aa) --- lisp/align.el | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lisp/align.el b/lisp/align.el index 7e439f3e073..f09f57032d4 100644 --- a/lisp/align.el +++ b/lisp/align.el @@ -1051,7 +1051,9 @@ to be colored." ;;;###autoload (defun align-newline-and-indent () - "A replacement function for `newline-and-indent', aligning as it goes." + "A replacement function for `newline-and-indent', aligning as it goes. +The alignment is done by calling `align' on the region that was +indented." (interactive) (let ((separate (or (if (and (symbolp align-region-separate) (boundp align-region-separate)) -- cgit v1.2.1 From 8748c21f7197274177faae7699f5a3d47af4f938 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 22:28:02 +0200 Subject: Add a doc string to `winner-mode' * lisp/winner.el (winner-mode): Add a doc string based on the comments in the file (bug#17716). (cherry picked from commit 2c3ab9b6e39a3d600e7d82deacc24effaec051bb) --- lisp/winner.el | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/lisp/winner.el b/lisp/winner.el index 4b277008d78..9a6f5d5190b 100644 --- a/lisp/winner.el +++ b/lisp/winner.el @@ -346,7 +346,19 @@ You may want to include buffer names such as *Help*, *Apropos*, ;;;###autoload -(define-minor-mode winner-mode nil :global t ; let d-m-m make the doc +(define-minor-mode winner-mode + "Toggle Winner mode on or off. +With a prefix argument ARG, enable Winner mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil, and toggle it if ARG is ‘toggle’. + +Winner mode is a global minor mode that records the changes in +the window configuration (i.e. how the frames are partitioned +into windows) so that the changes can be \"undone\" using the +command `winner-undo'. By default this one is bound to the key +sequence `C-c '. If you change your mind (while undoing), +you can press `C-c ' (calling `winner-redo')." + :global t (if winner-mode (progn (add-hook 'window-configuration-change-hook 'winner-change-fun) -- cgit v1.2.1 From dc960d9743d3a90a8e518431bb6b8e29fd49bd32 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 22:53:42 +0200 Subject: Clarify hi-lock-find-patterns * lisp/hi-lock.el (hi-lock-find-patterns): Doc clarification (bug#17989). (cherry picked from commit 552e90ce7dff3a7107243fdf71c4de3af443e13a) --- lisp/hi-lock.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lisp/hi-lock.el b/lisp/hi-lock.el index ec14e0b4329..549010dda03 100644 --- a/lisp/hi-lock.el +++ b/lisp/hi-lock.el @@ -727,7 +727,7 @@ with completion and history." (font-lock-flush))) (defun hi-lock-find-patterns () - "Find patterns in current buffer for hi-lock." + "Add patterns from the current buffer to the list of hi-lock patterns." (interactive) (unless (memq major-mode hi-lock-exclude-modes) (let ((all-patterns nil) -- cgit v1.2.1 From df6cee945677146600e5e171586921449a023e71 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 23:25:07 +0200 Subject: Wrap the auto-generated doc string * lisp/emacs-lisp/easy-mmode.el (define-minor-mode): Wrap a string to make it less likely that we get overlong lines (bug#17999). (cherry picked from commit 323b69664914d687fd4b48593479cea223dfbcb4) --- lisp/emacs-lisp/easy-mmode.el | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lisp/emacs-lisp/easy-mmode.el b/lisp/emacs-lisp/easy-mmode.el index 6a4d835b63c..05229d2df04 100644 --- a/lisp/emacs-lisp/easy-mmode.el +++ b/lisp/emacs-lisp/easy-mmode.el @@ -252,7 +252,8 @@ Use the command `%s' to change this variable." pretty-name mode)) (t (let ((base-doc-string (concat "Non-nil if %s is enabled. -See the command `%s' for a description of this minor mode." +See the `%s' command +for a description of this minor mode." (if body " Setting this variable directly does not take effect; either customize it (see the info node `Easy Customization') -- cgit v1.2.1 From db20f89634287e903f0900ccc632b536a13af455 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Fri, 29 Apr 2016 23:53:12 +0200 Subject: Fill font-lock-mode doc string * lisp/font-core.el (font-lock-mode): Fill the text to make it narrower (bug#18008). (cherry picked from commit 27abf372836532c57be2e9e3ed23413729cc07fc) --- lisp/font-core.el | 50 +++++++++++++++++++++++++++----------------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/lisp/font-core.el b/lisp/font-core.el index a0971a17f5f..b3da8970500 100644 --- a/lisp/font-core.el +++ b/lisp/font-core.el @@ -86,46 +86,50 @@ When Font Lock mode is enabled, text is fontified as you type it: - Comments are displayed in `font-lock-comment-face'; - Strings are displayed in `font-lock-string-face'; - - Certain other expressions are displayed in other faces according to the - value of the variable `font-lock-keywords'. + - Certain other expressions are displayed in other faces + according to the value of the variable `font-lock-keywords'. To customize the faces (colors, fonts, etc.) used by Font Lock for fontifying different parts of buffer text, use \\[customize-face]. -You can enable Font Lock mode in any major mode automatically by turning on in -the major mode's hook. For example, put in your ~/.emacs: +You can enable Font Lock mode in any major mode automatically by +turning on in the major mode's hook. For example, put in your +~/.emacs: (add-hook \\='c-mode-hook \\='turn-on-font-lock) -Alternatively, you can use Global Font Lock mode to automagically turn on Font -Lock mode in buffers whose major mode supports it and whose major mode is one -of `font-lock-global-modes'. For example, put in your ~/.emacs: +Alternatively, you can use Global Font Lock mode to automagically +turn on Font Lock mode in buffers whose major mode supports it +and whose major mode is one of `font-lock-global-modes'. For +example, put in your ~/.emacs: (global-font-lock-mode t) -Where major modes support different levels of fontification, you can use -the variable `font-lock-maximum-decoration' to specify which level you -generally prefer. When you turn Font Lock mode on/off the buffer is -fontified/defontified, though fontification occurs only if the buffer is -less than `font-lock-maximum-size'. +Where major modes support different levels of fontification, you +can use the variable `font-lock-maximum-decoration' to specify +which level you generally prefer. When you turn Font Lock mode +on/off the buffer is fontified/defontified, though fontification +occurs only if the buffer is less than `font-lock-maximum-size'. -To add your own highlighting for some major mode, and modify the highlighting -selected automatically via the variable `font-lock-maximum-decoration', you can -use `font-lock-add-keywords'. +To add your own highlighting for some major mode, and modify the +highlighting selected automatically via the variable +`font-lock-maximum-decoration', you can use +`font-lock-add-keywords'. -To fontify a buffer, without turning on Font Lock mode and regardless of buffer -size, you can use \\[font-lock-fontify-buffer]. +To fontify a buffer, without turning on Font Lock mode and +regardless of buffer size, you can use \\[font-lock-fontify-buffer]. -To fontify a block (the function or paragraph containing point, or a number of -lines around point), perhaps because modification on the current line caused -syntactic change on other lines, you can use \\[font-lock-fontify-block]. +To fontify a block (the function or paragraph containing point, +or a number of lines around point), perhaps because modification +on the current line caused syntactic change on other lines, you +can use \\[font-lock-fontify-block]. You can set your own default settings for some mode, by setting a buffer local value for `font-lock-defaults', via its mode hook. -The above is the default behavior of `font-lock-mode'; you may specify -your own function which is called when `font-lock-mode' is toggled via -`font-lock-function'. " +The above is the default behavior of `font-lock-mode'; you may +specify your own function which is called when `font-lock-mode' +is toggled via `font-lock-function'. " nil nil nil :after-hook (font-lock-initial-fontify) ;; Don't turn on Font Lock mode if we don't have a display (we're running a -- cgit v1.2.1 From 3852fd6e318b9860958c4a2b3c72d69e63ac2fbf Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 00:02:46 +0200 Subject: Minor doc clarification * lisp/subr.el (y-or-n-p): Document the return value from "n" (bug#18024). (cherry picked from commit 5d1f3192d484edee92caa46cd7d699da3e920259) --- lisp/subr.el | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lisp/subr.el b/lisp/subr.el index ce49604f811..00a947397ae 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -2312,7 +2312,8 @@ floating point support." (declare-function x-popup-dialog "menu.c" (position contents &optional header)) (defun y-or-n-p (prompt) - "Ask user a \"y or n\" question. Return t if answer is \"y\". + "Ask user a \"y or n\" question. +Return t if answer is \"y\" and nil if it is \"n\". PROMPT is the string to display to ask the question. It should end in a space; `y-or-n-p' adds \"(y or n) \" to it. -- cgit v1.2.1 From 71795d4b5fa210de645d435e23f1d40814c9aee5 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 00:08:07 +0200 Subject: Doc fix * lisp/rect.el (delete-whitespace-rectangle): Doc fix (bug#18026). (cherry picked from commit 6baca4911ec901579749dbf7596011d90fea3781) --- lisp/rect.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lisp/rect.el b/lisp/rect.el index 6aa7b8b585b..43621d970d2 100644 --- a/lisp/rect.el +++ b/lisp/rect.el @@ -370,7 +370,7 @@ no text on the right side of the rectangle." "Delete all whitespace following a specified column in each line. The left edge of the rectangle specifies the position in each line at which whitespace deletion should begin. On each line in the -rectangle, all continuous whitespace starting at that column is deleted. +rectangle, all contiguous whitespace starting at that column is deleted. When called from a program the rectangle's corners are START and END. With a prefix (or a FILL) argument, also fill too short lines." -- cgit v1.2.1 From 4a2f33d1a11e0608d521520afcb14ec13dd1a722 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 00:11:15 +0200 Subject: Doc fixes for menu-bar.el * lisp/menu-bar.el (clipboard-kill-ring-save): Describe the REGION parameter (bug#18028). (clipboard-kill-region): Ditto. (cherry picked from commit 33d2c67bff0992ecbc0fe38556683242b9d1a4ae) --- lisp/menu-bar.el | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/lisp/menu-bar.el b/lisp/menu-bar.el index 6281d7e5453..6571a4b9d4f 100644 --- a/lisp/menu-bar.el +++ b/lisp/menu-bar.el @@ -539,13 +539,17 @@ (yank))) (defun clipboard-kill-ring-save (beg end &optional region) - "Copy region to kill ring, and save in the GUI's clipboard." + "Copy region to kill ring, and save in the GUI's clipboard. +If the optional argument REGION is non-nil, the function ignores +BEG and END, and saves the current region instead." (interactive "r\np") (let ((gui-select-enable-clipboard t)) (kill-ring-save beg end region))) (defun clipboard-kill-region (beg end &optional region) - "Kill the region, and save it in the GUI's clipboard." + "Kill the region, and save it in the GUI's clipboard. +If the optional argument REGION is non-nil, the function ignores +BEG and END, and kills the current region instead." (interactive "r\np") (let ((gui-select-enable-clipboard t)) (kill-region beg end region))) -- cgit v1.2.1 From c3557740c9058413993f51258a01dc9f3601f6f3 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 00:37:31 +0200 Subject: delsel doc touch ups * lisp/delsel.el (delete-selection-helper): Use non-nil instead of t and clarify function return values (bug#18089). (cherry picked from commit d7a5b5be9a5869bcd233434ec3103dd1976d7df7) --- lisp/delsel.el | 19 ++++++++++--------- 1 file changed, 10 insertions(+), 9 deletions(-) diff --git a/lisp/delsel.el b/lisp/delsel.el index 6a819ebbf67..da4223f49fe 100644 --- a/lisp/delsel.el +++ b/lisp/delsel.el @@ -171,16 +171,17 @@ With ARG, repeat that many times. `C-u' means until end of buffer." active region. `kill' `kill-region' is used on the selection, rather than - `delete-region'. (Text selected with the mouse will typically - be yankable anyhow.) - t - The normal case: delete the active region prior to executing - the command which will insert replacement text. + `delete-region'. (Text selected with the mouse will + typically be yankable anyhow.) FUNCTION - For commands which need to dynamically determine this behavior. - FUNCTION should take no argument and return one of the above - values, or nil. In the latter case, FUNCTION should itself - do with the active region whatever is appropriate." + For commands which need to dynamically determine this + behavior. FUNCTION should take no argument and return a + value acceptable as TYPE, or nil. In the latter case, + FUNCTION should itself do with the active region whatever is + appropriate. + Other non-nil values + The normal case: delete the active region prior to executing + the command which will insert replacement text." (condition-case data (cond ((eq type 'kill) ;Deprecated, backward compatibility. (delete-active-region t) -- cgit v1.2.1 From 7b85885797c11da241f27b3a1ed0cade80b856d1 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 00:54:13 +0200 Subject: Doc fix * src/keymap.c (Fdefine_prefix_command): Clarify doc string slightly (bug#18092). (cherry picked from commit 6b769c81d024f7eeb90b167e7df6f87d859614d4) --- src/keymap.c | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/keymap.c b/src/keymap.c index 8ab4c6c27ae..c975aad27d8 100644 --- a/src/keymap.c +++ b/src/keymap.c @@ -1737,10 +1737,12 @@ bindings; see the description of `lookup-key' for more details about this. */) DEFUN ("define-prefix-command", Fdefine_prefix_command, Sdefine_prefix_command, 1, 3, 0, doc: /* Define COMMAND as a prefix command. COMMAND should be a symbol. -A new sparse keymap is stored as COMMAND's function definition and its value. -If a second optional argument MAPVAR is given, the map is stored as -its value instead of as COMMAND's value; but COMMAND is still defined -as a function. +A new sparse keymap is stored as COMMAND's function definition and its +value. +This prepares COMMAND for use as a prefix key's binding. +If a second optional argument MAPVAR is given, it should be a symbol. +The map is then stored as MAPVAR's value instead of as COMMAND's +value; but COMMAND is still defined as a function. The third optional argument NAME, if given, supplies a menu name string for the map. This is required to use the keymap as a menu. This function returns COMMAND. */) -- cgit v1.2.1 From d815ba53483a34a3507244a6223528e4702e1a93 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 01:26:17 +0200 Subject: Tiny doc fix * src/fileio.c (Ffile_accessible_directory_p): Tiny doc fix (and fill) (bug#18201). (cherry picked from commit 2ef0040e2363a669d9b93df935d31c98fa130132) --- src/fileio.c | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/src/fileio.c b/src/fileio.c index dfab3de9e94..b11f9233ab4 100644 --- a/src/fileio.c +++ b/src/fileio.c @@ -2664,13 +2664,13 @@ file_directory_p (char const *file) DEFUN ("file-accessible-directory-p", Ffile_accessible_directory_p, Sfile_accessible_directory_p, 1, 1, 0, - doc: /* Return t if file FILENAME names a directory you can open. -For the value to be t, FILENAME must specify the name of a directory as a file, -and the directory must allow you to open files in it. In order to use a -directory as a buffer's current directory, this predicate must return true. -A directory name spec may be given instead; then the value is t -if the directory so specified exists and really is a readable and -searchable directory. */) + doc: /* Return t if FILENAME names a directory you can open. +For the value to be t, FILENAME must specify the name of a directory +as a file, and the directory must allow you to open files in it. In +order to use a directory as a buffer's current directory, this +predicate must return true. A directory name spec may be given +instead; then the value is t if the directory so specified exists and +really is a readable and searchable directory. */) (Lisp_Object filename) { Lisp_Object absname; -- cgit v1.2.1 From 651182d070bfbb22a47133adf8d90c849e5e6467 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 02:03:24 +0200 Subject: Doc fixed for next-error-buffer-p * lisp/simple.el (next-error-buffer-p): Clarify doc string (bug#18202). (cherry picked from commit a10eb168cc96db9f0dab2d75550cbd8f08be2363) --- lisp/simple.el | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/lisp/simple.el b/lisp/simple.el index 8965eb716be..24d2d7fbc0f 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -145,18 +145,18 @@ nil means use goto-char using the second argument position.") &optional avoid-current extra-test-inclusive extra-test-exclusive) - "Test if BUFFER is a `next-error' capable buffer. - -If AVOID-CURRENT is non-nil, treat the current buffer -as an absolute last resort only. - -The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer -that normally would not qualify. If it returns t, the buffer -in question is treated as usable. - -The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer -that would normally be considered usable. If it returns nil, -that buffer is rejected." + "Return non-nil if BUFFER is a `next-error' capable buffer. +If AVOID-CURRENT is non-nil, and BUFFER is the current buffer, +return nil. + +The function EXTRA-TEST-INCLUSIVE, if non-nil, is called if +BUFFER would not normally qualify. If it returns non-nil, BUFFER +is considered `next-error' capable, anyway, and the function +returns non-nil. + +The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called if the +buffer would normally qualify. If it returns nil, BUFFER is +rejected, and the function returns nil." (and (buffer-name buffer) ;First make sure it's live. (not (and avoid-current (eq buffer (current-buffer)))) (with-current-buffer buffer -- cgit v1.2.1 From 7a03d55230ff9814bb9c0e19913f3a537dc1ebec Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 15:27:09 +0200 Subject: Clarify whitespace-style doc string * lisp/whitespace.el (whitespace-style): Doc clarification (bug#18296). (cherry picked from commit d96c720d0cca7c9ffbb4c712ad315bb707d6625c) --- lisp/whitespace.el | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/lisp/whitespace.el b/lisp/whitespace.el index 53bf363daa4..af906bab38f 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el @@ -528,14 +528,14 @@ these values is: 2. space-before-tab::tab 3. space-before-tab::space -So, for example, if indentation and indentation::space are -included in `whitespace-style' list, the indentation value is -evaluated instead of indentation::space value. - -One reason for not visualize spaces via faces (if `face' is not -included in `whitespace-style') is to use exclusively for -cleaning up a buffer. See `whitespace-cleanup' and -`whitespace-cleanup-region' for documentation. +For example, if `indentation' and `indentation::space' are +included in `whitespace-style', the `indentation' value is used +instead of the `indentation::space' value. + +One reason to not use faces to visualize spaces (i.e., not +include `face' in `whitespace-style') is to use `whitespace-mode' +only for cleaning up a buffer. See `whitespace-cleanup' and +`whitespace-cleanup-region'. See also `whitespace-display-mappings' for documentation." :type '(set :tag "Kind of Blank" -- cgit v1.2.1 From 05194cbeaf80ce53e3eb00b91fe67ff143a51cfc Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 15:55:44 +0200 Subject: Doc fix for font-lock-remove-keywords * lisp/font-lock.el (font-lock-remove-keywords): Add a link to `font-lock-add-keywords' to describe KEYWORDS (bug#18634). (cherry picked from commit bc00dcf12983cd399127d0eea39647f29778eb02) --- lisp/font-lock.el | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/lisp/font-lock.el b/lisp/font-lock.el index 6f94f353c90..634073c2867 100644 --- a/lisp/font-lock.el +++ b/lisp/font-lock.el @@ -785,8 +785,11 @@ see the variables `c-font-lock-extra-types', `c++-font-lock-extra-types', (defun font-lock-remove-keywords (mode keywords) "Remove highlighting KEYWORDS for MODE. -MODE should be a symbol, the major mode command name, such as `c-mode' -or nil. If nil, highlighting keywords are removed for the current buffer. +MODE should be a symbol, the major mode command name, such as +`c-mode' or nil. If nil, highlighting keywords are removed for +the current buffer. + +For a description of KEYWORDS, see `font-lock-add-keywords'. To make the removal apply to modes derived from MODE as well, pass nil for MODE and add the call to MODE-hook. This may fail -- cgit v1.2.1 From 925af7e0bec15151149a2132d203753ad7610182 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 16:08:07 +0200 Subject: Fill the doc string of font-lock-keywords * lisp/font-lock.el (font-lock-keywords): Fill the lines and reorganise some explanations (bug#21427). (cherry picked from commit c05716d3a26ea7518b89eacfccaf70c9d0731df7) --- lisp/font-lock.el | 174 ++++++++++++++++++++++++++++++------------------------ 1 file changed, 97 insertions(+), 77 deletions(-) diff --git a/lisp/font-lock.el b/lisp/font-lock.el index 634073c2867..8ee9f69fc1a 100644 --- a/lisp/font-lock.el +++ b/lisp/font-lock.el @@ -364,105 +364,125 @@ Each element in a user-level keywords list should have one of these forms: (MATCHER HIGHLIGHT ...) (eval . FORM) -where MATCHER can be either the regexp to search for, or the function name to -call to make the search (called with one argument, the limit of the search; -it should return non-nil, move point, and set `match-data' appropriately if -it succeeds; like `re-search-forward' would). -MATCHER regexps can be generated via the function `regexp-opt'. - -FORM is an expression, whose value should be a keyword element, evaluated when -the keyword is (first) used in a buffer. This feature can be used to provide a -keyword that can only be generated when Font Lock mode is actually turned on. +where MATCHER can be either the regexp to search for, or the +function name to call to make the search (called with one +argument, the limit of the search; it should return non-nil, move +point, and set `match-data' appropriately if it succeeds; like +`re-search-forward' would). MATCHER regexps can be generated via +the function `regexp-opt'. + +FORM is an expression, whose value should be a keyword element, +evaluated when the keyword is (first) used in a buffer. This +feature can be used to provide a keyword that can only be +generated when Font Lock mode is actually turned on. HIGHLIGHT should be either MATCH-HIGHLIGHT or MATCH-ANCHORED. -For highlighting single items, for example each instance of the word \"foo\", -typically only MATCH-HIGHLIGHT is required. -However, if an item or (typically) items are to be highlighted following the -instance of another item (the anchor), for example each instance of the -word \"bar\" following the word \"anchor\" then MATCH-ANCHORED may be required. +For highlighting single items, for example each instance of the +word \"foo\", typically only MATCH-HIGHLIGHT is required. +However, if an item or (typically) items are to be highlighted +following the instance of another item (the anchor), for example +each instance of the word \"bar\" following the word \"anchor\" +then MATCH-ANCHORED may be required. MATCH-HIGHLIGHT should be of the form: (SUBEXP FACENAME [OVERRIDE [LAXMATCH]]) -SUBEXP is the number of the subexpression of MATCHER to be highlighted. +SUBEXP is the number of the subexpression of MATCHER to be +highlighted. FACENAME is an expression whose value is the face name to use. -Instead of a face, FACENAME can evaluate to a property list -of the form (face FACE PROP1 VAL1 PROP2 VAL2 ...) -in which case all the listed text-properties will be set rather than -just FACE. In such a case, you will most likely want to put those -properties in `font-lock-extra-managed-props' or to override +Instead of a face, FACENAME can evaluate to a property list of +the form (face FACE PROP1 VAL1 PROP2 VAL2 ...) in which case all +the listed text-properties will be set rather than just FACE. In +such a case, you will most likely want to put those properties in +`font-lock-extra-managed-props' or to override `font-lock-unfontify-region-function'. -OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing fontification can -be overwritten. If `keep', only parts not already fontified are highlighted. -If `prepend' or `append', existing fontification is merged with the new, in -which the new or existing fontification, respectively, takes precedence. -If LAXMATCH is non-nil, that means don't signal an error if there is +OVERRIDE and LAXMATCH are flags. If OVERRIDE is t, existing +fontification can be overwritten. If `keep', only parts not +already fontified are highlighted. If `prepend' or `append', +existing fontification is merged with the new, in which the new +or existing fontification, respectively, takes precedence. If +LAXMATCH is non-nil, that means don't signal an error if there is no match for SUBEXP in MATCHER. -For example, an element of the form highlights (if not already highlighted): +For example, an element of the form highlights (if not already +highlighted): + + \"\\\\\\=\" + Discrete occurrences of \"foo\" in the value of the variable + `font-lock-keyword-face'. + + (\"fu\\\\(bar\\\\)\" . 1) + Substring \"bar\" within all occurrences of \"fubar\" in the + value of `font-lock-keyword-face'. + + (\"fubar\" . fubar-face) + Occurrences of \"fubar\" in the value of `fubar-face'. - \"\\\\\\=\" discrete occurrences of \"foo\" in the value of the - variable `font-lock-keyword-face'. - (\"fu\\\\(bar\\\\)\" . 1) substring \"bar\" within all occurrences of \"fubar\" in - the value of `font-lock-keyword-face'. - (\"fubar\" . fubar-face) Occurrences of \"fubar\" in the value of `fubar-face'. (\"foo\\\\|bar\" 0 foo-bar-face t) - occurrences of either \"foo\" or \"bar\" in the value - of `foo-bar-face', even if already highlighted. + Occurrences of either \"foo\" or \"bar\" in the value of + `foo-bar-face', even if already highlighted. + (fubar-match 1 fubar-face) - the first subexpression within all occurrences of - whatever the function `fubar-match' finds and matches - in the value of `fubar-face'. + The first subexpression within all occurrences of whatever the + function `fubar-match' finds and matches in the value of + `fubar-face'. MATCH-ANCHORED should be of the form: (MATCHER PRE-MATCH-FORM POST-MATCH-FORM MATCH-HIGHLIGHT ...) -where MATCHER is a regexp to search for or the function name to call to make -the search, as for MATCH-HIGHLIGHT above, but with one exception; see below. -PRE-MATCH-FORM and POST-MATCH-FORM are evaluated before the first, and after -the last, instance MATCH-ANCHORED's MATCHER is used. Therefore they can be -used to initialize before, and cleanup after, MATCHER is used. Typically, -PRE-MATCH-FORM is used to move to some position relative to the original -MATCHER, before starting with MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might -be used to move back, before resuming with MATCH-ANCHORED's parent's MATCHER. - -For example, an element of the form highlights (if not already highlighted): - - (\"\\\\\\=\" (0 anchor-face) (\"\\\\\\=\" nil nil (0 item-face))) - - discrete occurrences of \"anchor\" in the value of `anchor-face', and subsequent - discrete occurrences of \"item\" (on the same line) in the value of `item-face'. - (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore \"item\" is - initially searched for starting from the end of the match of \"anchor\", and - searching for subsequent instances of \"anchor\" resumes from where searching - for \"item\" concluded.) - -The above-mentioned exception is as follows. The limit of the MATCHER search -defaults to the end of the line after PRE-MATCH-FORM is evaluated. -However, if PRE-MATCH-FORM returns a position greater than the position after -PRE-MATCH-FORM is evaluated, that position is used as the limit of the search. -It is generally a bad idea to return a position greater than the end of the -line, i.e., cause the MATCHER search to span lines. - -These regular expressions can match text which spans lines, although -it is better to avoid it if possible since updating them while editing -text is slower, and it is not guaranteed to be always correct when using -support modes like jit-lock or lazy-lock. - -This variable is set by major modes via the variable `font-lock-defaults'. -Be careful when composing regexps for this list; a poorly written pattern can -dramatically slow things down! - -A compiled keywords list starts with t. It is produced internally -by `font-lock-compile-keywords' from a user-level keywords list. -Its second element is the user-level keywords list that was -compiled. The remaining elements have the same form as -user-level keywords, but normally their values have been +where MATCHER is a regexp to search for or the function name to +call to make the search, as for MATCH-HIGHLIGHT above, but with +one exception; see below. PRE-MATCH-FORM and POST-MATCH-FORM are +evaluated before the first, and after the last, instance +MATCH-ANCHORED's MATCHER is used. Therefore they can be used to +initialize before, and cleanup after, MATCHER is used. +Typically, PRE-MATCH-FORM is used to move to some position +relative to the original MATCHER, before starting with +MATCH-ANCHORED's MATCHER. POST-MATCH-FORM might be used to move +back, before resuming with MATCH-ANCHORED's parent's MATCHER. + +For example, an element of the form highlights (if not already +highlighted): + + (\"\\\\\\=\" (0 anchor-face) + (\"\\\\\\=\" nil nil (0 item-face))) + + Discrete occurrences of \"anchor\" in the value of + `anchor-face', and subsequent discrete occurrences of + \"item\" (on the same line) in the value of `item-face'. + (Here PRE-MATCH-FORM and POST-MATCH-FORM are nil. Therefore + \"item\" is initially searched for starting from the end of the + match of \"anchor\", and searching for subsequent instances of + \"anchor\" resumes from where searching for \"item\" concluded.) + +The above-mentioned exception is as follows. The limit of the +MATCHER search defaults to the end of the line after +PRE-MATCH-FORM is evaluated. However, if PRE-MATCH-FORM returns +a position greater than the position after PRE-MATCH-FORM is +evaluated, that position is used as the limit of the search. It +is generally a bad idea to return a position greater than the end +of the line, i.e., cause the MATCHER search to span lines. + +These regular expressions can match text which spans lines, +although it is better to avoid it if possible since updating them +while editing text is slower, and it is not guaranteed to be +always correct when using support modes like jit-lock or +lazy-lock. + +This variable is set by major modes via the variable +`font-lock-defaults'. Be careful when composing regexps for this +list; a poorly written pattern can dramatically slow things down! + +A compiled keywords list starts with t. It is produced +internally by `font-lock-compile-keywords' from a user-level +keywords list. Its second element is the user-level keywords +list that was compiled. The remaining elements have the same +form as user-level keywords, but normally their values have been optimized.") (defvar font-lock-keywords-alist nil -- cgit v1.2.1 From 0846f21b77d38a568c4ceb143504472a2dd51aee Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 16:15:46 +0200 Subject: Tiny doc clarification for create-fontset-from-fontset-spec * lisp/international/fontset.el (create-fontset-from-fontset-spec): Clarify what the optional part is (bug#18686). (cherry picked from commit c05d186455ce9907eeb6b21ea4227e453996c681) --- lisp/international/fontset.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lisp/international/fontset.el b/lisp/international/fontset.el index 90905a2ade9..612c0a08ad7 100644 --- a/lisp/international/fontset.el +++ b/lisp/international/fontset.el @@ -1259,7 +1259,7 @@ to map charsets to scripts.") &optional _style-variant _noerror) "Create a fontset from fontset specification string FONTSET-SPEC. FONTSET-SPEC is a string of the format: - FONTSET-NAME,SCRIPT-NAME0:FONT-NAME0,SCRIPT-NAME1:FONT-NAME1, ... + FONTSET-NAME[,SCRIPT-NAME0:FONT-NAME0,SCRIPT-NAME1:FONT-NAME1] ... Any number of SPACE, TAB, and NEWLINE can be put before and after commas. When a frame uses the fontset as the `font' parameter, the frame's -- cgit v1.2.1 From 619f1edec7b14790090c05a2dcddf37253b06bfe Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 16:21:54 +0200 Subject: Move doc of backup-directory-alist to the Backup node * doc/emacs/files.texi (Backup): Move the documentation of `backup-directory-alist' here from the "Single or Numbered Backups" node, because it doesn't seem to have much to do with numbering (bug#18692). (cherry picked from commit e77b8d84b4161f2cf8720dec2bf44a3e50134398) --- doc/emacs/files.texi | 25 ++++++++++++------------- 1 file changed, 12 insertions(+), 13 deletions(-) diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index ab20d4a18f9..af7a2fc2f3d 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi @@ -522,6 +522,18 @@ a new backup file. @kbd{C-u C-u C-u C-x C-s} does both things: it makes a backup from the previous contents, and arranges to make another from the newly saved contents if you save again. +@vindex backup-directory-alist + You can customize the variable @code{backup-directory-alist} to +specify that files matching certain patterns should be backed up in +specific directories. A typical use is to add an element @code{("." +. @var{dir})} to make all backups in the directory with absolute name +@var{dir}. Emacs modifies the backup file names to avoid clashes +between files with the same names originating in different +directories. Alternatively, adding, @code{("." . ".~")} would make +backups in the invisible subdirectory @file{.~} of the original file's +directory. Emacs creates the directory, if necessary, to make the +backup. + @menu * Names: Backup Names. How backup files are named. * Deletion: Backup Deletion. Emacs deletes excess numbered backups. @@ -585,19 +597,6 @@ value is @samp{nil} or @samp{existing}, then @code{version-control} becomes @code{nil}; if it is @samp{never} or @samp{simple}, then @code{version-control} becomes @code{never}. -@vindex backup-directory-alist - You can customize the variable @code{backup-directory-alist} to -specify that files matching certain patterns should be backed up in -specific directories. This variable applies to both single and -numbered backups. A typical use is to add an element @code{("." -. @var{dir})} to make all backups in the directory with absolute name -@var{dir}; Emacs modifies the backup file names to avoid clashes -between files with the same names originating in different -directories. Alternatively, adding, @code{("." . ".~")} would make -backups in the invisible subdirectory @file{.~} of the original file's -directory. Emacs creates the directory, if necessary, to make the -backup. - @vindex make-backup-file-name-function If you set the variable @code{make-backup-file-name-function} to a suitable Lisp function, you can override the usual way Emacs -- cgit v1.2.1 From a73de71b848da17719dcbbb9206302c09e0f79b9 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 16:28:52 +0200 Subject: Doc fix for insert-pair-alist * lisp/emacs-lisp/lisp.el (insert-pair-alist): Say what COMMAND-CHAR is (bug#18809). (cherry picked from commit 2824c587e9749a8f350f1d3dddd65176b4561dcb) --- lisp/emacs-lisp/lisp.el | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/lisp/emacs-lisp/lisp.el b/lisp/emacs-lisp/lisp.el index 764d01ce6db..ea7cce67be7 100644 --- a/lisp/emacs-lisp/lisp.el +++ b/lisp/emacs-lisp/lisp.el @@ -587,7 +587,11 @@ Interactively, the behavior depends on `narrow-to-defun-include-comments'." Each element looks like (OPEN-CHAR CLOSE-CHAR) or (COMMAND-CHAR OPEN-CHAR CLOSE-CHAR). The characters OPEN-CHAR and CLOSE-CHAR of the pair whose key is equal to the last input character with -or without modifiers, are inserted by `insert-pair'.") +or without modifiers, are inserted by `insert-pair'. + +If COMMAND-CHAR is specified, it is a character that triggers the +insertion of the open/close pair, and COMMAND-CHAR itself isn't +inserted.") (defun insert-pair (&optional arg open close) "Enclose following ARG sexps in a pair of OPEN and CLOSE characters. -- cgit v1.2.1 From 137868051e5ce4c4ba9cc92caa26fbf968e6f208 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 16:44:06 +0200 Subject: Have the doc strings of `load-path' and `require' mention each other * src/fns.c (Frequire): Mention `load-path' and fill the doc string (bug#18829). * src/lread.c (syms_of_lread): Mention that `require' uses `load-path'. (cherry picked from commit 3eca9a03816f95da0030665223c0b5262f223ba7) --- src/fns.c | 29 ++++++++++++++++++----------- src/lread.c | 1 + 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/src/fns.c b/src/fns.c index 9bbbb6d7b71..ef6055c17d1 100644 --- a/src/fns.c +++ b/src/fns.c @@ -2762,17 +2762,24 @@ require_unwind (Lisp_Object old_value) DEFUN ("require", Frequire, Srequire, 1, 3, 0, doc: /* If feature FEATURE is not loaded, load it from FILENAME. -If FEATURE is not a member of the list `features', then the feature -is not loaded; so load the file FILENAME. -If FILENAME is omitted, the printname of FEATURE is used as the file name, -and `load' will try to load this name appended with the suffix `.elc', -`.el', or the system-dependent suffix for dynamic module files, in that -order. The name without appended suffix will not be used. -See `get-load-suffixes' for the complete list of suffixes. -If the optional third argument NOERROR is non-nil, -then return nil if the file is not found instead of signaling an error. -Normally the return value is FEATURE. -The normal messages at start and end of loading FILENAME are suppressed. */) +If FEATURE is not a member of the list `features', then the feature is +not loaded; so load the file FILENAME. + +If FILENAME is omitted, the printname of FEATURE is used as the file +name, and `load' will try to load this name appended with the suffix +`.elc', `.el', or the system-dependent suffix for dynamic module +files, in that order. The name without appended suffix will not be +used. See `get-load-suffixes' for the complete list of suffixes. + +The directories in `load-path' are searched when trying to find the +file name. + +If the optional third argument NOERROR is non-nil, then return nil if +the file is not found instead of signaling an error. Normally the +return value is FEATURE. + +The normal messages at start and end of loading FILENAME are +suppressed. */) (Lisp_Object feature, Lisp_Object filename, Lisp_Object noerror) { Lisp_Object tem; diff --git a/src/lread.c b/src/lread.c index d374406e7b9..ef58b20070d 100644 --- a/src/lread.c +++ b/src/lread.c @@ -4508,6 +4508,7 @@ were read in. */); doc: /* List of directories to search for files to load. Each element is a string (directory file name) or nil (meaning `default-directory'). +This list is consulted by the `require' function. Initialized during startup as described in Info node `(elisp)Library Search'. Use `directory-file-name' when adding items to this path. However, Lisp programs that process this list should tolerate directories both with -- cgit v1.2.1 From 8f1e784f19c74702947c99d321d20fd1156b432c Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 16:48:50 +0200 Subject: Explictly explain that package-initialize loads the packages * lisp/emacs-lisp/package.el (package-initialize): Be explicit in saying that `package-initialize' obviates adjusting the path or requiring the packages, as this is a question that apparently comes up now and then (bug#18829). (cherry picked from commit 619e0aedb2f3dbfe6821ac34e2d25b4e5c181117) --- lisp/emacs-lisp/package.el | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lisp/emacs-lisp/package.el b/lisp/emacs-lisp/package.el index 7a5b020203e..3f0e972afeb 100644 --- a/lisp/emacs-lisp/package.el +++ b/lisp/emacs-lisp/package.el @@ -1426,7 +1426,10 @@ If `user-init-file' does not mention `(package-initialize)', add it to the file. If called as part of loading `user-init-file', set `package-enable-at-startup' to nil, to prevent accidentally -loading packages twice." +loading packages twice. +It is not necessary to adjust `load-path' or `require' the +individual packages after calling `package-initialize' -- this is +taken care of by `package-initialize'." (interactive) (setq package-alist nil) (if (equal user-init-file load-file-name) -- cgit v1.2.1 From ed8474e6ff468b3f395f634c032e8f6cee7b8bde Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 17:39:05 +0200 Subject: Clarify the doc of eval-expression-print-format * lisp/simple.el (eval-expression-print-format): Doc clarification (bug#19114). (cherry picked from commit cd193a871f5a8e1c81ba86fc398ac382fa814383) --- lisp/simple.el | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/lisp/simple.el b/lisp/simple.el index 24d2d7fbc0f..97b40bd214e 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -1418,10 +1418,11 @@ If nil, don't change the value of `debug-on-error'." :version "21.1") (defun eval-expression-print-format (value) - "Format VALUE as a result of evaluated expression. -Return a formatted string which is displayed in the echo area -in addition to the value printed by prin1 in functions which -display the result of expression evaluation." + "If VALUE in an integer, return a specially formatted string. +This string will typically look like \" (#o1, #x1, ?\\C-a)\". +If VALUE is not an integer, nil is returned. +This function is used by functions like `prin1' that display the +result of expression evaluation." (if (and (integerp value) (or (eq standard-output t) (zerop (prefix-numeric-value current-prefix-arg)))) -- cgit v1.2.1 From 2ef780f306a2168a02d2afc050585cd7ada3ddb0 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 17:50:09 +0200 Subject: Doc clarification to mwheel-scroll * lisp/mwheel.el (mwheel-scroll): Mention that the restriction does not apply to Windows (bug#19209). (cherry picked from commit 696052b5fdfbc5c25dff3c6b081aebe70f6d06c7) --- lisp/mwheel.el | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lisp/mwheel.el b/lisp/mwheel.el index f1450d470fc..9e03854fd11 100644 --- a/lisp/mwheel.el +++ b/lisp/mwheel.el @@ -187,7 +187,8 @@ This can be slightly disconcerting, but some people prefer it." (defun mwheel-scroll (event) "Scroll up or down according to the EVENT. -This should only be bound to mouse buttons 4 and 5." +This should be bound only to mouse buttons 4 and 5 on non-Windows +systems." (interactive (list last-input-event)) (let* ((curwin (if mouse-wheel-follow-mouse (prog1 -- cgit v1.2.1 From ad5572b20f46dc678989cecd2d64926e1e1c846c Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 17:57:57 +0200 Subject: Fix custom types for cursor-in-non-selected-windows * lisp/cus-start.el (standard): Use the same custom types for cursor-in-non-selected-windows as for cursor-type (bug#19214). (cherry picked from commit b66bc0cced786e0320e1c3b0758bd3c434d4e8b5) --- lisp/cus-start.el | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/lisp/cus-start.el b/lisp/cus-start.el index 5be61ce537c..001d638ca14 100644 --- a/lisp/cus-start.el +++ b/lisp/cus-start.el @@ -54,7 +54,8 @@ ;; :risky - risky-local-variable property ;; :safe - safe-local-variable property ;; :tag - custom-tag property -(let (standard native-p prop propval +(let (standard + native-p prop propval ;; This function turns a value ;; into an expression which produces that value. (quoter (lambda (sexp) @@ -67,27 +68,27 @@ (stringp sexp) (numberp sexp)) sexp - (list 'quote sexp))))) + (list 'quote sexp)))) + (cursor-type-types + '(choice + (const :tag "Frame default" t) + (const :tag "Filled box" box) + (const :tag "Hollow cursor" hollow) + (const :tag "Vertical bar" bar) + (cons :tag "Vertical bar with specified width" + (const bar) integer) + (const :tag "Horizontal bar" hbar) + (cons :tag "Horizontal bar with specified width" + (const hbar) integer) + (const :tag "None "nil)))) (pcase-dolist (`(,symbol ,group ,type ,version . ,rest) - '(;; alloc.c + `(;; alloc.c (gc-cons-threshold alloc integer) (gc-cons-percentage alloc float) (garbage-collection-messages alloc boolean) ;; buffer.c - (cursor-type - display - (choice - (const :tag "Frame default" t) - (const :tag "Filled box" box) - (const :tag "Hollow cursor" hollow) - (const :tag "Vertical bar" bar) - (cons :tag "Vertical bar with specified width" - (const bar) integer) - (const :tag "Horizontal bar" hbar) - (cons :tag "Horizontal bar with specified width" - (const hbar) integer) - (const :tag "None "nil))) + (cursor-type display ,cursor-type-types) (mode-line-format mode-line sexp) ;Hard to do right. (major-mode internal function) (case-fold-search matching boolean) @@ -147,7 +148,7 @@ Leaving \"Default\" unchecked is equivalent with specifying a default of (line-spacing display (choice (const :tag "none" nil) number) "22.1") (cursor-in-non-selected-windows - cursor boolean nil + cursor ,cursor-type-types nil :tag "Cursor In Non-selected Windows" :set (lambda (symbol value) (set-default symbol value) -- cgit v1.2.1 From f92d0aa141a0d97f8eb0de7253cc56931a62816d Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 18:07:15 +0200 Subject: insert-file-contents-literally doc fix * lisp/files.el (insert-file-contents-literally): Say that the parameters are explained in the other function (bug#18317). (cherry picked from commit b6481b19bc9592492b1f70dfecb4de6256f537fe) --- lisp/files.el | 1 + 1 file changed, 1 insertion(+) diff --git a/lisp/files.el b/lisp/files.el index 5cdd3849f19..f9c6c5185e3 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -2143,6 +2143,7 @@ Do you want to revisit the file normally now? ") (defun insert-file-contents-literally (filename &optional visit beg end replace) "Like `insert-file-contents', but only reads in the file literally. +See `insert-file-contents' for an explanation of the parameters. A buffer may be modified in several ways after reading into the buffer, due to Emacs features such as format decoding, character code conversion, `find-file-hook', automatic uncompression, etc. -- cgit v1.2.1 From b04fcc4a38f9ad0cff43ecccc28934e8769f3538 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 18:20:29 +0200 Subject: Fcompare_buffer_substrings doc string clarification * src/editfns.c (Fcompare_buffer_substrings): Extremely minor doc string clarification (bug#19255). (cherry picked from commit aa692acbb598a1cc8219ed7a87dde25fd7626ba5) --- src/editfns.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/src/editfns.c b/src/editfns.c index 94b949583ad..f0ce4e7cf34 100644 --- a/src/editfns.c +++ b/src/editfns.c @@ -2882,10 +2882,9 @@ DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_ 6, 6, 0, doc: /* Compare two substrings of two buffers; return result as number. Return -N if first string is less after N-1 chars, +N if first string is -greater after N-1 chars, or 0 if strings match. Each substring is -represented as three arguments: BUFFER, START and END. That makes six -args in all, three for each substring. - +greater after N-1 chars, or 0 if strings match. +The first substring is in BUFFER1 from START1 to END1 and the second +is in BUFFER2 from START2 to END2. The value of `case-fold-search' in the current buffer determines whether case is significant or ignored. */) (Lisp_Object buffer1, Lisp_Object start1, Lisp_Object end1, Lisp_Object buffer2, Lisp_Object start2, Lisp_Object end2) -- cgit v1.2.1 From 93598ff382725e07511fb62b4b4bc9b49bd9d834 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 18:31:05 +0200 Subject: (default-mode-line-format): More explicit obsolete info * lisp/subr.el (default-mode-line-format): Be more explicit in how default values are now handled (bug#19424). (cherry picked from commit 9dc5f6d830e72420dc4d41c8f6ca1ca6b28609c0) --- lisp/subr.el | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lisp/subr.el b/lisp/subr.el index 00a947397ae..23e7d01e6de 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -1322,7 +1322,9 @@ is converted into a string by expressing it in decimal." ;; buffer-local. ;; Not used at all in Emacs, last time I checked: -(make-obsolete-variable 'default-mode-line-format 'mode-line-format "23.2") +(make-obsolete-variable 'default-mode-line-format + "use (setq-default mode-line-format) or (default-value mode-line-format) instead" + "23.2") (make-obsolete-variable 'default-header-line-format 'header-line-format "23.2") (make-obsolete-variable 'default-line-spacing 'line-spacing "23.2") (make-obsolete-variable 'default-abbrev-mode 'abbrev-mode "23.2") -- cgit v1.2.1 From ff834ffe06e858c6d511419b5f030ef091f83032 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 18:46:58 +0200 Subject: Add a link from Tool Bar to Images * doc/lispref/keymaps.texi (Tool Bar): Add a link to the Images node (bug#19722). (cherry picked from commit da5d0786163a91400eced4fddba4a92b652458d1) --- doc/lispref/keymaps.texi | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi index 0ea30283d7d..61ac80c589c 100644 --- a/doc/lispref/keymaps.texi +++ b/doc/lispref/keymaps.texi @@ -2605,8 +2605,8 @@ this is how you specify the image to display in the tool bar: @table @code @item :image @var{image} -@var{images} is either a single image specification or a vector of four -image specifications. If you use a vector of four, +@var{image} is either a single image specification (@pxref{Images}) or +a vector of four image specifications. If you use a vector of four, one of them is used, depending on circumstances: @table @asis -- cgit v1.2.1 From ec392ff1a3ce6bd4d32371be454003f642812d5b Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 18:48:05 +0200 Subject: cursor-type doc fix * src/buffer.c (syms_of_buffer): Mention that cursor-type's WIDHT/HEIGHT can't exceed the frame char size (bug#19215). (cherry picked from commit 77c5f4554ebb3b7c7d49bc881e45a550f6c93987) --- src/buffer.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/buffer.c b/src/buffer.c index f06d7e08e49..e4269c0046a 100644 --- a/src/buffer.c +++ b/src/buffer.c @@ -6233,6 +6233,8 @@ Values are interpreted as follows: (hbar . HEIGHT) display a horizontal bar cursor with height HEIGHT ANYTHING ELSE display a hollow box cursor +WIDTH and HEIGHT can't exceed the frame's canonical character size. + When the buffer is displayed in a non-selected window, the cursor's appearance is instead controlled by the variable `cursor-in-non-selected-windows'. */); -- cgit v1.2.1 From 2abc85e41edafbb9c1187c5445056cc07759b4c1 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 19:20:12 +0200 Subject: Transform mentions of `eval-after-load' to `with-eval-after-load' * doc/lispref/loading.texi (Hooks for Loading): Update text to not mention `eval-after-load' (bug#20038). (cherry picked from commit 9392193be56eebdfac702a0bbb5e954088371c7a) --- doc/emacs/text.texi | 3 +- doc/emacs/trouble.texi | 2 +- doc/lispref/loading.texi | 11 +++---- doc/lispref/tips.texi | 12 ++++---- doc/misc/eudc.texi | 22 +++++++------- doc/misc/gnus-faq.texi | 75 ++++++++++++++++++++++++------------------------ doc/misc/gnus.texi | 16 +++++------ doc/misc/rcirc.texi | 56 ++++++++++++++++++------------------ doc/misc/tramp.texi | 6 ++-- 9 files changed, 101 insertions(+), 102 deletions(-) diff --git a/doc/emacs/text.texi b/doc/emacs/text.texi index e19925025d7..66f01b495d1 100644 --- a/doc/emacs/text.texi +++ b/doc/emacs/text.texi @@ -1302,7 +1302,8 @@ it in order for this to take effect. automatically by putting the following in your init file: @example -(eval-after-load "outline" '(require 'foldout)) +(with-eval-after-load "outline" + (require 'foldout)) @end example @node Org Mode diff --git a/doc/emacs/trouble.texi b/doc/emacs/trouble.texi index 32680633769..bff3a58651f 100644 --- a/doc/emacs/trouble.texi +++ b/doc/emacs/trouble.texi @@ -1359,7 +1359,7 @@ Appendix, elisp, Emacs Lisp Reference}. @end ifclear @item -Avoid using @code{defadvice} or @code{eval-after-load} for Lisp code +Avoid using @code{defadvice} or @code{with-eval-after-load} for Lisp code to be included in Emacs. @item diff --git a/doc/lispref/loading.texi b/doc/lispref/loading.texi index 06900a49477..d2d38d7fb5e 100644 --- a/doc/lispref/loading.texi +++ b/doc/lispref/loading.texi @@ -1089,11 +1089,12 @@ execution of the rest of @var{body}. @end defmac Normally, well-designed Lisp programs should not use -@code{eval-after-load}. If you need to examine and set the variables -defined in another library (those meant for outside use), you can do -it immediately---there is no need to wait until the library is loaded. -If you need to call functions defined by that library, you should load -the library, preferably with @code{require} (@pxref{Named Features}). +@code{with-eval-after-load}. If you need to examine and set the +variables defined in another library (those meant for outside use), +you can do it immediately---there is no need to wait until the library +is loaded. If you need to call functions defined by that library, you +should load the library, preferably with @code{require} (@pxref{Named +Features}). @node Dynamic Modules @section Emacs Dynamic Modules diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi index 0a3d244157e..d12de7aee2d 100644 --- a/doc/lispref/tips.texi +++ b/doc/lispref/tips.texi @@ -200,12 +200,12 @@ It is likewise a bad idea for one Lisp package to advise a function in another Lisp package (@pxref{Advising Functions}). @item -Avoid using @code{eval-after-load} in libraries and packages -(@pxref{Hooks for Loading}). This feature is meant for personal -customizations; using it in a Lisp program is unclean, because it -modifies the behavior of another Lisp file in a way that's not visible -in that file. This is an obstacle for debugging, much like advising a -function in the other package. +Avoid using @code{eval-after-load} and @code{with-eval-after-load} in +libraries and packages (@pxref{Hooks for Loading}). This feature is +meant for personal customizations; using it in a Lisp program is +unclean, because it modifies the behavior of another Lisp file in a +way that's not visible in that file. This is an obstacle for +debugging, much like advising a function in the other package. @item If a file does replace any of the standard functions or library diff --git a/doc/misc/eudc.texi b/doc/misc/eudc.texi index da63975c2e5..53f1beb1a0c 100644 --- a/doc/misc/eudc.texi +++ b/doc/misc/eudc.texi @@ -177,12 +177,10 @@ initialization file to add a shortcut for email address expansion in email composition buffers (@pxref{Inline Query Expansion}) @lisp -(eval-after-load - "message" - '(define-key message-mode-map [(control ?c) (tab)] 'eudc-expand-inline)) -(eval-after-load - "sendmail" - '(define-key mail-mode-map [(control ?c) (tab)] 'eudc-expand-inline)) +(with-eval-after-load "message" + (define-key message-mode-map [(control ?c) (tab)] 'eudc-expand-inline)) +(with-eval-after-load "sendmail" + (define-key mail-mode-map [(control ?c) (tab)] 'eudc-expand-inline)) @end lisp @menu @@ -271,8 +269,8 @@ LDAP: @vindex eudc-server-hotlist @vindex ldap-host-parameters-alist @lisp -(eval-after-load "message" - '(define-key message-mode-map (kbd "TAB") 'eudc-expand-inline)) +(with-eval-after-load "message" + (define-key message-mode-map (kbd "TAB") 'eudc-expand-inline)) (customize-set-variable 'eudc-server-hotlist '(("" . bbdb) ("ldaps://ldap.gnu.org" . ldap))) @@ -327,8 +325,8 @@ configure EUDC for LDAP: @vindex eudc-server-hotlist @vindex ldap-host-parameters-alist @lisp -(eval-after-load "message" - '(define-key message-mode-map (kbd "TAB") 'eudc-expand-inline)) +(with-eval-after-load "message" + (define-key message-mode-map (kbd "TAB") 'eudc-expand-inline)) (customize-set-variable 'eudc-server-hotlist '(("" . bbdb) ("ldaps://ldap.gnu.org" . ldap))) @@ -356,8 +354,8 @@ and the @file{.emacs} expressions become: @vindex eudc-server-hotlist @vindex ldap-host-parameters-alist @lisp -(eval-after-load "message" - '(define-key message-mode-map (kbd "TAB") 'eudc-expand-inline)) +(with-eval-after-load "message" + (define-key message-mode-map (kbd "TAB") 'eudc-expand-inline)) (customize-set-variable 'eudc-server-hotlist '(("" . bbdb) ("" . ldap))) (customize-set-variable 'ldap-host-parameters-alist diff --git a/doc/misc/gnus-faq.texi b/doc/misc/gnus-faq.texi index 90bb10f6c35..5a49f4ac325 100644 --- a/doc/misc/gnus-faq.texi +++ b/doc/misc/gnus-faq.texi @@ -584,10 +584,10 @@ Now we need to tell Gnus, where to get its mail from. If it's a POP3 server, then you need something like this: @example -(eval-after-load "mail-source" - '(add-to-list 'mail-sources '(pop :server "pop.YourProvider.net" - :user "yourUserName" - :password "yourPassword"))) +(with-eval-after-load "mail-source" + (add-to-list 'mail-sources '(pop :server "pop.YourProvider.net" + :user "yourUserName" + :password "yourPassword"))) @end example @noindent @@ -596,8 +596,8 @@ your password there. If you want to read your mail from a traditional spool file on your local machine, it's @example -(eval-after-load "mail-source" - '(add-to-list 'mail-sources '(file :path "/path/to/spool/file")) +(with-eval-after-load "mail-source" + (add-to-list 'mail-sources '(file :path "/path/to/spool/file")) @end example @noindent @@ -605,9 +605,9 @@ If it's a Maildir, with one file per message as used by postfix, Qmail and (optionally) fetchmail it's @example -(eval-after-load "mail-source" - '(add-to-list 'mail-sources '(maildir :path "/path/to/Maildir/" - :subdirs ("cur" "new"))) +(with-eval-after-load "mail-source" + (add-to-list 'mail-sources '(maildir :path "/path/to/Maildir/" + :subdirs ("cur" "new"))) @end example @noindent @@ -616,10 +616,10 @@ in one directory, for example because procmail already split your mail, it's @example -(eval-after-load "mail-source" - '(add-to-list 'mail-sources - '(directory :path "/path/to/procmail-dir/" - :suffix ".prcml"))) +(with-eval-after-load "mail-source" + (add-to-list 'mail-sources + '(directory :path "/path/to/procmail-dir/" + :suffix ".prcml"))) @end example @noindent @@ -850,10 +850,9 @@ text part if it's available. How to do it? Say @example -(eval-after-load "mm-decode" - '(progn - (add-to-list 'mm-discouraged-alternatives "text/html") - (add-to-list 'mm-discouraged-alternatives "text/richtext"))) +(with-eval-after-load "mm-decode" + (add-to-list 'mm-discouraged-alternatives "text/html") + (add-to-list 'mm-discouraged-alternatives "text/richtext")) @end example @noindent @@ -1577,14 +1576,14 @@ if you already use Gnus 5.10, if you still use 5.8.8 or 5.9 try this instead: @example -(eval-after-load "gnus-msg" - '(unless (boundp 'gnus-confirm-mail-reply-to-news) - (defadvice gnus-summary-reply (around reply-in-news activate) - "Request confirmation when replying to news." - (interactive) - (when (or (not (gnus-news-group-p gnus-newsgroup-name)) - (y-or-n-p "Really reply by mail to article author? ")) - ad-do-it)))) +(with-eval-after-load "gnus-msg" + (unless (boundp 'gnus-confirm-mail-reply-to-news) + (defadvice gnus-summary-reply (around reply-in-news activate) + "Request confirmation when replying to news." + (interactive) + (when (or (not (gnus-news-group-p gnus-newsgroup-name)) + (y-or-n-p "Really reply by mail to article author? ")) + ad-do-it)))) @end example @noindent @@ -1599,8 +1598,8 @@ Since 5.10 Gnus doesn't generate a sender header by default. For older Gnus' try this in @file{~/.gnus.el}: @example -(eval-after-load "message" - '(add-to-list 'message-syntax-checks '(sender . disabled))) +(with-eval-after-load "message" + (add-to-list 'message-syntax-checks '(sender . disabled))) @end example @noindent @@ -1665,14 +1664,14 @@ in @file{~/.gnus.el}. If you use Gnus 5.9 or earlier, you can use this instead (works for newer versions as well): @example -(eval-after-load "message" - '(let ((fqdn "yourmachine.yourdomain.tld"));; <-- Edit this! - (if (boundp 'message-user-fqdn) - (setq message-user-fqdn fqdn) - (gnus-message 1 "Redefining `message-make-fqdn'.") - (defun message-make-fqdn () - "Return user's fully qualified domain name." - fqdn)))) +(with-eval-after-load "message" + (let ((fqdn "yourmachine.yourdomain.tld"));; <-- Edit this! + (if (boundp 'message-user-fqdn) + (setq message-user-fqdn fqdn) + (gnus-message 1 "Redefining `message-make-fqdn'.") + (defun message-make-fqdn () + "Return user's fully qualified domain name." + fqdn)))) @end example @noindent @@ -2195,7 +2194,7 @@ An other idea would be to byte compile your @file{~/.gnus.el} (say @samp{M-x byte-compile-file RET ~/.gnus.el RET} to do it). Finally, if you have require statements in your .gnus, you could replace them with -eval-after-load, which loads the stuff not at startup +@code{with-eval-after-load}, which loads the stuff not at startup time, but when it's needed. Say you've got this in your @file{~/.gnus.el}: @@ -2209,8 +2208,8 @@ then as soon as you start Gnus, message.el is loaded. If you replace it with @example -(eval-after-load "message" - '(add-to-list 'message-syntax-checks '(sender . disabled))) +(with-eval-after-load "message" + (add-to-list 'message-syntax-checks '(sender . disabled))) @end example @noindent diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 2ae2e18ed00..08067b0c735 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -17147,9 +17147,9 @@ summary buffer. (gnus-summary-mark-as-read-forward 1)) (gnus-summary-scroll-up arg)))) -(eval-after-load "gnus" - #'(define-key gnus-summary-mode-map - (kbd "") 'browse-nnrss-url)) +(with-eval-after-load "gnus" + (define-key gnus-summary-mode-map + (kbd "") 'browse-nnrss-url)) (add-to-list 'nnmail-extra-headers nnrss-url-field) @end lisp @@ -17165,11 +17165,11 @@ Parameters}) in order to display @samp{text/html} parts only in @lisp ;; @r{Set the default value of @code{mm-discouraged-alternatives}.} -(eval-after-load "gnus-sum" - '(add-to-list - 'gnus-newsgroup-variables - '(mm-discouraged-alternatives - . '("text/html" "image/.*")))) +(with-eval-after-load "gnus-sum" + (add-to-list + 'gnus-newsgroup-variables + '(mm-discouraged-alternatives + . '("text/html" "image/.*")))) ;; @r{Display @samp{text/html} parts in @code{nnrss} groups.} (add-to-list diff --git a/doc/misc/rcirc.texi b/doc/misc/rcirc.texi index 0098e2049d8..cdead72c630 100644 --- a/doc/misc/rcirc.texi +++ b/doc/misc/rcirc.texi @@ -880,11 +880,11 @@ because @code{defun-rcirc-command} is not yet available, and without @code{rcirc} loaded, the command wouldn't do us much good anyway. @smallexample -(eval-after-load 'rcirc - '(defun-rcirc-command sv (arg) - "Boast about rcirc." - (interactive "i") - (rcirc-send-message process target +(with-eval-after-load 'rcirc + (defun-rcirc-command sv (arg) + "Boast about rcirc." + (interactive "i") + (rcirc-send-message process target (concat "I use " rcirc-id-string)))) @end smallexample @@ -904,29 +904,29 @@ copies of every channel buffer, one dead and one live. The real answer, therefore, is a @code{/reconnect} command: @smallexample -(eval-after-load 'rcirc - '(defun-rcirc-command reconnect (arg) - "Reconnect the server process." - (interactive "i") - (unless process - (error "There's no process for this target")) - (let* ((server (car (process-contact process))) - (port (process-contact process :service)) - (nick (rcirc-nick process)) - channels query-buffers) - (dolist (buf (buffer-list)) - (with-current-buffer buf - (when (eq process (rcirc-buffer-process)) - (remove-hook 'change-major-mode-hook - 'rcirc-change-major-mode-hook) - (if (rcirc-channel-p rcirc-target) - (setq channels (cons rcirc-target channels)) - (setq query-buffers (cons buf query-buffers)))))) - (delete-process process) - (rcirc-connect server port nick - rcirc-default-user-name - rcirc-default-full-name - channels)))) +(with-eval-after-load 'rcirc + (defun-rcirc-command reconnect (arg) + "Reconnect the server process." + (interactive "i") + (unless process + (error "There's no process for this target")) + (let* ((server (car (process-contact process))) + (port (process-contact process :service)) + (nick (rcirc-nick process)) + channels query-buffers) + (dolist (buf (buffer-list)) + (with-current-buffer buf + (when (eq process (rcirc-buffer-process)) + (remove-hook 'change-major-mode-hook + 'rcirc-change-major-mode-hook) + (if (rcirc-channel-p rcirc-target) + (setq channels (cons rcirc-target channels)) + (setq query-buffers (cons buf query-buffers)))))) + (delete-process process) + (rcirc-connect server port nick + rcirc-default-user-name + rcirc-default-full-name + channels)))) @end smallexample @node GNU Free Documentation License diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index 9320a6e166f..af22f8d6cc7 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -3390,9 +3390,9 @@ Since @file{filecache} remembers visited places, add the remote directory to the cache: @lisp -(eval-after-load "filecache" - '(file-cache-add-directory - "@trampfn{ssh,news@@news.my.domain,/opt/news/etc/}")) +(with-eval-after-load "filecache" + (file-cache-add-directory + "@trampfn{ssh,news@@news.my.domain,/opt/news/etc/}")) @end lisp Then use directory completion in the minibuffer with @kbd{C-x C-f -- cgit v1.2.1 From 818fb69bd2b48a4ba6359659383ab3e5e8ab6cb1 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 20:13:24 +0200 Subject: Extremely minor doc fix in Choosing Window * doc/lispref/windows.texi (Choosing Window): There's only one action alist, I think (bug#20158). (cherry picked from commit 6c7e7f421d02d9290d6d1d85320737371160aef7) --- doc/lispref/windows.texi | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/lispref/windows.texi b/doc/lispref/windows.texi index 0665eb9098d..55d90bd5d0d 100644 --- a/doc/lispref/windows.texi +++ b/doc/lispref/windows.texi @@ -2259,7 +2259,7 @@ display in. These steps are described by means of @dfn{display actions}, which have the form @code{(@var{function} . @var{alist})}. Here, @var{function} is either a function or a list of functions, which we refer to as @dfn{action functions}; @var{alist} is an -association list, which we refer to as @dfn{action alists}. +association list, which we refer to as an @dfn{action alist}. An action function accepts two arguments: the buffer to display and an action alist. It attempts to display the buffer in some window, -- cgit v1.2.1 From bbda22c6406ca6647626ea210292c7a279c80810 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 20:16:25 +0200 Subject: add-timeout doc fix * lisp/emacs-lisp/timer.el (add-timeout): Mention the return value (bug#20181). (cherry picked from commit 921b40476f597c84d7c34aa289cd43caeb389c4a) --- lisp/emacs-lisp/timer.el | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lisp/emacs-lisp/timer.el b/lisp/emacs-lisp/timer.el index 3f2e2fb5286..c01ea4973c7 100644 --- a/lisp/emacs-lisp/timer.el +++ b/lisp/emacs-lisp/timer.el @@ -424,6 +424,8 @@ This function returns a timer object which you can use in `cancel-timer'." (defun add-timeout (secs function object &optional repeat) "Add a timer to run SECS seconds from now, to call FUNCTION on OBJECT. If REPEAT is non-nil, repeat the timer every REPEAT seconds. + +This function returns a timer object which you can use in `cancel-timer'. This function is for compatibility; see also `run-with-timer'." (run-with-timer secs repeat function object)) -- cgit v1.2.1 From 983ad8d7da9685f5c718b417d4c11868c20c38c8 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 20:21:11 +0200 Subject: replace-match-maybe-edit doc clarification * lisp/replace.el (replace-match-maybe-edit): Say what MATCH-DATA is (bug#20304). (cherry picked from commit 139874ba53c2e2de9868f8e5234d6ea2bcb97af8) --- lisp/replace.el | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lisp/replace.el b/lisp/replace.el index a2344d9f7e7..da2b8c6e9b2 100644 --- a/lisp/replace.el +++ b/lisp/replace.el @@ -1997,7 +1997,9 @@ but coerced to the correct value of INTEGERS." FIXEDCASE, LITERAL are passed to `replace-match' (which see). After possibly editing it (if `\\?' is present), NEWTEXT is also passed to `replace-match'. If NOEDIT is true, no check for `\\?' -is made (to save time). MATCH-DATA is used for the replacement. +is made (to save time). +MATCH-DATA is used for the replacement, and is a data structure +as returned from the `match-data' function. In case editing is done, it is changed to use markers. BACKWARD is used to reverse the replacement direction. -- cgit v1.2.1 From f3f45020eb8347f8100a63635c6db275836c9b74 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 20:30:15 +0200 Subject: Fill the completion-table-with-predicate doc string * lisp/minibuffer.el (completion-table-with-predicate): Fill the doc string (bug#20460). (cherry picked from commit 207a31432c1ed8b548003a3e4af32c49aa3441e9) --- lisp/minibuffer.el | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 6540059b965..714ca851eb0 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el @@ -369,13 +369,15 @@ instead of a string, a function that takes the completion and returns the (defun completion-table-with-predicate (table pred1 strict string pred2 action) "Make a completion table equivalent to TABLE but filtered through PRED1. -PRED1 is a function of one argument which returns non-nil if and only if the -argument is an element of TABLE which should be considered for completion. -STRING, PRED2, and ACTION are the usual arguments to completion tables, -as described in `try-completion', `all-completions', and `test-completion'. -If STRICT is t, the predicate always applies; if nil it only applies if -it does not reduce the set of possible completions to nothing. -Note: TABLE needs to be a proper completion table which obeys predicates." +PRED1 is a function of one argument which returns non-nil if and +only if the argument is an element of TABLE which should be +considered for completion. STRING, PRED2, and ACTION are the +usual arguments to completion tables, as described in +`try-completion', `all-completions', and `test-completion'. If +STRICT is t, the predicate always applies; if nil it only applies +if it does not reduce the set of possible completions to nothing. +Note: TABLE needs to be a proper completion table which obeys +predicates." (cond ((and (not strict) (eq action 'lambda)) ;; Ignore pred1 since it doesn't really have to apply anyway. -- cgit v1.2.1 From afb22577de2f06542780870a0431d0ee533eb3ac Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 20:31:39 +0200 Subject: completion-table-with-predicate doc string fix * lisp/minibuffer.el (completion-table-with-predicate): t -> non-nil in the doc string (bug#20460). (cherry picked from commit b6a4d162208f239bc7804696d611ae52c686f138) --- lisp/minibuffer.el | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lisp/minibuffer.el b/lisp/minibuffer.el index 714ca851eb0..1ee05d32de5 100644 --- a/lisp/minibuffer.el +++ b/lisp/minibuffer.el @@ -374,10 +374,10 @@ only if the argument is an element of TABLE which should be considered for completion. STRING, PRED2, and ACTION are the usual arguments to completion tables, as described in `try-completion', `all-completions', and `test-completion'. If -STRICT is t, the predicate always applies; if nil it only applies -if it does not reduce the set of possible completions to nothing. -Note: TABLE needs to be a proper completion table which obeys -predicates." +STRICT is non-nil, the predicate always applies; if nil it only +applies if it does not reduce the set of possible completions to +nothing. Note: TABLE needs to be a proper completion table which +obeys predicates." (cond ((and (not strict) (eq action 'lambda)) ;; Ignore pred1 since it doesn't really have to apply anyway. -- cgit v1.2.1 From 7350d3d7b062daf0d5faae86f81043b13de08cea Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 21:13:48 +0200 Subject: apropos-print doc fix * lisp/apropos.el (apropos-print): Document the undocumented parameters (bug#20520). (cherry picked from commit 0714d7387812a151f59993ac77c7321724ef79b1) --- lisp/apropos.el | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/lisp/apropos.el b/lisp/apropos.el index eb145bdc571..72357742b60 100644 --- a/lisp/apropos.el +++ b/lisp/apropos.el @@ -1040,9 +1040,12 @@ Each element should have the format The return value is the list that was in `apropos-accumulator', sorted alphabetically by symbol name; but this function also sets `apropos-accumulator' to nil before returning. - -If SPACING is non-nil, it should be a string; separate items with that string. -If non-nil, TEXT is a string that will be printed as a heading." +If DO-KEYS is non-nil, output the key bindings. If NOSUBST is +nil, substitute \"ASCII quotes\" (i.e., grace accent and +apostrophe) with curly quotes), and if non-nil, leave them alone. +If SPACING is non-nil, it should be a string; separate items with +that string. If non-nil, TEXT is a string that will be printed +as a heading." (if (null apropos-accumulator) (message "No apropos matches for `%s'" apropos-pattern) (setq apropos-accumulator -- cgit v1.2.1 From ef32be609def28e77e0652a778239bb920569466 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 21:28:51 +0200 Subject: Rearrange the doc of query-replace slightly * lisp/replace.el (query-replace): Move the mention of the interactive prefix arg earlier so that users can find it (bug#20654). (cherry picked from commit bcc10761c3b968fa4534718116a0a601ed7da389) --- lisp/replace.el | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lisp/replace.el b/lisp/replace.el index da2b8c6e9b2..801c6058f74 100644 --- a/lisp/replace.el +++ b/lisp/replace.el @@ -301,6 +301,10 @@ In Transient Mark mode, if the mark is active, operate on the contents of the region. Otherwise, operate from point to the end of the buffer's accessible portion. +In interactive use, the prefix arg (non-nil DELIMITED in +non-interactive use), means replace only matches surrounded by +word boundaries. A negative prefix arg means replace backward. + Use \\\\[next-history-element] \ to pull the last incremental search string to the minibuffer that reads FROM-STRING, or invoke replacements from @@ -327,10 +331,6 @@ If `replace-character-fold' is non-nil, matching uses character folding, i.e. it ignores diacritics and other differences between equivalent character strings. -Third arg DELIMITED (prefix arg if interactive), if non-nil, means replace -only matches surrounded by word boundaries. A negative prefix arg means -replace backward. - Fourth and fifth arg START and END specify the region to operate on. To customize possible responses, change the bindings in `query-replace-map'." -- cgit v1.2.1 From 6d8c2d0fdcde087514625688c1d1966df0dfdb42 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 21:43:18 +0200 Subject: custom-buffer-style doc fix * lisp/cus-edit.el (custom-buffer-style): Document the `tree' value (bug#20724). (cherry picked from commit bcf0291d0cd02095b0809b1eb91f1e5c5c2ac5e3) --- lisp/cus-edit.el | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/lisp/cus-edit.el b/lisp/cus-edit.el index 9609a034c97..d7db3530099 100644 --- a/lisp/cus-edit.el +++ b/lisp/cus-edit.el @@ -1499,11 +1499,12 @@ Return non-nil if user chooses to customize, for use in (defcustom custom-buffer-style 'links "Control the presentation style for customization buffers. The value should be a symbol, one of: - -brackets: groups nest within each other with big horizontal brackets. -links: groups have links to subgroups." +`brackets': groups nest within each other with big horizontal brackets. +`links': groups have links to subgroups. +`tree': display groups as trees." :type '(radio (const brackets) - (const links)) + (const links) + (const tree)) :group 'custom-buffer) (defcustom custom-buffer-done-kill nil -- cgit v1.2.1 From ecdb340c2d306de173169d172b9641696dd7ac34 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 22:41:41 +0200 Subject: Add a doc string to display-time-string * lisp/time.el: Add a doc string to `display-time-string', because it's referred to in the manual, and is too mysterious otherwise (bug#21002). (cherry picked from commit 45559c584e5a4ddeed1539b028b50b95baa372f8) --- lisp/time.el | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/lisp/time.el b/lisp/time.el index e0d39b19586..ba5792441c4 100644 --- a/lisp/time.el +++ b/lisp/time.el @@ -108,7 +108,10 @@ A value of nil means 1 <= hh <= 12, and an AM/PM suffix is used." :type 'boolean :group 'display-time) -(defvar display-time-string nil) +(defvar display-time-string nil + "String used in mode lines to display a time string. +It should not be set directly, but is instead updated by the +`display-time' function.") ;;;###autoload(put 'display-time-string 'risky-local-variable t) (defcustom display-time-hook nil -- cgit v1.2.1 From 7907b82297844456c193a1c471272a4949bf7774 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 22:42:46 +0200 Subject: Add a cross ref to Optional Mode Line * doc/lispref/modes.texi (Mode Line Variables): Add a cross reference to the Emacs mode line node that explains things like `display-time-string' (bug#21002). (cherry picked from commit a3151a28789f413af73b14fbba557b2a587fca53) --- doc/lispref/modes.texi | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index 52cc8f86bcf..d2eebb7ddb4 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1912,7 +1912,8 @@ could have the same effects on the mode line if the value of @code{mode-line-format} is changed to use them. However, various parts of Emacs set these variables on the understanding that they will control parts of the mode line; therefore, practically speaking, it is essential -for the mode line to use them. +for the mode line to use them. Also see +@ref{Optional Mode Line,,, emacs, The GNU Emacs Manual}. @defvar mode-line-mule-info This variable holds the value of the mode line construct that displays -- cgit v1.2.1 From 7b7b4c2101df25e5fca0cdf27b3912f0967c0f87 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 22:48:08 +0200 Subject: Document mode mode line variables * doc/lispref/modes.texi (Mode Line Variables): Document `mode-line-front-space, `mode-line-misc-info', `mode-line-end-spaces' (bug#21014). (cherry picked from commit bf7a630b0a5d3900f2afb0e7a881ce62e2b9f935) --- doc/lispref/modes.texi | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/lispref/modes.texi b/doc/lispref/modes.texi index d2eebb7ddb4..ae79128f84d 100644 --- a/doc/lispref/modes.texi +++ b/doc/lispref/modes.texi @@ -1994,6 +1994,21 @@ with the major mode as: @samp{(Shell:run)}. Normally this variable is @code{nil}. @end defvar +@defvar mode-line-front-space +This variable is displayed at the front of the mode line. By default, +this construct is displayed right at the beginning of the mode line, +except that if there is a memory-full message, it is displayed first. +@end defvar + +@defvar mode-line-end-spaces +This variable is displayed at the end of the mode line. +@end defvar + +@defvar mode-line-misc-info +Mode line construct for miscellaneous information. By default, this +shows the information specified by @code{global-mode-string}. +@end defvar + @defvar minor-mode-alist @anchor{Definition of minor-mode-alist} This variable holds an association list whose elements specify how the -- cgit v1.2.1 From 3bc26a7080a1394a65f614b1b398af3f851eefd7 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 23:30:40 +0200 Subject: clear-visited-file-modtime doc string fix * lisp/files.el (clear-visited-file-modtime): Fix possibly confusing doc string wording (bug#21169). (cherry picked from commit 1aaeaf1450756a71c9254a2a5b174c72084ca67a) --- lisp/files.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lisp/files.el b/lisp/files.el index f9c6c5185e3..a18832899c9 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -5075,7 +5075,7 @@ change the additional actions you can take on files." (defun clear-visited-file-modtime () "Clear out records of last mod time of visited file. -Next attempt to save will certainly not complain of a discrepancy." +Next attempt to save will not complain of a discrepancy." (set-visited-file-modtime 0)) (defun not-modified (&optional arg) -- cgit v1.2.1 From 9722ae18c3aa7243185fb005241f337712ac0ac5 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 23:34:29 +0200 Subject: with-silent-modifications doc clarification * lisp/subr.el (with-silent-modifications): Rearrange the doc string a bit so that the most pertinent information is at the top (bug#21171). (cherry picked from commit e0e70f030e69d9696a963a86f5f7caaff4df06eb) --- lisp/subr.el | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/lisp/subr.el b/lisp/subr.el index 23e7d01e6de..3f5d6e427e9 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -3291,6 +3291,8 @@ See also `with-temp-file' and `with-output-to-string'." (defmacro with-silent-modifications (&rest body) "Execute BODY, pretending it does not modify the buffer. +This macro is Typically used around modifications of +text-properties which do not really affect the buffer's content. If BODY performs real modifications to the buffer's text, other than cosmetic ones, undo data may become corrupted. @@ -3298,10 +3300,7 @@ This macro will run BODY normally, but doesn't count its buffer modifications as being buffer modifications. This affects things like `buffer-modified-p', checking whether the file is locked by someone else, running buffer modification hooks, and other things -of that nature. - -Typically used around modifications of text-properties which do -not really affect the buffer's content." +of that nature." (declare (debug t) (indent 0)) (let ((modified (make-symbol "modified"))) `(let* ((,modified (buffer-modified-p)) -- cgit v1.2.1 From 6b39501612ac2e932a6f62ca558659007c9b3daa Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 23:40:42 +0200 Subject: Mention with-silent-modifications in the lispref manual * doc/lispref/text.texi (Changing Properties): Document with-silent-modifications (bug#21171). (cherry picked from commit fcd0d854eef6e439d51e8f07cf734d5e34e502b3) --- doc/lispref/text.texi | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/lispref/text.texi b/doc/lispref/text.texi index ab55c2037d7..96f109b7561 100644 --- a/doc/lispref/text.texi +++ b/doc/lispref/text.texi @@ -2963,6 +2963,11 @@ construct each part with @code{propertize} and then combine them with @code{buffer-substring-no-properties}, which copies text from the buffer but does not copy its properties. +@findex with-silent-modifications + If you wish to add or remove text properties to a buffer without +marking the buffer as modified, you can wrap the calls above in the +@code{with-silent-modifications} macro. + @node Property Search @subsection Text Property Search Functions @cindex searching text properties -- cgit v1.2.1 From 25b4cf33dddf9af02b94237d65a6c163bd308747 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 23:52:19 +0200 Subject: Describe WHEN in all the define-obsolete- macros * lisp/emacs-lisp/byte-run.el (define-obsolete-face-alias): Say more verbosely what WHEN is (bug#21225). (define-obsolete-function-alias): Describe the WHEN parameter. (define-obsolete-variable-alias): Ditto. (cherry picked from commit 247c388f160581d207e41ca5926990bbf69d4a0f) --- lisp/emacs-lisp/byte-run.el | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el index 83cb7e70f37..ed457d9ede1 100644 --- a/lisp/emacs-lisp/byte-run.el +++ b/lisp/emacs-lisp/byte-run.el @@ -362,6 +362,9 @@ is equivalent to the following two lines of code: \(defalias \\='old-fun \\='new-fun \"old-fun's doc.\") \(make-obsolete \\='old-fun \\='new-fun \"22.1\") +If provided, WHEN should be a string indicating when the function +was first made obsolete, for example a date or a release number. + See the docstrings of `defalias' and `make-obsolete' for more details." (declare (doc-string 4) (advertised-calling-convention @@ -404,6 +407,9 @@ dumped with Emacs). This is so that any user customizations are applied before the defcustom tries to initialize the variable (this is due to the way `defvaralias' works). +If provided, WHEN should be a string indicating when the function +was first made obsolete, for example a date or a release number. + For the benefit of `custom-set-variables', if OBSOLETE-NAME has any of the following properties, they are copied to CURRENT-NAME, if it does not already have them: @@ -428,8 +434,8 @@ CURRENT-NAME, if it does not already have them: ;; It only really affects M-x describe-face output. (defmacro define-obsolete-face-alias (obsolete-face current-face when) "Make OBSOLETE-FACE a face alias for CURRENT-FACE and mark it obsolete. -The string WHEN gives the Emacs version where OBSOLETE-FACE became -obsolete." +If provided, WHEN should be a string indicating when the function +was first made obsolete, for example a date or a release number." `(progn (put ,obsolete-face 'face-alias ,current-face) ;; Used by M-x describe-face. -- cgit v1.2.1 From 8c66ebfcf06f318a5d984178c90d48362eebe085 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sat, 30 Apr 2016 23:54:16 +0200 Subject: Further define-obsolete-* doc fixups * lisp/emacs-lisp/byte-run.el (define-obsolete-face-alias): Fix up last change. (define-obsolete-variable-alias): Ditto. (cherry picked from commit 28e9f4390d8391c2c36be4ef515cf3a2c679a5a5) --- lisp/emacs-lisp/byte-run.el | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lisp/emacs-lisp/byte-run.el b/lisp/emacs-lisp/byte-run.el index ed457d9ede1..818c2683463 100644 --- a/lisp/emacs-lisp/byte-run.el +++ b/lisp/emacs-lisp/byte-run.el @@ -407,7 +407,7 @@ dumped with Emacs). This is so that any user customizations are applied before the defcustom tries to initialize the variable (this is due to the way `defvaralias' works). -If provided, WHEN should be a string indicating when the function +If provided, WHEN should be a string indicating when the variable was first made obsolete, for example a date or a release number. For the benefit of `custom-set-variables', if OBSOLETE-NAME has @@ -434,7 +434,7 @@ CURRENT-NAME, if it does not already have them: ;; It only really affects M-x describe-face output. (defmacro define-obsolete-face-alias (obsolete-face current-face when) "Make OBSOLETE-FACE a face alias for CURRENT-FACE and mark it obsolete. -If provided, WHEN should be a string indicating when the function +If provided, WHEN should be a string indicating when the face was first made obsolete, for example a date or a release number." `(progn (put ,obsolete-face 'face-alias ,current-face) -- cgit v1.2.1 From d1ab001b5ba5db6d33d93e78ae2373ce7fd72128 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sun, 1 May 2016 00:03:15 +0200 Subject: Fmarker_position doc string clarification * src/marker.c (Fmarker_position): Clarify the doc string (bug#21231). (cherry picked from commit eeac7c57273cec3f9408b18392dd2bafe3be4450) --- src/marker.c | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/src/marker.c b/src/marker.c index 030083002f4..febdb17689a 100644 --- a/src/marker.c +++ b/src/marker.c @@ -412,8 +412,7 @@ Returns nil if MARKER points into a dead buffer. */) } DEFUN ("marker-position", Fmarker_position, Smarker_position, 1, 1, 0, - doc: /* Return the position MARKER points at, as a character number. -Returns nil if MARKER points nowhere. */) + doc: /* Return the position of MARKER, or nil if it points nowhere. */) (Lisp_Object marker) { CHECK_MARKER (marker); -- cgit v1.2.1 From 78ae8056d0062d990e160326f19ad20d1eb7cc3b Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sun, 1 May 2016 00:10:57 +0200 Subject: Fill some imenu--index-alist doc lines * lisp/imenu.el (imenu--index-alist): Fill some doc lines (bug#21269). (cherry picked from commit 4b7bb8f596550628eaa83b82c0f7eabe59a84964) --- lisp/imenu.el | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/lisp/imenu.el b/lisp/imenu.el index 44bae2dd3b4..48257b892db 100644 --- a/lisp/imenu.el +++ b/lisp/imenu.el @@ -462,12 +462,15 @@ Don't move point." Simple elements in the alist look like (INDEX-NAME . POSITION). POSITION is the buffer position of the item; to go to the item is simply to move point to that position. -POSITION is passed to `imenu-default-goto-function', so it can be a non-number -if that variable has been changed (e.g. Semantic uses overlays for POSITIONs). -Special elements look like (INDEX-NAME POSITION FUNCTION ARGUMENTS...). -To \"go to\" a special element means applying FUNCTION -to INDEX-NAME, POSITION, and the ARGUMENTS. +POSITION is passed to `imenu-default-goto-function', so it can be +a non-number if that variable has been changed (e.g. Semantic +uses overlays for POSITIONs). + +Special elements look like +\(INDEX-NAME POSITION FUNCTION ARGUMENTS...). +To \"go to\" a special element means applying FUNCTION to +INDEX-NAME, POSITION, and the ARGUMENTS. A nested sub-alist element looks like (INDEX-NAME . SUB-ALIST). The function `imenu--subalist-p' tests an element and returns t -- cgit v1.2.1 From 9f27bcf21a39a06f994dcc16da992dcef978161e Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sun, 1 May 2016 00:16:42 +0200 Subject: isearch-search-fun-function doc tweak * lisp/isearch.el (isearch-search-fun-function): Mention what the STRING parameter is (bug#21552). (cherry picked from commit cafc2a5940cdc523cfea6dcf1cf540f48367c62a) --- lisp/isearch.el | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/lisp/isearch.el b/lisp/isearch.el index 218c18a666e..b2223e7b308 100644 --- a/lisp/isearch.el +++ b/lisp/isearch.el @@ -2662,8 +2662,9 @@ the word mode." "Non-default value overrides the behavior of `isearch-search-fun-default'. This variable's value should be a function, which will be called with no arguments, and should return a function that takes three -arguments: STRING, BOUND, and NOERROR. See `re-search-forward' -for the meaning of BOUND and NOERROR arguments. +arguments: STRING, BOUND, and NOERROR. STRING is the string to +be searched for. See `re-search-forward' for the meaning of +BOUND and NOERROR arguments. This returned function will be used by `isearch-search-string' to search for the first occurrence of STRING.") -- cgit v1.2.1 From c3b3b90ac08c3d20adcbe7577622e97a9797114c Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sun, 1 May 2016 00:26:00 +0200 Subject: normal-top-level-add-subdirs-to-load-path doc fix * lisp/startup.el (normal-top-level-add-subdirs-to-load-path): Doc fix (bug#21962). (cherry picked from commit 28aaa6d20586e3330a23b017a65e56dd6461c003) --- lisp/startup.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lisp/startup.el b/lisp/startup.el index 536289c3891..761e69e03b1 100644 --- a/lisp/startup.el +++ b/lisp/startup.el @@ -439,7 +439,7 @@ Warning Warning!!! Pure space overflow !!!Warning Warning :initialize #'custom-initialize-delay) (defun normal-top-level-add-subdirs-to-load-path () - "Add all subdirectories of `default-directory' to `load-path'. + "Recursively add all subdirectories of `default-directory' to `load-path'. More precisely, this uses only the subdirectories whose names start with letters or digits; it excludes any subdirectory named `RCS' or `CVS', and any subdirectory that contains a file named `.nosearch'." -- cgit v1.2.1 From 350792e356c23cb1a1dfbbd8e8e342e26830c185 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sun, 1 May 2016 01:08:23 +0200 Subject: global-eldoc-mode doc fix * lisp/emacs-lisp/eldoc.el (global-eldoc-mode): Be more specific about what "applicable" means (bug#23071). (cherry picked from commit 25e95b5dd8cd92e03788e589bf99a4b399f03114) --- lisp/emacs-lisp/eldoc.el | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index d5e7178b226..096102ae7e1 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -201,8 +201,16 @@ expression point is on." ;;;###autoload (define-minor-mode global-eldoc-mode - "Enable `eldoc-mode' in all buffers where it's applicable." - :group 'eldoc :global t + "Toggle Global Eldoc mode on or off. +With a prefix argument ARG, enable Global Eldoc mode if ARG is +positive, and disable it otherwise. If called from Lisp, enable +the mode if ARG is omitted or nil, and toggle it if ARG is ‘toggle’. + +If Global Eldoc mode is on, `eldoc-mode' will be enabled in all +buffers where it's applicable. These are buffers that have modes +that have enabled eldoc support. See `eldoc-documentation-function'." + :group 'eldoc + :global t :initialize 'custom-initialize-delay :init-value t (setq eldoc-last-message nil) -- cgit v1.2.1 From 69f7940fc2211b33c110d0b23492dc8fa4757fa4 Mon Sep 17 00:00:00 2001 From: Lars Ingebrigtsen Date: Sun, 1 May 2016 01:53:58 +0200 Subject: cua-prefix-override-inhibit-delay doc fix * lisp/emulation/cua-base.el (cua-prefix-override-inhibit-delay): Typo fix in doc string (bug#23401). (cherry picked from commit 2b4c099822811ede787fc6e575bfbb17b3cc0681) --- lisp/emulation/cua-base.el | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lisp/emulation/cua-base.el b/lisp/emulation/cua-base.el index 9351fcc6ca6..542dbccd775 100644 --- a/lisp/emulation/cua-base.el +++ b/lisp/emulation/cua-base.el @@ -302,7 +302,7 @@ is not turned on." If there is additional input within this time, the prefix key is used as a normal prefix key. So typing a key sequence quickly will inhibit overriding the prefix key. -As a special case, if the prefix keys repeated within this time, the +As a special case, if the prefix key is repeated within this time, the first prefix key is discarded, so typing a prefix key twice in quick succession will also inhibit overriding the prefix key. If the value is nil, use a shifted prefix key to inhibit the override." -- cgit v1.2.1 From 8aa41477ba63083a0c48483ea90502a3a660c722 Mon Sep 17 00:00:00 2001 From: Michael Albinus Date: Sun, 1 May 2016 10:14:05 +0200 Subject: tramp.texi: Revert last change due to backward compatibility (cherry picked from commit 910f9a0a936aacbffe9b9b790d7f698dfd287aac) --- doc/misc/tramp.texi | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/doc/misc/tramp.texi b/doc/misc/tramp.texi index af22f8d6cc7..5ce10d298c0 100644 --- a/doc/misc/tramp.texi +++ b/doc/misc/tramp.texi @@ -3390,9 +3390,11 @@ Since @file{filecache} remembers visited places, add the remote directory to the cache: @lisp -(with-eval-after-load "filecache" - (file-cache-add-directory - "@trampfn{ssh,news@@news.my.domain,/opt/news/etc/}")) +@c `with-eval-after-load' has been introduced with Emacs 24.4. Shall +@c be used when appropriate. +(eval-after-load "filecache" + '(file-cache-add-directory + "@trampfn{ssh,news@@news.my.domain,/opt/news/etc/}")) @end lisp Then use directory completion in the minibuffer with @kbd{C-x C-f -- cgit v1.2.1