docs: job-control.txt => flow layout #38463

This commit is contained in:
Yochem van Rosmalen
2026-03-24 13:30:23 +01:00
committed by GitHub
parent 0af01948f3
commit 042c66e4f9
2 changed files with 15 additions and 15 deletions

View File

@@ -4,7 +4,7 @@
NVIM REFERENCE MANUAL by Thiago de Arruda
Nvim job control *job* *job-control*
Nvim job control *job* *job-control*
Job control is a way to perform multitasking in Nvim, so scripts can spawn and
control multiple processes without blocking the current Nvim instance.
@@ -14,7 +14,7 @@ control multiple processes without blocking the current Nvim instance.
==============================================================================
Concepts
Job Id *job-id*
Job Id *job-id*
Each job is identified by an integer id, unique for the life of the current
Nvim session. Each job-id is a valid |channel-id|: they share the same "key
@@ -25,7 +25,7 @@ Job stdio streams form a |channel| which can send and receive raw bytes or
|msgpack-rpc| messages.
==============================================================================
Usage *job-control-usage*
Usage *job-control-usage*
To control jobs, use the "job…" family of functions: |jobstart()|,
|jobstop()|, etc.
@@ -50,7 +50,7 @@ Example: >vim
\ }
let job1 = jobstart(['bash'], extend({'shell': 'shell 1'}, s:callbacks))
let job2 = jobstart(['bash', '-c', 'for i in {1..10}; do echo hello $i!; sleep 1; done'], extend({'shell': 'shell 2'}, s:callbacks))
<
To test the above script, copy it to a file ~/foo.vim and run it: >bash
nvim -u ~/foo.vim
<
@@ -64,10 +64,11 @@ Description of what happens:
events. It displays stdout/stderr data received from the shells.
For |on_stdout| and |on_stderr| see |channel-callback|.
*on_exit*
*on_exit*
Arguments passed to on_exit callback:
0: |job-id|
1: Exit-code of the process, or 128+SIGNUM if by signal (e.g. 143 on SIGTERM).
1: Exit-code of the process, or 128+SIGNUM if by signal (e.g. 143 on
SIGTERM).
2: Event type: "exit"
@@ -84,8 +85,7 @@ Arguments passed to on_exit callback:
\ {'on_stdout': 'Receive'})
< https://github.com/neovim/neovim/issues/1592
Note 2:
Job event handlers may receive partial (incomplete) lines. For a given
Note: Job event handlers may receive partial (incomplete) lines. For a given
invocation of on_stdout/on_stderr, `a:data` is not guaranteed to end
with a newline.
- `abcdefg` may arrive as `['abc']`, `['defg']`.
@@ -134,8 +134,7 @@ To send data to the job's stdin, use |chansend()|: >vim
:call chansend(job1, "invalid-command\n")
:call chansend(job1, "exit\n")
<
A job may be killed at any time with the |jobstop()| function:
>vim
A job may be killed at any time with the |jobstop()| function: >vim
:call jobstop(job1)
<
Individual streams can be closed without killing the job, see |chanclose()|.

View File

@@ -68,7 +68,6 @@ local M = {}
-- All other files are "legacy" files which require fixed-width layout.
local new_layout = {
['api.txt'] = true,
['lsp.txt'] = true,
['channel.txt'] = true,
['deprecated.txt'] = true,
['dev.txt'] = true,
@@ -79,20 +78,22 @@ local new_layout = {
['dev_tools.txt'] = true,
['dev_vimpatch.txt'] = true,
['diagnostic.txt'] = true,
['help.txt'] = true,
['faq.txt'] = true,
['gui.txt'] = true,
['help.txt'] = true,
['intro.txt'] = true,
['lua.txt'] = true,
['job_control.txt'] = true,
['lsp.txt'] = true,
['lua-bit.txt'] = true,
['lua-guide.txt'] = true,
['lua-plugin.txt'] = true,
['lua.txt'] = true,
['luaref.txt'] = true,
['news.txt'] = true,
['news-0.9.txt'] = true,
['news-0.10.txt'] = true,
['news-0.11.txt'] = true,
['news-0.12.txt'] = true,
['news-0.9.txt'] = true,
['news.txt'] = true,
['nvim.txt'] = true,
['pack.txt'] = true,
['provider.txt'] = true,