diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt index d596be98a9..1c2edae3cf 100644 --- a/runtime/doc/options.txt +++ b/runtime/doc/options.txt @@ -5557,6 +5557,9 @@ A jump table for the options with a short description can be found at |Q_op|. Don't forget to precede the space with a backslash: ":set sp=\ ". In the future pipes may be used for filtering and this option will become obsolete (at least for Unix). + Note: When using a pipe like "| tee", you'll lose the exit code of the + shell command. This might be configurable by your shell, look for + the pipefail option (for bash and zsh, use ":set -o pipefail"). This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua index 727184c11a..c80201e6e3 100644 --- a/runtime/lua/vim/_meta/options.lua +++ b/runtime/lua/vim/_meta/options.lua @@ -5859,6 +5859,9 @@ vim.go.shcf = vim.go.shellcmdflag --- Don't forget to precede the space with a backslash: ":set sp=\ ". --- In the future pipes may be used for filtering and this option will --- become obsolete (at least for Unix). +--- Note: When using a pipe like "| tee", you'll lose the exit code of the +--- shell command. This might be configurable by your shell, look for +--- the pipefail option (for bash and zsh, use ":set -o pipefail"). --- This option cannot be set from a `modeline` or in the `sandbox`, for --- security reasons. --- diff --git a/src/nvim/options.lua b/src/nvim/options.lua index 7f506e482e..843bbcd7cc 100644 --- a/src/nvim/options.lua +++ b/src/nvim/options.lua @@ -7687,6 +7687,9 @@ local options = { Don't forget to precede the space with a backslash: ":set sp=\ ". In the future pipes may be used for filtering and this option will become obsolete (at least for Unix). + Note: When using a pipe like "| tee", you'll lose the exit code of the + shell command. This might be configurable by your shell, look for + the pipefail option (for bash and zsh, use ":set -o pipefail"). This option cannot be set from a |modeline| or in the |sandbox|, for security reasons. ]=],