fz0x1/jrnl
1
0
Fork 0
mirror of https://github.com/jrnl-org/jrnl.git synced 2025-05-10 08:38:32 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Document that editors must be blocking processes (#1624)

Browse source 
* Describe blocking processes in External Editors page
* Add documentation about how the editor must be a blocking process
* Add contextual link to external editor site
* Point to micro editor as an example since it's likely less intimidating than vim
This commit is contained in:
Micah Jerome Ellison 2022-10-29 12:14:28 -07:00 • committed by GitHub
parent c6479c70c1
commit 6f9a3eb536
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 8 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/external-editors.md
View file

@ -8,11 +8,13 @@ License: https://www.gnu.org/licenses/gpl-3.0.html
Configure your preferred external editor by updating the `editor` option
in your [configuration file](./reference-config-file.md#editor)
If your editor is not in your operating system's `PATH` environment variable,
then you will have to enter in the full path of your editor.
!!! note
To save and log any entry edits, save and close the file.
If your editor is not in your operating system's `PATH` environment variable,
then you will have to enter in the full path of your editor.
All editors must be [blocking processes](https://en.wikipedia.org/wiki/Blocking_(computing)) to work with jrnl. Some editors, such as [micro](https://micro-editor.github.io/), are blocking by default, though others can be made to block with additional arguments, such as many of those documented below. If jrnl opens your editor but finishes running immediately, then your editor is not a blocking process, and you may be able to correct that with one of the suggestions below.
## Sublime Text

7
docs/reference-config-file.md
View file

@ -47,10 +47,11 @@ key will be used instead.
If set, executes this command to launch an external editor for
writing and editing your entries. The path to a temporary file
is passed after it, and `jrnl` processes the file once
the editor is closed.
the editor returns control to `jrnl`.
Some editors require special options to work properly. See
[External Editors](external-editors.md) for details.
Some editors require special options to work properly, since they must be
blocking processes to work with `jrnl`. See [External Editors](external-editors.md)
for details.
### encrypt
If `true`, encrypts your journal using AES. Do not change this