diff options
| author | Justin M. Keyes <justinkz@gmail.com> | 2023-06-19 02:24:44 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-06-19 02:24:44 -0700 |
| commit | cee981bf09c81ab4b2fe6facf45076ea4bac46a5 (patch) | |
| tree | ccdf43826f362a560eadb6518a399f35b192dcd4 /runtime/doc/builtin.txt | |
| parent | 8c9dab3e0d788d44c8a2fee83a6193f5955c814e (diff) | |
| download | rneovim-cee981bf09c81ab4b2fe6facf45076ea4bac46a5.tar.gz rneovim-cee981bf09c81ab4b2fe6facf45076ea4bac46a5.tar.bz2 rneovim-cee981bf09c81ab4b2fe6facf45076ea4bac46a5.zip | |
docs #22363
Co-authored by: zeertzjq <zeertzjq@outlook.com>
Co-authored by: Steven Todd McIntyre II <114119064+stmii@users.noreply.github.com>
Co-authored by: nobe4 <nobe4@users.noreply.github.com>
- docs: mention --luadev-mod to run with lua runtime files
When changing a lua file in the ./runtime folder, a new contributor
might expect changes to be applied to the built Neovim binary.
Diffstat (limited to 'runtime/doc/builtin.txt')
| -rw-r--r-- | runtime/doc/builtin.txt | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 938523b6ee..d170240ef7 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -4542,6 +4542,8 @@ jobresize({job}, {width}, {height}) *jobresize()* Fails if the job was not started with `"pty":v:true`. jobstart({cmd} [, {opts}]) *jobstart()* + Note: Prefer |vim.system()| in Lua. + Spawns {cmd} as a job. If {cmd} is a List it runs directly (no 'shell'). If {cmd} is a String it runs in the 'shell', like this: > @@ -4597,11 +4599,9 @@ jobstart({cmd} [, {opts}]) *jobstart()* stdout data. |on_stderr|: (function) Callback invoked when the job emits stderr data. - overlapped: (boolean) Set FILE_FLAG_OVERLAPPED for the - standard input/output passed to the child process. - Normally you do not need to set this. - (Only available on MS-Windows, On other - platforms, this option is silently ignored.) + overlapped: (boolean) Sets FILE_FLAG_OVERLAPPED for the + stdio passed to the child process. Only on + MS-Windows; ignored on other platforms. pty: (boolean) Connect the job to a new pseudo terminal, and its streams to the master file descriptor. `on_stdout` receives all output, @@ -8665,6 +8665,8 @@ synstack({lnum}, {col}) *synstack()* valid positions. system({cmd} [, {input}]) *system()* *E677* + Note: Prefer |vim.system()| in Lua. + Gets the output of {cmd} as a |string| (|systemlist()| returns a |List|) and sets |v:shell_error| to the error code. {cmd} is treated as in |jobstart()|: |