From ef57169b999d1354f97b8724e452eec3c02e4fa4 Mon Sep 17 00:00:00 2001 From: Michael Albinus Date: Tue, 7 Aug 2018 12:32:04 +0200 Subject: [PATCH] Update documentation wrt universal-async-argument * doc/emacs/files.texi (Visiting): Add @kindex. Mention command name. * doc/lispref/files.texi (Visiting Functions): Adapt wording. * lisp/files.el (find-file, find-file-other-window) (find-file-other-frame, find-file-existing) (find-alternate-file-other-window, find-alternate-file) (execute-file-commands-asynchronously, find-file-literally): Adapt docstring. --- doc/emacs/files.texi | 12 +++++++----- doc/lispref/files.texi | 7 +++---- lisp/files.el | 16 ++++++++-------- 3 files changed, 18 insertions(+), 17 deletions(-) diff --git a/doc/emacs/files.texi b/doc/emacs/files.texi index 197cceb0697..e2389a3806d 100644 --- a/doc/emacs/files.texi +++ b/doc/emacs/files.texi @@ -250,11 +250,13 @@ If you want to visit all remote files asynchronously, you should set @end group @end example - With the key sequence @kbd{C-x &} prior the file visiting command, -the meaning of @code{execute-file-commands-asynchronously} will be -reverted. If this user option is @code{nil}, visiting a file is -performed asynchronously. Contrary, if this user option is -non-@code{nil}, visiting a file is performed synchronously. +@kindex C-x & + If you type @kbd{C-x &} (@code{universal-async-argument}) prior the +file visiting command, the meaning of +@code{execute-file-commands-asynchronously} will be reverted. If this +user option is @code{nil}, visiting a file is performed +asynchronously. Contrary, if this user option is non-@code{nil}, +visiting a file is performed synchronously. @kindex C-x C-v @findex find-alternate-file diff --git a/doc/lispref/files.texi b/doc/lispref/files.texi index dddc1b8cc60..200e7ab7214 100644 --- a/doc/lispref/files.texi +++ b/doc/lispref/files.texi @@ -119,7 +119,7 @@ interactive call, then @code{find-file} expands wildcard characters in If @var{async} is non-@code{nil}, the file will be loaded into the buffer asynchronously. Interactively, this is indicated by either setting user option @code{execute-file-commands-asynchronously} to -non-@code{nil}, or by the key sequence @kbd{C-x &} +non-@code{nil}, or by typing @kbd{C-x &} (@code{universal-async-argument}) prior the command. When @code{find-file} is called interactively, it prompts for @@ -235,9 +235,8 @@ and never treat wildcard characters specially. If this variable is non-@code{nil}, a file will be visited asynchronously when called interactively. If it is a regular expression, it must match the file name to be visited. This behavior -is toggled by the key sequence @kbd{C-x &} -(@code{universal-async-argument}) prior to the interactive call of the -file visiting command. +is toggled by the command @kbd{C-x &} (@code{universal-async-argument}) +prior to the interactive call of the file visiting command. @end defopt @defopt find-file-hook diff --git a/lisp/files.el b/lisp/files.el index 6ac7e436aec..1d404fcb9b1 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -1625,7 +1625,7 @@ suppress wildcard expansion by setting `find-file-wildcards' to nil. If ASYNC is non-nil, the file will be loaded into the buffer asynchronously. Interactively, this is indicated by setting `execute-file-commands-asynchronously' to a proper non-nil value. -This behavior can be toggled by the key sequence \\[universal-async-argument] +This behavior can be toggled by \\[universal-async-argument] prior the command invocation. To visit a file without any kind of conversion and without @@ -1663,7 +1663,7 @@ expand wildcards (if any) and visit multiple files. If ASYNC is non-nil, the file will be loaded into the buffer asynchronously. Interactively, this is indicated by setting `execute-file-commands-asynchronously' to a proper non-nil value. -This behavior can be toggled by the key sequence \\[universal-async-argument] +This behavior can be toggled by \\[universal-async-argument] prior the command invocation." (interactive (find-file-read-args "Find file in other window: " @@ -1702,7 +1702,7 @@ expand wildcards (if any) and visit multiple files. If ASYNC is non-nil, the file will be loaded into the buffer asynchronously. Interactively, this is indicated by setting `execute-file-commands-asynchronously' to a proper non-nil value. -This behavior can be toggled by the key sequence \\[universal-async-argument] +This behavior can be toggled by \\[universal-async-argument] prior the command invocation." (interactive (find-file-read-args "Find file in other frame: " @@ -1725,7 +1725,7 @@ file names with wildcards. If ASYNC is non-nil, the file will be loaded into the buffer asynchronously. Interactively, this is indicated by setting `execute-file-commands-asynchronously' to a proper non-nil value. -This behavior can be toggled by the key sequence \\[universal-async-argument] +This behavior can be toggled by \\[universal-async-argument] prior the command invocation." (interactive (find-file-read-args "Find existing file: " t)) @@ -1785,7 +1785,7 @@ expand wildcards (if any) and replace the file with multiple files. If ASYNC is non-nil, the file will be loaded into the buffer asynchronously. Interactively, this is indicated by setting `execute-file-commands-asynchronously' to a proper non-nil value. -This behavior can be toggled by the key sequence \\[universal-async-argument] +This behavior can be toggled by \\[universal-async-argument] prior the command invocation." (interactive (save-selected-window @@ -1831,7 +1831,7 @@ expand wildcards (if any) and replace the file with multiple files. If ASYNC is non-nil, the file will be loaded into the buffer asynchronously. Interactively, this is indicated by setting `execute-file-commands-asynchronously' to a proper non-nil value. -This behavior can be toggled by the key sequence \\[universal-async-argument] +This behavior can be toggled by \\[universal-async-argument] prior the command invocation. If the current buffer is an indirect buffer, or the base buffer @@ -2082,7 +2082,7 @@ suppresses this warning." (defcustom execute-file-commands-asynchronously nil "Non-nil means visit file asynchronously when called interactively. If it is a regular expression, it must match the file name to be -visited. This behavior is toggled by the key sequence \\[universal-async-argument] +visited. This behavior is toggled by \\[universal-async-argument] prior the command invocation." :group 'files :version "27.1" @@ -2508,7 +2508,7 @@ this command asks you whether to visit it literally instead. If ASYNC is non-nil, the file will be loaded into the buffer asynchronously. Interactively, this is indicated by setting `execute-file-commands-asynchronously' to a proper non-nil value. -This behavior can be toggled by the key sequence \\[universal-async-argument] +This behavior can be toggled by \\[universal-async-argument] prior the command invocation. In non-interactive use, the value is the buffer where the file is -- 2.39.5