From 9fc9a531a5938e870339211de6c0ecfedaa1c86b Mon Sep 17 00:00:00 2001 From: "Aaron S. Hawley" Date: Fri, 11 Jan 2013 18:08:55 -0500 Subject: [PATCH] Disambiguate function and variable references in docstrings. * lisp/comint.el (comint-history-isearch-message): Fix ambiguous doc string cross-reference(s). * lisp/ffap.el (ffap-string-at-point-region, ffap-next) (ffap-string-at-point, ffap-string-around) (ffap-copy-string-as-kill, ffap-highlight-overlay) (ffap-literally): Fix ambiguous doc string cross-reference(s). * lisp/font-lock.el (font-lock-keywords-alist) (font-lock-removed-keywords-alist): Fix ambiguous doc string cross-reference(s). * lisp/help-mode.el (help-xref-symbol-regexp): Add "call" as a hint for a cross-reference to a function. * lisp/info.el (Info-find-emacs-command-nodes): Fix ambiguous doc string cross-reference(s). * lisp/isearch.el (isearch-message-function, isearch-fail-pos): Fix ambiguous doc string cross-reference(s). * lisp/misearch.el (multi-isearch-next-buffer-function): Fix ambiguous doc string cross-reference(s). * lisp/newcomment.el (comment-box): Fix ambiguous doc string cross-reference(s). * lisp/printing.el (pr-txt-printer-alist, pr-ps-printer-alist) (pr-setting-database): Fix ambiguous doc string cross-reference(s). * lisp/ps-print.el (ps-even-or-odd-pages, ps-spool-buffer-with-faces) (ps-n-up-filling-database): Fix ambiguous doc string cross-reference(s). * lisp/server.el (server-buffer, server-log): Fix ambiguous doc string cross-reference(s). * lisp/simple.el (newline, delete-backward-char, delete-forward-char) (minibuffer-history-isearch-message, kill-line, track-eol) (temporary-goal-column): Fix ambiguous doc string cross-reference(s). * lisp/whitespace.el (whitespace-point) (whitespace-font-lock-refontify, whitespace-bob-marker) (whitespace-eob-marker): Fix ambiguous doc string cross-reference(s). * lisp/calc/calc.el (calc-highlight-selections-with-faces) (calc-dispatch): Fix ambiguous doc string cross-reference(s). * lisp/emacs-lisp/edebug.el (edebug-read, edebug-eval-defun): Fix ambiguous doc string cross-reference(s). * lisp/gnus/gnus-start.el (gnus-check-new-newsgroups): Fix ambiguous doc string cross-reference(s). * lisp/gnus/gnus-sum.el (gnus-summary-newsgroup-prefix): Fix ambiguous doc string cross-reference(s). * lisp/international/mule.el (add-to-coding-system-list): Fix ambiguous doc string cross-reference(s). * lisp/progmodes/cc-fonts.el (c-font-lock-keywords-3) (c++-font-lock-keywords-3, objc-font-lock-keywords-3) (java-font-lock-keywords-3, idl-font-lock-keywords-3) (pike-font-lock-keywords-3): Fix ambiguous doc string cross-reference(s). * lisp/progmodes/compile.el (compile): Fix ambiguous doc string cross-reference(s). * lisp/progmodes/etags.el (tags-table-files) (tags-table-files-function, tags-included-tables-function): Fix ambiguous doc string cross-reference(s). * lisp/progmodes/gdb-mi.el (gdb, gdb-setup-windows) (gdb-restore-windows): Fix ambiguous doc string cross-reference(s). * lisp/textmodes/flyspell.el (flyspell-mark-duplications-flag) (flyspell-default-deplacement-commands): Fix ambiguous doc string cross-reference(s). * lisp/textmodes/ispell.el (ispell-accept-output): Fix ambiguous doc string cross-reference(s). * lisp/textmodes/sgml-mode.el (html-tag-help): Fix ambiguous doc string cross-reference(s). * lisp/vc/compare-w.el (compare-ignore-whitespace) (compare-ignore-case, compare-windows-dehighlight): Fix ambiguous doc string cross-reference(s). * lisp/vc/diff.el (diff): Fix ambiguous doc string cross-reference(s). * src/insdel.c (Fcombine_after_change_execute, syms_of_insdel): Fix ambiguous doc string cross-reference(s). * src/keyboard.c (Fcommand_execute, syms_of_keyboard): Fix ambiguous doc string cross-reference(s). * src/window.c (Fwindow_point, syms_of_window): Fix ambiguous doc string cross-reference(s). Fixes: debbugs:12686 --- lisp/ChangeLog | 92 +++++++++++++++++++++++++++++++++++++++++++++ lisp/calc/calc.el | 8 ++-- lisp/comint.el | 2 +- lisp/emacs-lisp/edebug.el | 8 ++-- lisp/ffap.el | 20 +++++----- lisp/font-lock.el | 4 +- lisp/gnus/ChangeLog | 8 ++++ lisp/gnus/gnus-start.el | 2 +- lisp/gnus/gnus-sum.el | 2 +- lisp/help-mode.el | 2 +- lisp/info.el | 2 +- lisp/international/mule.el | 2 +- lisp/isearch.el | 4 +- lisp/misearch.el | 2 +- lisp/newcomment.el | 3 +- lisp/printing.el | 10 ++--- lisp/progmodes/cc-fonts.el | 12 +++--- lisp/progmodes/compile.el | 5 ++- lisp/progmodes/etags.el | 7 ++-- lisp/progmodes/gdb-mi.el | 8 ++-- lisp/ps-print.el | 16 ++++---- lisp/server.el | 4 +- lisp/simple.el | 16 ++++---- lisp/textmodes/flyspell.el | 7 ++-- lisp/textmodes/ispell.el | 4 +- lisp/textmodes/sgml-mode.el | 2 +- lisp/vc/compare-w.el | 6 +-- lisp/vc/diff.el | 2 +- lisp/whitespace.el | 8 ++-- src/ChangeLog | 11 ++++++ src/insdel.c | 4 +- src/keyboard.c | 6 +-- src/window.c | 5 ++- 33 files changed, 206 insertions(+), 88 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 7eef2c80382..a2dfb8023b3 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,95 @@ +2013-01-11 Aaron S. Hawley + + * calc/calc.el (calc-highlight-selections-with-faces) + (calc-dispatch): Fix ambiguous doc string cross-reference(s). + + * comint.el (comint-history-isearch-message): Fix ambiguous doc + string cross-reference(s). + + * emacs-lisp/edebug.el (edebug-read, edebug-eval-defun): Fix + ambiguous doc string cross-reference(s). + + * ffap.el (ffap-string-at-point-region, ffap-next) + (ffap-string-at-point, ffap-string-around) + (ffap-copy-string-as-kill, ffap-highlight-overlay) + (ffap-literally): Fix ambiguous doc string cross-reference(s). + + * font-lock.el (font-lock-keywords-alist) + (font-lock-removed-keywords-alist): Fix ambiguous doc string + cross-reference(s). + + * help-mode.el (help-xref-symbol-regexp): Add "call" as a hint for + a cross-reference to a function. + + * info.el (Info-find-emacs-command-nodes): Fix ambiguous doc + string cross-reference(s). + + * international/mule.el (add-to-coding-system-list): Fix ambiguous + doc string cross-reference(s). + + * isearch.el (isearch-message-function, isearch-fail-pos): Fix + ambiguous doc string cross-reference(s). + + * misearch.el (multi-isearch-next-buffer-function): Fix ambiguous + doc string cross-reference(s). + + * newcomment.el (comment-box): Fix ambiguous doc string + cross-reference(s). + + * printing.el (pr-txt-printer-alist, pr-ps-printer-alist) + (pr-setting-database): Fix ambiguous doc string + cross-reference(s). + + * progmodes/cc-fonts.el (c-font-lock-keywords-3) + (c++-font-lock-keywords-3, objc-font-lock-keywords-3) + (java-font-lock-keywords-3, idl-font-lock-keywords-3) + (pike-font-lock-keywords-3): Fix ambiguous doc string + cross-reference(s). + + * progmodes/compile.el (compile): Fix ambiguous doc string + cross-reference(s). + + * progmodes/etags.el (tags-table-files) + (tags-table-files-function, tags-included-tables-function): Fix + ambiguous doc string cross-reference(s). + + * progmodes/gdb-mi.el (gdb, gdb-setup-windows) + (gdb-restore-windows): Fix ambiguous doc string + cross-reference(s). + + * ps-print.el (ps-even-or-odd-pages, ps-spool-buffer-with-faces) + (ps-n-up-filling-database): Fix ambiguous doc string + cross-reference(s). + + * server.el (server-buffer, server-log): Fix ambiguous doc string + cross-reference(s). + + * simple.el (newline, delete-backward-char, delete-forward-char) + (minibuffer-history-isearch-message, kill-line, track-eol) + (temporary-goal-column): Fix ambiguous doc string + cross-reference(s). + + * textmodes/flyspell.el (flyspell-mark-duplications-flag) + (flyspell-default-deplacement-commands): Fix ambiguous doc string + cross-reference(s). + + * textmodes/ispell.el (ispell-accept-output): Fix ambiguous doc + string cross-reference(s). + + * textmodes/sgml-mode.el (html-tag-help): Fix ambiguous doc string + cross-reference(s). + + * vc/compare-w.el (compare-ignore-whitespace) + (compare-ignore-case, compare-windows-dehighlight): Fix ambiguous + doc string cross-reference(s). + + * vc/diff.el (diff): Fix ambiguous doc string cross-reference(s). + + * whitespace.el (whitespace-point) + (whitespace-font-lock-refontify, whitespace-bob-marker) + (whitespace-eob-marker): Fix ambiguous doc string + cross-reference(s). + 2013-01-11 Michael Albinus * autorevert.el (top): Require 'cl in order to pacify byte compiler. diff --git a/lisp/calc/calc.el b/lisp/calc/calc.el index 6f51be4b89b..c35e7650254 100644 --- a/lisp/calc/calc.el +++ b/lisp/calc/calc.el @@ -435,9 +435,9 @@ when converting units." (defcustom calc-highlight-selections-with-faces nil "If non-nil, use a separate face to indicate selected sub-formulas. -If `calc-show-selections' is non-nil, then selected sub-formulas are shown -by displaying the rest of the formula in `calc-nonselected-face'. -If `calc-show-selections' is nil, then selected sub-formulas are shown +If option `calc-show-selections' is non-nil, then selected sub-formulas are +shown by displaying the rest of the formula in `calc-nonselected-face'. +If option `calc-show-selections' is nil, then selected sub-formulas are shown by displaying the sub-formula in `calc-selected-face'." :version "24.1" :group 'calc @@ -1183,7 +1183,7 @@ Used by `calc-user-invocation'.") ;;;###autoload (defun calc-dispatch (&optional arg) - "Invoke the GNU Emacs Calculator. See `calc-dispatch-help' for details." + "Invoke the GNU Emacs Calculator. See \\[calc-dispatch-help] for details." (interactive "P") ; (sit-for echo-keystrokes) (condition-case err ; look for other keys bound to calc-dispatch diff --git a/lisp/comint.el b/lisp/comint.el index 42ac08a9ecc..21bd732b43c 100644 --- a/lisp/comint.el +++ b/lisp/comint.el @@ -1521,7 +1521,7 @@ Intended to be added to `isearch-mode-hook' in `comint-mode'." If there are no search errors, this function displays an overlay with the Isearch prompt which replaces the original comint prompt. Otherwise, it displays the standard Isearch message returned from -`isearch-message'." +the function `isearch-message'." (if (not (and isearch-success (not isearch-error))) ;; Use standard function `isearch-message' when not in comint prompt, ;; or search fails, or has an error (like incomplete regexp). diff --git a/lisp/emacs-lisp/edebug.el b/lisp/emacs-lisp/edebug.el index 378ba9db9f4..52e12013fd3 100644 --- a/lisp/emacs-lisp/edebug.el +++ b/lisp/emacs-lisp/edebug.el @@ -461,8 +461,8 @@ STREAM or the value of `standard-input' may be: This version, from Edebug, maybe instruments the expression. But the STREAM must be the current buffer to do so. Whether it instruments is -also dependent on the values of `edebug-all-defs' and -`edebug-all-forms'." +also dependent on the values of the option `edebug-all-defs' and +the option `edebug-all-forms'." (or stream (setq stream standard-input)) (if (eq stream (current-buffer)) (edebug-read-and-maybe-wrap-form) @@ -484,8 +484,8 @@ similarly. Reinitialize the face according to `defface' specification. With a prefix argument, instrument the code for Edebug. -Setting `edebug-all-defs' to a non-nil value reverses the meaning of -the prefix argument. Code is then instrumented when this function is +Setting option `edebug-all-defs' to a non-nil value reverses the meaning +of the prefix argument. Code is then instrumented when this function is invoked without a prefix argument If acting on a `defun' for FUNCTION, and the function was instrumented, diff --git a/lisp/ffap.el b/lisp/ffap.el index dfb559f3f0d..c5b0784e5a2 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -321,7 +321,7 @@ disable FFAP most of the time." "Last value returned by `ffap-next-guess'.") (defvar ffap-string-at-point-region '(1 1) - "List (BEG END), last region returned by `ffap-string-at-point'.") + "List (BEG END), last region returned by the function `ffap-string-at-point'.") (defun ffap-next-guess (&optional back lim) "Move point to next file or URL, and return it as a string. @@ -346,7 +346,7 @@ Optional argument BACK says to search backwards. Optional argument WRAP says to try wrapping around if necessary. Interactively: use a single prefix to search backwards, double prefix to wrap forward, triple to wrap backwards. -Actual search is done by `ffap-next-guess'." +Actual search is done by the function `ffap-next-guess'." (interactive (cdr (assq (prefix-numeric-value current-prefix-arg) '((1) (4 t) (16 nil t) (64 t t))))) @@ -1028,14 +1028,14 @@ If a given RFC isn't in these then `ffap-rfc-path' is offered." "Alist of \(MODE CHARS BEG END\), where MODE is a symbol, possibly a major-mode name, or one of the symbol `file', `url', `machine', and `nocolon'. -`ffap-string-at-point' uses the data fields as follows: +Function `ffap-string-at-point' uses the data fields as follows: 1. find a maximal string of CHARS around point, 2. strip BEG chars before point from the beginning, 3. Strip END chars after point from the end.") (defvar ffap-string-at-point nil ;; Added at suggestion of RHOGEE (for ff-paths), 7/24/95. - "Last string returned by `ffap-string-at-point'.") + "Last string returned by the function `ffap-string-at-point'.") (defun ffap-string-at-point (&optional mode) "Return a string of characters from around point. @@ -1043,7 +1043,8 @@ MODE (defaults to value of `major-mode') is a symbol used to look up string syntax parameters in `ffap-string-at-point-mode-alist'. If MODE is not found, we use `file' instead of MODE. If the region is active, return a string from the region. -Sets `ffap-string-at-point' and `ffap-string-at-point-region'." +Sets the variable `ffap-string-at-point' and the variable +`ffap-string-at-point-region'." (let* ((args (cdr (or (assq (or mode major-mode) ffap-string-at-point-mode-alist) @@ -1068,7 +1069,8 @@ Sets `ffap-string-at-point' and `ffap-string-at-point-region'." (defun ffap-string-around () ;; Sometimes useful to decide how to treat a string. - "Return string of two chars around last `ffap-string-at-point'. + "Return string of two chars around last result of function +`ffap-string-at-point'. Assumes the buffer has not changed." (save-excursion (format "%c%c" @@ -1082,7 +1084,7 @@ Assumes the buffer has not changed." (defun ffap-copy-string-as-kill (&optional mode) ;; Requested by MCOOK. Useful? - "Call `ffap-string-at-point', and copy result to `kill-ring'." + "Call function `ffap-string-at-point', and copy result to `kill-ring'." (interactive) (let ((str (ffap-string-at-point mode))) (if (equal "" str) @@ -1364,7 +1366,7 @@ which may actually result in an URL rather than a filename." :version "22.1") (defvar ffap-highlight-overlay nil - "Overlay used by `ffap-highlight'.") + "Overlay used by function `ffap-highlight'.") (defun ffap-highlight (&optional remove) "If `ffap-highlight' is set, highlight the guess in this buffer. @@ -1734,7 +1736,7 @@ Only intended for interactive use." (call-interactively 'ffap))) (defun ffap-literally () - "Like `ffap' and `find-file-literally'. + "Like `ffap' and command `find-file-literally'. Only intended for interactive use." (interactive) (let ((ffap-file-finder 'find-file-literally)) diff --git a/lisp/font-lock.el b/lisp/font-lock.el index 7a2577eabbb..f714eaab233 100644 --- a/lisp/font-lock.el +++ b/lisp/font-lock.el @@ -469,7 +469,7 @@ optimized.") "Alist of additional `font-lock-keywords' elements for major modes. Each element has the form (MODE KEYWORDS . HOW). -`font-lock-set-defaults' adds the elements in the list KEYWORDS to +Function `font-lock-set-defaults' adds the elements in the list KEYWORDS to `font-lock-keywords' when Font Lock is turned on in major mode MODE. If HOW is nil, KEYWORDS are added at the beginning of @@ -484,7 +484,7 @@ This is normally set via `font-lock-add-keywords' and (defvar font-lock-removed-keywords-alist nil "Alist of `font-lock-keywords' elements to be removed for major modes. -Each element has the form (MODE . KEYWORDS). `font-lock-set-defaults' +Each element has the form (MODE . KEYWORDS). Function `font-lock-set-defaults' removes the elements in the list KEYWORDS from `font-lock-keywords' when Font Lock is turned on in major mode MODE. diff --git a/lisp/gnus/ChangeLog b/lisp/gnus/ChangeLog index 0cea790792f..44dbf060e49 100644 --- a/lisp/gnus/ChangeLog +++ b/lisp/gnus/ChangeLog @@ -1,3 +1,11 @@ +2013-01-11 Aaron S. Hawley + + * gnus-start.el (gnus-check-new-newsgroups): Fix ambiguous doc string + cross-reference(s). + + * gnus-sum.el (gnus-summary-newsgroup-prefix): Fix ambiguous doc string + cross-reference(s). + 2013-01-11 Dmitry Antipov * gnus-art.el (gnus-mime-display-security): Use point-min-marker diff --git a/lisp/gnus/gnus-start.el b/lisp/gnus/gnus-start.el index 42cc284a0ad..aa8b6bf2703 100644 --- a/lisp/gnus/gnus-start.el +++ b/lisp/gnus/gnus-start.el @@ -110,7 +110,7 @@ ask the servers (primary, secondary, and archive servers) to list new groups since the last time it checked: 1. This variable is `ask-server'. 2. This variable is a list of select methods (see below). - 3. `gnus-read-active-file' is nil or `some'. + 3. Option `gnus-read-active-file' is nil or `some'. 4. A prefix argument is given to `gnus-find-new-newsgroups' interactively. Thus, if this variable is `ask-server' or a list of select methods or diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el index 49b7e5930f6..14597f031e1 100644 --- a/lisp/gnus/gnus-sum.el +++ b/lisp/gnus/gnus-sum.el @@ -1167,7 +1167,7 @@ using `gnus-ignored-from-addresses'." (defcustom gnus-summary-newsgroup-prefix "=> " "*String prefixed to the Newsgroup field in the summary -line when using `gnus-ignored-from-addresses'." +line when using the option `gnus-ignored-from-addresses'." :version "22.1" :group 'gnus-summary :type 'string) diff --git a/lisp/help-mode.el b/lisp/help-mode.el index 662f431d3c3..b5aca1a4445 100644 --- a/lisp/help-mode.el +++ b/lisp/help-mode.el @@ -322,7 +322,7 @@ Commands: (defconst help-xref-symbol-regexp (purecopy (concat "\\(\\<\\(\\(variable\\|option\\)\\|" ; Link to var - "\\(function\\|command\\)\\|" ; Link to function + "\\(function\\|command\\|call\\)\\|" ; Link to function "\\(face\\)\\|" ; Link to face "\\(symbol\\|program\\|property\\)\\|" ; Don't link "\\(source \\(?:code \\)?\\(?:of\\|for\\)\\)\\)" diff --git a/lisp/info.el b/lisp/info.el index 48ad00c9f28..e230ed0f82c 100644 --- a/lisp/info.el +++ b/lisp/info.el @@ -4313,7 +4313,7 @@ If the element is just a file name, the file name also serves as the prefix.") The `info-file' property of COMMAND says which Info manual to search. If COMMAND has no property, the variable `Info-file-list-for-emacs' defines heuristics for which Info manual to try. -The locations are of the format used in `Info-history', i.e. +The locations are of the format used in the variable `Info-history', i.e. \(FILENAME NODENAME BUFFERPOS), where BUFFERPOS is the line number in the first element of the returned list (which is treated specially in `Info-goto-emacs-command-node'), and 0 for the rest elements of a list." diff --git a/lisp/international/mule.el b/lisp/international/mule.el index 6fa589a9622..995df2fb9a7 100644 --- a/lisp/international/mule.el +++ b/lisp/international/mule.el @@ -891,7 +891,7 @@ or one is an alias of the other." (and (vectorp eol-type-1) (vectorp eol-type-2))))))) (defun add-to-coding-system-list (coding-system) - "Add CODING-SYSTEM to `coding-system-list' while keeping it sorted." + "Add CODING-SYSTEM to variable `coding-system-list' while keeping it sorted." (if (or (null coding-system-list) (coding-system-lessp coding-system (car coding-system-list))) (setq coding-system-list (cons coding-system coding-system-list)) diff --git a/lisp/isearch.el b/lisp/isearch.el index b13881b208b..e16e3840d0d 100644 --- a/lisp/isearch.el +++ b/lisp/isearch.el @@ -176,7 +176,7 @@ is non-nil if the user quits the search.") (defvar isearch-message-function nil "Function to call to display the search prompt. -If nil, use `isearch-message'.") +If nil, use function `isearch-message'.") (defvar isearch-wrap-function nil "Function to call to wrap the search when search is failed. @@ -1101,7 +1101,7 @@ nonincremental search instead via `isearch-edit-string'." (defun isearch-fail-pos (&optional msg) "Return position of first mismatch in search string, or nil if none. -If MSG is non-nil, use `isearch-message', otherwise `isearch-string'." +If MSG is non-nil, use variable `isearch-message', otherwise `isearch-string'." (let ((cmds isearch-cmds) (curr-msg (if msg isearch-message isearch-string)) succ-msg) diff --git a/lisp/misearch.el b/lisp/misearch.el index 2584f8df77b..0c4cd4ea323 100644 --- a/lisp/misearch.el +++ b/lisp/misearch.el @@ -73,7 +73,7 @@ end of the search space). The first argument of this function is the current buffer where the search is currently searching. It defines the base buffer relative to which this function should find the next buffer. When the isearch -direction is backward (when `isearch-forward' is nil), this function +direction is backward (when option `isearch-forward' is nil), this function should return the previous buffer to search. If the second argument of this function WRAP is non-nil, then it diff --git a/lisp/newcomment.el b/lisp/newcomment.el index d55feaa3c1a..bcb5f721ae8 100644 --- a/lisp/newcomment.el +++ b/lisp/newcomment.el @@ -1206,7 +1206,8 @@ changed with `comment-style'." (defun comment-box (beg end &optional arg) "Comment out the BEG .. END region, putting it inside a box. The numeric prefix ARG specifies how many characters to add to begin- and -end- comment markers additionally to what `comment-add' already specifies." +end- comment markers additionally to what variable `comment-add' already +specifies." (interactive "*r\np") (comment-normalize-vars) (let ((comment-style (if (cadr (assoc comment-style comment-styles)) diff --git a/lisp/printing.el b/lisp/printing.el index a8eed066a15..bf50aa8f679 100644 --- a/lisp/printing.el +++ b/lisp/printing.el @@ -1800,7 +1800,7 @@ The alist element has the form: Where: SYMBOL It's a symbol to identify a text printer. It's for - `pr-txt-name' variable setting and for menu selection. + setting option `pr-txt-name' and for menu selection. Examples: 'prt_06a 'my_printer @@ -1951,7 +1951,7 @@ The alist element has the form: Where: SYMBOL It's a symbol to identify a PostScript printer. It's for - `pr-ps-name' variable setting and for menu selection. + setting option `pr-ps-name' and for menu selection. Examples: 'prt_06a 'my_printer @@ -2935,9 +2935,9 @@ INHERITS Specify the inheritance for SYMBOL group. It's a symbol name The example above has two setting groups: no-duplex and no-duplex-and-landscape. When setting no-duplex is activated - through `inherits-from:' (see `pr-ps-utility', `pr-mode-alist' - and `pr-ps-printer-alist'), the variables pr-file-duplex and - pr-file-tumble are both set to nil. + through `inherits-from:' (see option `pr-ps-utility', + `pr-mode-alist' and `pr-ps-printer-alist'), the variables + pr-file-duplex and pr-file-tumble are both set to nil. Now when setting no-duplex-and-landscape is activated through `inherits-from:', the variable pr-file-landscape is set to nil diff --git a/lisp/progmodes/cc-fonts.el b/lisp/progmodes/cc-fonts.el index 376edcdc76b..f6c47f5bb4d 100644 --- a/lisp/progmodes/cc-fonts.el +++ b/lisp/progmodes/cc-fonts.el @@ -2049,7 +2049,7 @@ styles specified by `c-doc-comment-style'.") (defconst c-font-lock-keywords-3 (c-lang-const c-matchers-3 c) "Accurate normal font locking for C mode. -Like `c-font-lock-keywords-2' but detects declarations in a more +Like the variable `c-font-lock-keywords-2' but detects declarations in a more accurate way that works in most cases for arbitrary types without the need for `c-font-lock-extra-types'.") @@ -2207,7 +2207,7 @@ styles specified by `c-doc-comment-style'.") (defconst c++-font-lock-keywords-3 (c-lang-const c-matchers-3 c++) "Accurate normal font locking for C++ mode. -Like `c++-font-lock-keywords-2' but detects declarations in a more +Like the variable `c++-font-lock-keywords-2' but detects declarations in a more accurate way that works in most cases for arbitrary types without the need for `c++-font-lock-extra-types'.") @@ -2313,7 +2313,7 @@ comment styles specified by `c-doc-comment-style'.") (defconst objc-font-lock-keywords-3 (c-lang-const c-matchers-3 objc) "Accurate normal font locking for Objective-C mode. -Like `objc-font-lock-keywords-2' but detects declarations in a more +Like the variable `objc-font-lock-keywords-2' but detects declarations in a more accurate way that works in most cases for arbitrary types without the need for `objc-font-lock-extra-types'.") @@ -2356,7 +2356,7 @@ comment styles specified by `c-doc-comment-style'.") (defconst java-font-lock-keywords-3 (c-lang-const c-matchers-3 java) "Accurate normal font locking for Java mode. -Like `java-font-lock-keywords-2' but detects declarations in a more +Like variable `java-font-lock-keywords-2' but detects declarations in a more accurate way that works in most cases for arbitrary types without the need for `java-font-lock-extra-types'.") @@ -2389,7 +2389,7 @@ styles specified by `c-doc-comment-style'.") (defconst idl-font-lock-keywords-3 (c-lang-const c-matchers-3 idl) "Accurate normal font locking for CORBA IDL mode. -Like `idl-font-lock-keywords-2' but detects declarations in a more +Like the variable `idl-font-lock-keywords-2' but detects declarations in a more accurate way that works in most cases for arbitrary types without the need for `idl-font-lock-extra-types'.") @@ -2422,7 +2422,7 @@ comment styles specified by `c-doc-comment-style'.") (defconst pike-font-lock-keywords-3 (c-lang-const c-matchers-3 pike) "Accurate normal font locking for Pike mode. -Like `pike-font-lock-keywords-2' but detects declarations in a more +Like the variable `pike-font-lock-keywords-2' but detects declarations in a more accurate way that works in most cases for arbitrary types without the need for `pike-font-lock-extra-types'.") diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el index f6c43e2c392..4e1cd4a24e3 100644 --- a/lisp/progmodes/compile.el +++ b/lisp/progmodes/compile.el @@ -1427,8 +1427,9 @@ and move to the source code that caused it. If optional second arg COMINT is t the buffer will be in Comint mode with `compilation-shell-minor-mode'. -Interactively, prompts for the command if `compilation-read-command' is -non-nil; otherwise uses `compile-command'. With prefix arg, always prompts. +Interactively, prompts for the command if the variable +`compilation-read-command' is non-nil; otherwise uses`compile-command'. +With prefix arg, always prompts. Additionally, with universal prefix arg, compilation buffer will be in comint mode, i.e. interactive. diff --git a/lisp/progmodes/etags.el b/lisp/progmodes/etags.el index 81dc31792c3..92f9447652e 100644 --- a/lisp/progmodes/etags.el +++ b/lisp/progmodes/etags.el @@ -199,7 +199,8 @@ Pop back to the last location with \\[negative-argument] \\[find-tag].") (defvar tags-table-files nil "List of file names covered by current tags table. -nil means it has not yet been computed; use `tags-table-files' to do so.") +nil means it has not yet been computed; +use function `tags-table-files' to do so.") (defvar tags-completion-table nil "Obarray of tag names defined in current tags table.") @@ -224,7 +225,7 @@ of the format-parsing tags function variables if successful.") One optional argument, a boolean specifying to return complete path (nil) or relative path (non-nil).") (defvar tags-table-files-function nil - "Function to do the work of `tags-table-files' (which see).") + "Function to do the work of function `tags-table-files' (which see).") (defvar tags-completion-table-function nil "Function to build the `tags-completion-table'.") (defvar snarf-tag-function nil @@ -251,7 +252,7 @@ One argument, the tag info returned by `snarf-tag-function'.") (defvar tags-apropos-function nil "Function to do the work of `tags-apropos' (which see).") (defvar tags-included-tables-function nil - "Function to do the work of `tags-included-tables' (which see).") + "Function to do the work of function `tags-included-tables' (which see).") (defvar verify-tags-table-function nil "Function to return t if current buffer contains valid tags file.") diff --git a/lisp/progmodes/gdb-mi.el b/lisp/progmodes/gdb-mi.el index fc3d336cf99..90c7cfc5008 100644 --- a/lisp/progmodes/gdb-mi.el +++ b/lisp/progmodes/gdb-mi.el @@ -607,12 +607,12 @@ executable followed by command-line options. The command-line options should include \"-i=mi\" to use gdb's MI text interface. Note that the old \"--annotate\" option is no longer supported. -If `gdb-many-windows' is nil (the default value) then gdb just +If option `gdb-many-windows' is nil (the default value) then gdb just pops up the GUD buffer unless `gdb-show-main' is t. In this case it starts with two windows: one displaying the GUD buffer and the other with the source file with the main routine of the inferior. -If `gdb-many-windows' is t, regardless of the value of +If option `gdb-many-windows' is t, regardless of the value of `gdb-show-main', the layout below will appear. Keybindings are shown in some of the buffers. @@ -4069,7 +4069,7 @@ window is dedicated." (set-window-dedicated-p window t)) (defun gdb-setup-windows () - "Layout the window pattern for `gdb-many-windows'." + "Layout the window pattern for option `gdb-many-windows'." (gdb-get-buffer-create 'gdb-locals-buffer) (gdb-get-buffer-create 'gdb-stack-buffer) (gdb-get-buffer-create 'gdb-breakpoints-buffer) @@ -4120,7 +4120,7 @@ of the debugged program. Non-nil means display the layout shown for (defun gdb-restore-windows () "Restore the basic arrangement of windows used by gdb. -This arrangement depends on the value of `gdb-many-windows'." +This arrangement depends on the value of option `gdb-many-windows'." (interactive) (switch-to-buffer gud-comint-buffer) ;Select the right window and frame. (delete-other-windows) diff --git a/lisp/ps-print.el b/lisp/ps-print.el index 99f22df4107..f7c03c2de85 100644 --- a/lisp/ps-print.el +++ b/lisp/ps-print.el @@ -1959,13 +1959,13 @@ Valid values are: Any other value is treated as nil. -If you set `ps-selected-pages' (see it for documentation), first the pages are -filtered by `ps-selected-pages' and then by `ps-even-or-odd-pages'. For -example, if we have: +If you set option `ps-selected-pages', first the pages are +filtered by option `ps-selected-pages' and then by `ps-even-or-odd-pages'. +For example, if we have: (setq ps-selected-pages '(1 4 (6 . 10) (12 . 16) 20)) -Combining with `ps-even-or-odd-pages' and `ps-n-up-printing', we have: +Combining with `ps-even-or-odd-pages' and option `ps-n-up-printing', we have: `ps-n-up-printing' = 1: `ps-even-or-odd-pages' PAGES PRINTED @@ -3566,9 +3566,9 @@ Use the command `ps-despool' to send the spooled images to the printer." ;;;###autoload (defun ps-spool-buffer-with-faces () "Generate and spool a PostScript image of the buffer. -Like `ps-spool-buffer', but includes font, color, and underline information in -the generated image. This command works only if you are using a window system, -so it has a way to determine color values. +Like the command `ps-spool-buffer', but includes font, color, and underline +information in the generated image. This command works only if you are using +a window system, so it has a way to determine color values. Use the command `ps-despool' to send the spooled images to the printer." (interactive) @@ -5369,7 +5369,7 @@ Each element has the following form: (KIND XCOL YCOL XLIN YLIN REPEAT END XSTART YSTART) Where: -KIND is a valid value of `ps-n-up-filling'. +KIND is a valid value of the variable `ps-n-up-filling'. XCOL YCOL are the relative position for the next column. XLIN YLIN are the relative position for the beginning of next line. REPEAT is the number of repetitions for external loop. diff --git a/lisp/server.el b/lisp/server.el index 03d4bfc33df..64224d2a310 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -361,7 +361,7 @@ Updates `server-clients'." (defconst server-buffer " *server*" "Buffer used internally by Emacs's server. -One use is to log the I/O for debugging purposes (see `server-log'), +One use is to log the I/O for debugging purposes (see option `server-log'), the other is to provide a current buffer in which the process filter can safely let-bind buffer-local variables like `default-directory'.") @@ -369,7 +369,7 @@ safely let-bind buffer-local variables like `default-directory'.") "If non-nil, log the server's inputs and outputs in the `server-buffer'.") (defun server-log (string &optional client) - "If `server-log' is non-nil, log STRING to `server-buffer'. + "If option `server-log' is non-nil, log STRING to `server-buffer'. If CLIENT is non-nil, add a description of it to the logged message." (when server-log (with-current-buffer (get-buffer-create server-buffer) diff --git a/lisp/simple.el b/lisp/simple.el index dcd6d792acb..847c07a5c26 100644 --- a/lisp/simple.el +++ b/lisp/simple.el @@ -401,7 +401,7 @@ Other major modes are defined by comparison with this one." (defun newline (&optional arg) "Insert a newline, and move to left margin of the new line if it's blank. -If `use-hard-newlines' is non-nil, the newline is marked with the +If option `use-hard-newlines' is non-nil, the newline is marked with the text-property `hard'. With ARG, insert that many newlines. Call `auto-fill-function' if the current column number is greater @@ -837,7 +837,7 @@ instead of deleted." "Delete the previous N characters (following if N is negative). If Transient Mark mode is enabled, the mark is active, and N is 1, delete the text in the region and deactivate the mark instead. -To disable this, set `delete-active-region' to nil. +To disable this, set option `delete-active-region' to nil. Optional second arg KILLFLAG, if non-nil, means to kill (save in kill ring) instead of delete. Interactively, N is the prefix @@ -873,7 +873,7 @@ the end of the line." "Delete the following N characters (previous if N is negative). If Transient Mark mode is enabled, the mark is active, and N is 1, delete the text in the region and deactivate the mark instead. -To disable this, set `delete-active-region' to nil. +To disable this, set variable `delete-active-region' to nil. Optional second arg KILLFLAG non-nil means to kill (save in kill ring) instead of delete. Interactively, N is the prefix arg, and @@ -1778,7 +1778,7 @@ Intended to be added to `minibuffer-setup-hook'." If there are no search errors, this function displays an overlay with the isearch prompt which replaces the original minibuffer prompt. Otherwise, it displays the standard isearch message returned from -`isearch-message'." +the function `isearch-message'." (if (not (and (minibufferp) isearch-success (not isearch-error))) ;; Use standard function `isearch-message' when not in the minibuffer, ;; or search fails, or has an error (like incomplete regexp). @@ -3805,7 +3805,7 @@ If `show-trailing-whitespace' is non-nil, this command will just kill the rest of the current line, even if there are only nonblanks there. -If `kill-whole-line' is non-nil, then this command kills the whole line +If option `kill-whole-line' is non-nil, then this command kills the whole line including its terminating newline, when used at the beginning of a line with no argument. As a consequence, you can always kill a whole line by typing \\[move-beginning-of-line] \\[kill-line]. @@ -4575,13 +4575,13 @@ to use and more reliable (no dependence on goal column, etc.)." "Non-nil means vertical motion starting at end of line keeps to ends of lines. This means moving to the end of each line moved onto. The beginning of a blank line does not count as the end of a line. -This has no effect when `line-move-visual' is non-nil." +This has no effect when the variable `line-move-visual' is non-nil." :type 'boolean :group 'editing-basics) (defcustom goal-column nil "Semipermanent goal column for vertical motion, as set by \\[set-goal-column], or nil. -A non-nil setting overrides `line-move-visual', which see." +A non-nil setting overrides the variable `line-move-visual', which see." :type '(choice integer (const :tag "None" nil)) :group 'editing-basics) @@ -4592,7 +4592,7 @@ A non-nil setting overrides `line-move-visual', which see." It is the column where point was at the start of the current run of vertical motion commands. -When moving by visual lines via `line-move-visual', it is a cons +When moving by visual lines via the function `line-move-visual', it is a cons cell (COL . HSCROLL), where COL is the x-position, in pixels, divided by the default column width, and HSCROLL is the number of columns by which window is scrolled from left margin. diff --git a/lisp/textmodes/flyspell.el b/lisp/textmodes/flyspell.el index fe2f808c594..6ab3e3d3f16 100644 --- a/lisp/textmodes/flyspell.el +++ b/lisp/textmodes/flyspell.el @@ -63,7 +63,7 @@ Non-nil means use highlight, nil means use minibuffer messages." "Non-nil means Flyspell reports a repeated word as an error. See `flyspell-mark-duplications-exceptions' to add exceptions to this rule. Detection of repeated words is not implemented in -\"large\" regions; see `flyspell-large-region'." +\"large\" regions; see variable `flyspell-large-region'." :group 'flyspell :type 'boolean) @@ -145,9 +145,10 @@ whose length is specified by `flyspell-delay'." (defcustom flyspell-default-deplacement-commands '(next-line previous-line handle-switch-frame handle-select-window - scroll-up scroll-down) + scroll-up + scroll-down) "The standard list of deplacement commands for Flyspell. -See `flyspell-deplacement-commands'." +See variable `flyspell-deplacement-commands'." :group 'flyspell :version "21.1" :type '(repeat (symbol))) diff --git a/lisp/textmodes/ispell.el b/lisp/textmodes/ispell.el index 067ffdaa1f0..52e97b8248d 100644 --- a/lisp/textmodes/ispell.el +++ b/lisp/textmodes/ispell.el @@ -1594,8 +1594,8 @@ You can set this variable in hooks in your init file -- eg: (defun ispell-accept-output (&optional timeout-secs timeout-msecs) "Wait for output from ispell process, or TIMEOUT-SECS and TIMEOUT-MSECS. -If asynchronous subprocesses are not supported, call `ispell-filter' and -pass it the output of the last ispell invocation." +If asynchronous subprocesses are not supported, call function `ispell-filter' +and pass it the output of the last ispell invocation." (if ispell-async-processp (accept-process-output ispell-process timeout-secs timeout-msecs) (if (null ispell-process) diff --git a/lisp/textmodes/sgml-mode.el b/lisp/textmodes/sgml-mode.el index a7e44402a26..b7288772034 100644 --- a/lisp/textmodes/sgml-mode.el +++ b/lisp/textmodes/sgml-mode.el @@ -1926,7 +1926,7 @@ This takes effect when first loading the library.") ("ul" . "Unordered list") ("var" . "Math variable face") ("wbr" . "Enable
within ")) - "Value of `sgml-tag-help' for HTML mode.") + "Value of variable `sgml-tag-help' for HTML mode.") (defvar outline-regexp) (defvar outline-heading-end-regexp) diff --git a/lisp/vc/compare-w.el b/lisp/vc/compare-w.el index 2423d322460..fa451ccbe20 100644 --- a/lisp/vc/compare-w.el +++ b/lisp/vc/compare-w.el @@ -53,13 +53,13 @@ whitespace is considered to match, and is skipped." :group 'compare-windows) (defcustom compare-ignore-whitespace nil - "Non-nil means `compare-windows' ignores whitespace." + "Non-nil means command `compare-windows' ignores whitespace." :type 'boolean :group 'compare-windows :version "22.1") (defcustom compare-ignore-case nil - "Non-nil means `compare-windows' ignores case differences." + "Non-nil means command `compare-windows' ignores case differences." :type 'boolean :group 'compare-windows) @@ -379,7 +379,7 @@ on third call it again advances points to the next difference and so on." (delete-overlay compare-windows-overlay2))))) (defun compare-windows-dehighlight () - "Remove highlighting created by `compare-windows-highlight'." + "Remove highlighting created by function `compare-windows-highlight'." (interactive) (remove-hook 'pre-command-hook 'compare-windows-dehighlight) (mapc 'delete-overlay compare-windows-overlays1) diff --git a/lisp/vc/diff.el b/lisp/vc/diff.el index d0e496d2d21..8b4ff792969 100644 --- a/lisp/vc/diff.el +++ b/lisp/vc/diff.el @@ -86,7 +86,7 @@ exists. If NO-ASYNC is non-nil, call diff synchronously. When called interactively with a prefix argument, prompt interactively for diff switches. Otherwise, the switches -specified in `diff-switches' are passed to the diff command." +specified in the variable `diff-switches' are passed to the diff command." (interactive (let* ((newf (if (and buffer-file-name (file-exists-p buffer-file-name)) (read-file-name diff --git a/lisp/whitespace.el b/lisp/whitespace.el index e2a726f4264..ed7edbc5a68 100644 --- a/lisp/whitespace.el +++ b/lisp/whitespace.el @@ -1271,19 +1271,19 @@ SYMBOL is a valid symbol associated with CHAR. (defvar whitespace-point (point) "Used to save locally current point value. -Used by `whitespace-trailing-regexp' function (which see).") +Used by function `whitespace-trailing-regexp' (which see).") (defvar whitespace-font-lock-refontify nil "Used to save locally the font-lock refontify state. -Used by `whitespace-post-command-hook' function (which see).") +Used by function `whitespace-post-command-hook' (which see).") (defvar whitespace-bob-marker nil "Used to save locally the bob marker value. -Used by `whitespace-post-command-hook' function (which see).") +Used by function `whitespace-post-command-hook' (which see).") (defvar whitespace-eob-marker nil "Used to save locally the eob marker value. -Used by `whitespace-post-command-hook' function (which see).") +Used by function `whitespace-post-command-hook' (which see).") (defvar whitespace-buffer-changed nil "Used to indicate locally if buffer changed. diff --git a/src/ChangeLog b/src/ChangeLog index 13a1f1a3858..01862b689f8 100644 --- a/src/ChangeLog +++ b/src/ChangeLog @@ -1,3 +1,14 @@ +2013-01-11 Aaron S. Hawley + + * insdel.c (Fcombine_after_change_execute, syms_of_insdel): Fix + ambiguous doc string cross-reference(s). + + * keyboard.c (Fcommand_execute, syms_of_keyboard): Fix ambiguous + doc string cross-reference(s). + + * window.c (Fwindow_point, syms_of_window): Fix ambiguous doc + string cross-reference(s). + 2013-01-11 Dmitry Antipov Avoid unnecessary byte position calculation for the gap movement. diff --git a/src/insdel.c b/src/insdel.c index c2a3cd42821..303247816ca 100644 --- a/src/insdel.c +++ b/src/insdel.c @@ -2084,7 +2084,7 @@ Fcombine_after_change_execute_1 (Lisp_Object val) DEFUN ("combine-after-change-execute", Fcombine_after_change_execute, Scombine_after_change_execute, 0, 0, 0, - doc: /* This function is for use internally in `combine-after-change-calls'. */) + doc: /* This function is for use internally in the function `combine-after-change-calls'. */) (void) { ptrdiff_t count = SPECPDL_INDEX (); @@ -2176,7 +2176,7 @@ syms_of_insdel (void) combine_after_change_buffer = Qnil; DEFVAR_LISP ("combine-after-change-calls", Vcombine_after_change_calls, - doc: /* Used internally by the `combine-after-change-calls' macro. */); + doc: /* Used internally by the function `combine-after-change-calls' macro. */); Vcombine_after_change_calls = Qnil; DEFVAR_BOOL ("inhibit-modification-hooks", inhibit_modification_hooks, diff --git a/src/keyboard.c b/src/keyboard.c index 14aecd00e90..7594a4f72fc 100644 --- a/src/keyboard.c +++ b/src/keyboard.c @@ -10170,7 +10170,7 @@ DEFUN ("command-execute", Fcommand_execute, Scommand_execute, 1, 4, 0, doc: /* Execute CMD as an editor command. CMD must be a symbol that satisfies the `commandp' predicate. Optional second arg RECORD-FLAG non-nil -means unconditionally put this command in `command-history'. +means unconditionally put this command in the variable `command-history'. Otherwise, that is done only if an arg is read using the minibuffer. The argument KEYS specifies the value to use instead of (this-command-keys) when reading the arguments; if it is nil, (this-command-keys) is used. @@ -12055,8 +12055,8 @@ This takes effect only when Transient Mark mode is enabled. */); Vsaved_region_selection, doc: /* Contents of active region prior to buffer modification. If `select-active-regions' is non-nil, Emacs sets this to the -text in the region before modifying the buffer. The next -`deactivate-mark' call uses this to set the window selection. */); +text in the region before modifying the buffer. The next call to +the function `deactivate-mark' uses this to set the window selection. */); Vsaved_region_selection = Qnil; DEFVAR_LISP ("selection-inhibit-update-commands", diff --git a/src/window.c b/src/window.c index 0e5ba04bb98..e60b9e8967d 100644 --- a/src/window.c +++ b/src/window.c @@ -1436,7 +1436,7 @@ window were selected. Note that, when WINDOW is selected, the value returned is the same as that returned by `point' for WINDOW's buffer. It would be more strictly -correct to return the `top-level' value of `point', outside of any +correct to return the top-level value of `point', outside of any `save-excursion' forms. But that is hard to define. */) (Lisp_Object window) { @@ -6793,7 +6793,8 @@ same combination. Other values are reserved for future use. -This variable takes no effect if `window-combination-limit' is non-nil. */); +This variable takes no effect if the variable `window-combination-limit' is +non-nil. */); Vwindow_combination_resize = Qnil; DEFVAR_LISP ("window-combination-limit", Vwindow_combination_limit, -- 2.11.4.GIT