From c0793cd9dea407e244537f77361cfbe5077181db Mon Sep 17 00:00:00 2001 From: Stefan Kangas Date: Mon, 4 Oct 2021 01:08:03 +0200 Subject: [PATCH] Don't use some obsolete names in documentation * admin/notes/bugtracker: Use non-obsolete name 'mail-dont-reply-to-names'. * admin/notes/multi-tty: Mention new variable name 'x-selection-value'. * doc/lispintro/emacs-lisp-intro.texi (Point and mark) (Point and mark, Design @value{COUNT-WORDS}): Avoid using obsolete name 'count-lines-region'. * doc/lispref/hooks.texi (Standard Hooks): Remove reference to obsolete abnormal hook 'completion-annotate-function'. * doc/misc/efaq.texi (SPC no longer completes file names): Remove reference to obsolete 'minibuffer-local-filename-must-match-map'; setting it has no effect. * doc/misc/gnus.texi (NNTP): Remove reference to obsolete variable 'nntp-authinfo-file'. * doc/misc/reftex.texi (Table of Contents, Creating Citations) (Options - Table of Contents, Options - Referencing Labels) (Options - Creating Citations, Options - Index Support) (Options - Index Support, Changes): Don't use obsolete names. * doc/misc/speedbar.texi (Minor Display Modes) (Major Display Modes): Make variable name suggestions more in line with existing non-obsolete variable. * lisp/textmodes/reftex-cite.el (reftex-select-bib-mode-map): * lisp/textmodes/reftex-ref.el (reftex-offer-label-menu): Don't use obsolete variable names. * lisp/progmodes/which-func.el (which-func-mode): Doc fix. --- admin/notes/bugtracker | 2 +- admin/notes/multi-tty | 2 +- doc/lispintro/emacs-lisp-intro.texi | 7 +++---- doc/lispref/hooks.texi | 1 - doc/misc/efaq.texi | 3 --- doc/misc/gnus.texi | 4 +--- doc/misc/reftex.texi | 26 +++++++++++++------------- doc/misc/speedbar.texi | 6 +++--- lisp/progmodes/which-func.el | 3 ++- lisp/textmodes/reftex-cite.el | 4 ++-- lisp/textmodes/reftex-ref.el | 4 ++-- 11 files changed, 28 insertions(+), 34 deletions(-) diff --git a/admin/notes/bugtracker b/admin/notes/bugtracker index 9eb65e1f864..deb06f552cc 100644 --- a/admin/notes/bugtracker +++ b/admin/notes/bugtracker @@ -84,7 +84,7 @@ generate a new report. The only time to send mail to the bug list address is to create a new report. Gnus users can add the following to message-dont-reply-to-names; -similarly with Rmail and rmail-dont-reply-to-names: +similarly with Rmail and mail-dont-reply-to-names: "\\(emacs-pretest-bug\\|bug-gnu-emacs\\|bug-\\(e\\|gnu\\)macs\\)@gnu\\.org\\|\ \\(submit\\|control\\|owner\\)@debbugs\\.gnu\\.org" diff --git a/admin/notes/multi-tty b/admin/notes/multi-tty index 1a337b9d799..fa4df820ae4 100644 --- a/admin/notes/multi-tty +++ b/admin/notes/multi-tty @@ -474,7 +474,7 @@ THINGS TO DO definition. Exceptions found so far: x-select-text and - x-cut-buffer-or-selection-value. + x-selection-value (old name: x-cut-buffer-or-selection-value). ** Have a look at fatal_error_hook. diff --git a/doc/lispintro/emacs-lisp-intro.texi b/doc/lispintro/emacs-lisp-intro.texi index 7c7005b3483..9dbf854171c 100644 --- a/doc/lispintro/emacs-lisp-intro.texi +++ b/doc/lispintro/emacs-lisp-intro.texi @@ -4201,7 +4201,7 @@ times. The part of the buffer between point and mark is called @dfn{the region}. Numerous commands work on the region, including -@code{center-region}, @code{count-lines-region}, @code{kill-region}, and +@code{center-region}, @code{count-words-region}, @code{kill-region}, and @code{print-region}. The @code{save-excursion} special form saves the location of point and @@ -4214,7 +4214,7 @@ evaluated. In Emacs, a function frequently moves point as part of its internal workings even though a user would not expect this. For example, -@code{count-lines-region} moves point. To prevent the user from being +@code{count-words-region} moves point. To prevent the user from being bothered by jumps that are both unexpected and (from the user's point of view) unnecessary, @code{save-excursion} is often used to keep point in the location expected by the user. The use of @@ -13473,8 +13473,7 @@ The template for an interactive function definition is, as always: What we need to do is fill in the slots. -The name of the function should be self-explanatory and similar to the -existing @code{count-lines-region} name. This makes the name easier +The name of the function should be self-explanatory and easy to remember. @code{count-words-region} is the obvious choice. Since that name is now used for the standard Emacs command to count words, we will name our implementation @code{@value{COUNT-WORDS}}. diff --git a/doc/lispref/hooks.texi b/doc/lispref/hooks.texi index 394928454b0..feec8b24f46 100644 --- a/doc/lispref/hooks.texi +++ b/doc/lispref/hooks.texi @@ -262,7 +262,6 @@ after-set-visited-file-name-hook auto-coding-functions choose-completion-string-functions completing-read-function -completion-annotate-function completion-at-point-functions completion-list-insert-choice-function deactivate-current-input-method-function diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi index f80ccc080a0..18342e65b0a 100644 --- a/doc/misc/efaq.texi +++ b/doc/misc/efaq.texi @@ -4136,9 +4136,6 @@ You can get the old behavior by binding @kbd{SPC} to @lisp (define-key minibuffer-local-filename-completion-map (kbd "SPC") 'minibuffer-complete-word) - -(define-key minibuffer-local-filename-must-match-map (kbd "SPC") - 'minibuffer-complete-word) @end lisp @c ------------------------------------------------------------ diff --git a/doc/misc/gnus.texi b/doc/misc/gnus.texi index 9e433e11c81..0c065584c45 100644 --- a/doc/misc/gnus.texi +++ b/doc/misc/gnus.texi @@ -13875,11 +13875,9 @@ present in this hook. @item nntp-authinfo-function @vindex nntp-authinfo-function @findex nntp-send-authinfo -@vindex nntp-authinfo-file This function will be used to send @samp{AUTHINFO} to the @acronym{NNTP} server. The default function is @code{nntp-send-authinfo}, which looks -through your @file{~/.authinfo} (or whatever you've set the -@code{nntp-authinfo-file} variable to) for applicable entries. If none +through your @file{~/.authinfo} for applicable entries. If none are found, it will prompt you for a login name and a password. The format of the @file{~/.authinfo} file is (almost) the same as the @code{ftp} @file{~/.netrc} file, which is defined in the @code{ftp} diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index 8ca5fcca5ba..8bde241e18f 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi @@ -658,9 +658,9 @@ variable @code{reftex-auto-recenter-toc}. @end table -@vindex reftex-toc-map +@vindex reftex-toc-mode-map In order to define additional commands for the @file{*toc*} buffer, the -keymap @code{reftex-toc-map} may be used. +keymap @code{reftex-toc-mode-map} may be used. @findex reftex-toc-recenter @vindex reftex-auto-recenter-toc @@ -1021,9 +1021,9 @@ document and let you select a label from there (@pxref{LaTeX xr Package,,xr}). @end table -@vindex reftex-select-label-map +@vindex reftex-select-label-mode-map In order to define additional commands for the selection process, the -keymap @code{reftex-select-label-map} may be used. +keymap @code{reftex-select-label-mode-map} may be used. @node Builtin Label Environments @section Builtin Label Environments @@ -1871,9 +1871,9 @@ entries. @end table -@vindex reftex-select-bib-map +@vindex reftex-select-bib-mode-map In order to define additional commands for this selection process, the -keymap @code{reftex-select-bib-map} may be used. +keymap @code{reftex-select-bib-mode-map} may be used. Note that if you do not use Emacs to edit the @BibTeX{} database files, @RefTeX{} will ask if the related buffers should be updated once it @@ -3960,7 +3960,7 @@ Normal hook which is run when a @file{*toc*} buffer is created. @end deffn -@deffn Keymap reftex-toc-map +@deffn Keymap reftex-toc-mode-map The keymap which is active in the @file{*toc*} buffer. (@pxref{Table of Contents}). @end deffn @@ -4425,7 +4425,7 @@ Normal hook which is run when a selection buffer enters @code{reftex-select-label-mode}. @end deffn -@deffn Keymap reftex-select-label-map +@deffn Keymap reftex-select-label-mode-map The keymap which is active in the labels selection process (@pxref{Referencing Labels}). @end deffn @@ -4586,7 +4586,7 @@ Normal hook which is run when a selection buffer enters @code{reftex-select-bib-mode}. @end deffn -@deffn Keymap reftex-select-bib-map +@deffn Keymap reftex-select-bib-mode-map The keymap which is active in the citation-key selection process (@pxref{Creating Citations}). @end deffn @@ -4792,7 +4792,7 @@ into blocks. Sorting will then preserve blocks, so that lines are re-arranged only within blocks. @end defopt -@defopt reftex-index-phrases-map +@defopt reftex-index-phrases-mode-map Keymap for the Index Phrases buffer. @end defopt @@ -4824,7 +4824,7 @@ the document. This flag can be toggled from within the @file{*Index*} buffer with the @kbd{f} key. @end defopt -@deffn Keymap reftex-index-map +@deffn Keymap reftex-index-mode-map The keymap which is active in the @file{*Index*} buffer (@pxref{Index Support}). @end deffn @@ -5813,8 +5813,8 @@ buffer). @noindent @b{Version 3.12} @itemize @bullet @item -There are 3 new keymaps for customization: @code{reftex-toc-map}, -@code{reftex-select-label-map}, @code{reftex-select-bib-map}. +There are 3 new keymaps for customization: @code{reftex-toc-mode-map}, +@code{reftex-select-label-mode-map}, @code{reftex-select-bib-mode-map}. @item Refontification uses more standard font-lock stuff. @item diff --git a/doc/misc/speedbar.texi b/doc/misc/speedbar.texi index 9991917b3fd..70d4b054166 100644 --- a/doc/misc/speedbar.texi +++ b/doc/misc/speedbar.texi @@ -896,7 +896,7 @@ augmented with speedbar. @enumerate @item -Create the keymap variable @code{@var{name}-speedbar-key-map}. +Create the keymap variable @code{@var{name}-speedbar-mode-map}. @item Create a function, named whatever you like, which assigns values into your @@ -904,7 +904,7 @@ keymap. Use this command to create the keymap before assigning bindings: @smallexample - (setq @var{name}-speedbar-key-map (speedbar-make-specialized-keymap)) + (setq @var{name}-speedbar-mode-map (speedbar-make-specialized-keymap)) @end smallexample This function creates a special keymap for use in speedbar. @@ -977,7 +977,7 @@ Next, register your extension like this; @example (speedbar-add-expansion-list '("MyExtension" MyExtension-speedbar-menu-items - MyExtension-speedbar-key-map + MyExtension-speedbar-mode-map MyExtension-speedbar-buttons)) @end example diff --git a/lisp/progmodes/which-func.el b/lisp/progmodes/which-func.el index 8946e2c3f42..176f599649f 100644 --- a/lisp/progmodes/which-func.el +++ b/lisp/progmodes/which-func.el @@ -185,7 +185,8 @@ and you want to simplify them for the mode line (defvar-local which-func-mode nil "Non-nil means display current function name in mode line. -This makes a difference only if `which-function-mode' is non-nil.") +This makes a difference only if variable `which-function-mode' is +non-nil.") (add-hook 'after-change-major-mode-hook #'which-func-ff-hook t) diff --git a/lisp/textmodes/reftex-cite.el b/lisp/textmodes/reftex-cite.el index 8a54b1a301f..e1475934ddb 100644 --- a/lisp/textmodes/reftex-cite.el +++ b/lisp/textmodes/reftex-cite.el @@ -814,7 +814,7 @@ in order to only add another reference in the same cite command." (interactive) (reftex-citation nil ?t)) -(defvar reftex-select-bib-map) +(defvar reftex-select-bib-mode-map) (defvar reftex--found-list) (defun reftex-offer-bib-menu () "Offer bib menu and return list of selected items." @@ -870,7 +870,7 @@ in order to only add another reference in the same cite command." (reftex-select-item reftex-citation-prompt reftex-citation-help - reftex-select-bib-map + reftex-select-bib-mode-map nil 'reftex-bibtex-selection-callback nil)) (setq key (car rtn) diff --git a/lisp/textmodes/reftex-ref.el b/lisp/textmodes/reftex-ref.el index 9d5bc5a8f0f..a5d83c34d67 100644 --- a/lisp/textmodes/reftex-ref.el +++ b/lisp/textmodes/reftex-ref.el @@ -533,7 +533,7 @@ When called with 2 \\[universal-argument] prefix args, disable magic word recogn (cons (cdr cell) (- (match-end 0) (match-end 1))) nil))) -(defvar reftex-select-label-map) +(defvar reftex-select-label-mode-map) (defun reftex-offer-label-menu (typekey) ;; Offer a menu with the appropriate labels. (let* ((buf (current-buffer)) @@ -605,7 +605,7 @@ When called with 2 \\[universal-argument] prefix args, disable magic word recogn (reftex-select-item reftex-select-label-prompt reftex-select-label-help - reftex-select-label-map + reftex-select-label-mode-map offset 'reftex-show-label-location follow)) (setq key (car rtn) -- 2.39.5