mingw: document the standard handle redirection
This feature has been in Git for Windows since v2.11.0(2), as an experimental option. Now it is considered mature, and it is high time to document it properly. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Johannes Schindelin committed
Nov 1, 2017 at 18:10 UTC
b2f55717c7f9b335b7ac2e3358b0498116b94a5d
1 file changed
+18
Documentation/git.txt
+18
@@ -709,6 +709,24 @@ of clones and fetches.
709
the background which do not want to cause lock contention with
710
other operations on the repository. Defaults to `1`.
711
712
+`GIT_REDIRECT_STDIN`::
713
+`GIT_REDIRECT_STDOUT`::
714
+`GIT_REDIRECT_STDERR`::
715
+ Windows-only: allow redirecting the standard input/output/error
716
+ handles to paths specified by the environment variables. This is
717
+ particularly useful in multi-threaded applications where the
718
+ canonical way to pass standard handles via `CreateProcess()` is
719
+ not an option because it would require the handles to be marked
720
+ inheritable (and consequently *every* spawned process would
721
+ inherit them, possibly blocking regular Git operations). The
722
+ primary intended use case is to use named pipes for communication
723
+ (e.g. `\\.\pipe\my-git-stdin-123`).
724
++
725
+Two special values are supported: `off` will simply close the
726
+corresponding standard handle, and if `GIT_REDIRECT_STDERR` is
727
+`2>&1`, standard error will be redirected to the same handle as
728
+standard output.
729
+
730
Discussion[[Discussion]]
731
------------------------
732