update packages
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
This is with-editor.info, produced by makeinfo version 6.8 from
|
||||
This is with-editor.info, produced by makeinfo version 7.1.1 from
|
||||
with-editor.texi.
|
||||
|
||||
Copyright (C) 2015-2023 Jonas Bernoulli <jonas@bernoul.li>
|
||||
Copyright (C) 2015-2024 Jonas Bernoulli
|
||||
<emacs.with-editor@jonas.bernoulli.dev>
|
||||
|
||||
You can redistribute this document and/or modify it under the terms
|
||||
of the GNU General Public License as published by the Free Software
|
||||
@@ -32,16 +33,17 @@ does.
|
||||
|
||||
This library was written because Magit has to be able to do the above
|
||||
to allow the user to edit commit messages gracefully and to edit rebase
|
||||
sequences, which wouldn’t be possible at all otherwise.
|
||||
sequences, which wouldn't be possible at all otherwise.
|
||||
|
||||
Because other packages can benefit from such functionality, this
|
||||
library is made available as a separate package. It also defines some
|
||||
additional functionality which makes it useful even for end-users, who
|
||||
don’t use Magit or another package which uses it internally.
|
||||
don't use Magit or another package which uses it internally.
|
||||
|
||||
This manual is for With-Editor version 3.3.2.
|
||||
This manual is for With-Editor version 3.4.3.
|
||||
|
||||
Copyright (C) 2015-2023 Jonas Bernoulli <jonas@bernoul.li>
|
||||
Copyright (C) 2015-2024 Jonas Bernoulli
|
||||
<emacs.with-editor@jonas.bernoulli.dev>
|
||||
|
||||
You can redistribute this document and/or modify it under the terms
|
||||
of the GNU General Public License as published by the Free Software
|
||||
@@ -61,7 +63,7 @@ This manual is for With-Editor version 3.3.2.
|
||||
* Function and Command Index::
|
||||
* Variable Index::
|
||||
|
||||
— The Detailed Node Listing —
|
||||
-- The Detailed Node Listing --
|
||||
|
||||
Using the With-Editor package
|
||||
|
||||
@@ -77,10 +79,10 @@ File: with-editor.info, Node: Using the With-Editor package, Next: Using With-
|
||||
|
||||
The ‘With-Editor’ package is used internally by Magit when editing
|
||||
commit messages and rebase sequences. It also provides some commands
|
||||
and features which are useful by themselves, even if you don’t use
|
||||
and features which are useful by themselves, even if you don't use
|
||||
Magit.
|
||||
|
||||
For information about using this library in you own package, see
|
||||
For information about using this library in your own package, see
|
||||
*note Using With-Editor as a library::.
|
||||
|
||||
* Menu:
|
||||
@@ -102,9 +104,9 @@ Emacs (most likely on macOS) without putting the executable on ‘$PATH’,
|
||||
and we have to add another kludge to find it anyway.
|
||||
|
||||
-- User Option: with-editor-emacsclient-executable
|
||||
The ‘emacsclient’ executable used as the editor by child process of
|
||||
this Emacs instance. By using this executable, child processes can
|
||||
call home to their parent process.
|
||||
The ‘emacsclient’ executable used as the editor by child processes
|
||||
of this Emacs instance. By using this executable, child processes
|
||||
can call home to their parent process.
|
||||
|
||||
This option is automatically set at startup by looking in
|
||||
‘exec-path’, and other places where the executable could be
|
||||
@@ -113,25 +115,25 @@ and we have to add another kludge to find it anyway.
|
||||
|
||||
You should *not* customize this option permanently. If you have to
|
||||
do it, then you should consider that a temporary kludge and inform
|
||||
the Magit maintainer as described in *note Debugging::.
|
||||
the Magit maintainer as described in *note Debugging: Debugging.
|
||||
|
||||
If With-Editor fails to find a suitable ‘emacsclient’ on you
|
||||
If With-Editor fails to find a suitable ‘emacsclient’ on your
|
||||
system, then this should be fixed for all users at once, by
|
||||
teaching ‘with-editor-locate-emacsclient’ how to do so on your
|
||||
system and system like yours. Doing it this way has the advantage,
|
||||
that you won’t have do it again every time you update Emacs, and
|
||||
that other users who have installed Emacs the same way as you have,
|
||||
won’t have to go through the same trouble.
|
||||
system and systems like yours. Doing it this way has the
|
||||
advantage, that you won't have do it again every time you update
|
||||
Emacs, and that other users who have installed Emacs the same way
|
||||
as you have, won't have to go through the same trouble.
|
||||
|
||||
Note that there also is a nuclear option; setting this variable to
|
||||
‘nil’ causes the "sleeping editor" described below to be used even
|
||||
for local child processes. Obviously we don’t recommend that you
|
||||
for local child processes. Obviously we don't recommend that you
|
||||
use this except in "emergencies", i.e., before we had a change to
|
||||
add a kludge appropriate for you setup.
|
||||
add a kludge appropriate for your setup.
|
||||
|
||||
-- Function: with-editor-locate-emacsclient
|
||||
The function used to set the initial value of the option
|
||||
‘with-editor-emacsclient-executable’. There’s a lot of voodoo
|
||||
‘with-editor-emacsclient-executable’. There's a lot of voodoo
|
||||
here.
|
||||
|
||||
The ‘emacsclient’ cannot be used when using Tramp to run a process on
|
||||
@@ -148,12 +150,12 @@ it receives a signal.
|
||||
The sleeping editor is a shell script used as the editor of child
|
||||
processes when the ‘emacsclient’ executable cannot be used.
|
||||
|
||||
This fallback is used for asynchronous process started inside the
|
||||
This fallback is used for asynchronous processes started inside the
|
||||
macro ‘with-editor’, when the process runs on a remote machine or
|
||||
for local processes when ‘with-editor-emacsclient-executable’ is
|
||||
‘nil’.
|
||||
|
||||
Where the latter uses a socket to communicate with Emacs’ server,
|
||||
Where the latter uses a socket to communicate with Emacs' server,
|
||||
this substitute prints edit requests to its standard output on
|
||||
which a process filter listens for such requests. As such it is
|
||||
not a complete substitute for a proper ‘emacsclient’, it can only
|
||||
@@ -190,7 +192,7 @@ File: with-editor.info, Node: Using With-Editor commands, Prev: Configuring Wi
|
||||
==============================
|
||||
|
||||
This section describes how to use the ‘with-editor’ library _outside_ of
|
||||
Magit. You don’t need to know any of this just to create commits using
|
||||
Magit. You don't need to know any of this just to create commits using
|
||||
Magit.
|
||||
|
||||
The commands ‘with-editor-async-shell-command’ and
|
||||
@@ -209,7 +211,7 @@ for an alternative environment variable such as ‘$GIT_EDITOR’.
|
||||
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:
|
||||
To always use these variants add this to your init file:
|
||||
|
||||
(keymap-global-set "<remap> <async-shell-command>"
|
||||
#'with-editor-async-shell-command)
|
||||
@@ -263,7 +265,7 @@ File: with-editor.info, Node: Using With-Editor as a library, Next: Debugging,
|
||||
|
||||
This section describes how to use the ‘with-editor’ library _outside_ of
|
||||
Magit to teach another package how to have its child processes call
|
||||
home, just like Magit does. You don’t need to know any of this just to
|
||||
home, just like Magit does. You don't need to know any of this just to
|
||||
create commits using Magit. You can also ignore this if you use
|
||||
‘with-editor’ outside of Magit, but only as an end-user.
|
||||
|
||||
@@ -286,8 +288,8 @@ package::.
|
||||
If BODY begins with a literal string, then that variable is set
|
||||
instead of ‘EDITOR’.
|
||||
|
||||
-- Macro: with-editor envvar &rest body
|
||||
This macro is like ‘with-editor’ instead that the ENVVAR argument
|
||||
-- Macro: with-editor* envvar &rest body
|
||||
This macro is like ‘with-editor’, except that the ENVVAR argument
|
||||
is required and that it is evaluated at run-time.
|
||||
|
||||
-- Function: with-editor-set-process-filter process filter
|
||||
@@ -295,8 +297,8 @@ package::.
|
||||
the new FILTER does not remove the ‘with-editor-process-filter’.
|
||||
This is done by wrapping the two filter functions using a lambda,
|
||||
which becomes the actual filter. It calls FILTER first, which may
|
||||
or may not insert the text into the PROCESS’s buffer. Then it
|
||||
calls ‘with-editor-process-filter’, passing t as
|
||||
or may not insert the text into the PROCESS's buffer. Then it
|
||||
calls ‘with-editor-process-filter’, passing ‘t’ as
|
||||
NO-STANDARD-FILTER.
|
||||
|
||||
|
||||
@@ -329,8 +331,6 @@ Appendix A Function and Command Index
|
||||
|
||||
* with-editor: Using With-Editor as a library.
|
||||
(line 16)
|
||||
* with-editor <1>: Using With-Editor as a library.
|
||||
(line 31)
|
||||
* with-editor-async-shell-command: Using With-Editor commands.
|
||||
(line 17)
|
||||
* with-editor-export-editor: Using With-Editor commands.
|
||||
@@ -345,6 +345,8 @@ Appendix A Function and Command Index
|
||||
(line 35)
|
||||
* with-editor-shell-command: Using With-Editor commands.
|
||||
(line 21)
|
||||
* with-editor*: Using With-Editor as a library.
|
||||
(line 31)
|
||||
|
||||
|
||||
File: with-editor.info, Node: Variable Index, Prev: Function and Command Index, Up: Top
|
||||
@@ -365,14 +367,14 @@ Appendix B Variable Index
|
||||
|
||||
|
||||
Tag Table:
|
||||
Node: Top773
|
||||
Node: Using the With-Editor package2563
|
||||
Node: Configuring With-Editor3149
|
||||
Node: Using With-Editor commands7698
|
||||
Node: Using With-Editor as a library10999
|
||||
Node: Debugging13024
|
||||
Node: Function and Command Index13916
|
||||
Node: Variable Index15414
|
||||
Node: Top801
|
||||
Node: Using the With-Editor package2611
|
||||
Node: Configuring With-Editor3196
|
||||
Node: Using With-Editor commands7751
|
||||
Node: Using With-Editor as a library11051
|
||||
Node: Debugging13079
|
||||
Node: Function and Command Index13971
|
||||
Node: Variable Index15469
|
||||
|
||||
End Tag Table
|
||||
|
||||
|
||||
Reference in New Issue
Block a user