runtime(doc): mention the "pipefail" shell option
Commit:
https://github.com/vim/vim/commit/1f6faff9126dde38029bd5a1eed279c294b72dca
Author: Christian Brabandt <
c...@256bit.org>
Date: Sun Jul 20 17:32:51 2025 +0200
runtime(doc): mention the "pipefail" shell option
related:
https://github.com/vim/vim/issues/17787
Signed-off-by: Christian Brabandt <
c...@256bit.org>
diff --git a/runtime/doc/options.txt b/runtime/doc/options.txt
index bc8aea013..d4bdc8196 100644
--- a/runtime/doc/options.txt
+++ b/runtime/doc/options.txt
@@ -7503,6 +7503,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.