diff options
| author | Jonas Bernoulli <jonas@bernoul.li> | 2018-11-13 19:45:33 +0100 |
|---|---|---|
| committer | Jonas Bernoulli <jonas@bernoul.li> | 2018-11-13 19:45:33 +0100 |
| commit | 9dd9f176d96abc60365369de6d08c26c414ef1f3 (patch) | |
| tree | f8e2d53c7c86757e2e146e8da2414f2efe632bfa | |
| parent | 87c96b3a7cdf9ab9477e27f1ae2010883a83a426 (diff) | |
manual: Clarify with-editor-shell-command's descriptionv2.8.1
The old description wasn't exactly wrong but misleading non-the-less.
Closes #60.
| -rw-r--r-- | with-editor.org | 11 | ||||
| -rw-r--r-- | with-editor.texi | 11 |
2 files changed, 10 insertions, 12 deletions
diff --git a/with-editor.org b/with-editor.org index 4066aba..443a615 100644 --- a/with-editor.org +++ b/with-editor.org @@ -8,7 +8,7 @@ #+TEXINFO_DIR_CATEGORY: Emacs #+TEXINFO_DIR_TITLE: With-Editor: (with-editor). #+TEXINFO_DIR_DESC: Using the Emacsclient as $EDITOR -#+SUBTITLE: for version 2.8.0 +#+SUBTITLE: for version 2.8.0 (v2.8.0-2-g87c96b3+1) #+BIND: ox-texinfo+-before-export-hook ox-texinfo+-update-version-strings #+TEXINFO_DEFFN: t @@ -30,7 +30,7 @@ additional functionality which makes it useful even for end-users, who don't use Magit or another package which uses it internally. #+TEXINFO: @noindent -This manual is for With-Editor version 2.8.0. +This manual is for With-Editor version 2.8.0 (v2.8.0-2-g87c96b3+1). #+BEGIN_QUOTE Copyright (C) 2015-2018 Jonas Bernoulli <jonas@bernoul.li> @@ -169,10 +169,9 @@ prompt for an alternative environment variable such as ~$GIT_EDITOR~. - Command: with-editor-shell-command - This command is like ~async-shell-command~, but it runs the shell - command with the current Emacs instance exported as ~$EDITOR~. This - only has an effect if the shell command is run asynchronously, - i.e. when the command ends with ~&~. + This command is like ~shell-command~, but if the shell command ends + with ~&~ and is therefore run asynchronously, then the current Emacs + instance is exported as ~$EDITOR~. To always use these variants add this to you init file: diff --git a/with-editor.texi b/with-editor.texi index 452c14d..8c9462c 100644 --- a/with-editor.texi +++ b/with-editor.texi @@ -31,7 +31,7 @@ General Public License for more details. @finalout @titlepage @title With-Editor User Manual -@subtitle for version 2.8.0 +@subtitle for version 2.8.0 (v2.8.0-2-g87c96b3+1) @author Jonas Bernoulli @page @vskip 0pt plus 1filll @@ -60,7 +60,7 @@ additional functionality which makes it useful even for end-users, who don't use Magit or another package which uses it internally. @noindent -This manual is for With-Editor version 2.8.0. +This manual is for With-Editor version 2.8.0 (v2.8.0-2-g87c96b3+1). @quotation Copyright (C) 2015-2018 Jonas Bernoulli <jonas@@bernoul.li> @@ -231,10 +231,9 @@ command with the current Emacs instance exported as @code{$EDITOR}. @cindex with-editor-shell-command @deffn Command with-editor-shell-command -This command is like @code{async-shell-command}, but it runs the shell -command with the current Emacs instance exported as @code{$EDITOR}. This -only has an effect if the shell command is run asynchronously, -i.e. when the command ends with @code{&}. +This command is like @code{shell-command}, but if the shell command ends +with @code{&} and is therefore run asynchronously, then the current Emacs +instance is exported as @code{$EDITOR}. @end deffn To always use these variants add this to you init file: |