diff options
| author | Adam Spiers <git@adamspiers.org> | 2013-04-11 16:05:13 +0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2013-04-11 22:11:36 +0400 |
| commit | f1ed7fea7974218db15155f3b8d2e29d3fe0971c (patch) | |
| tree | 6e84f63ddd4fb3a927d2ef2cc2829c0d566ac7b8 /Documentation/git-check-ignore.txt | |
| parent | 0c8e8c080b08632d6dbee33d093b5df648196b49 (diff) | |
Documentation: add caveats about I/O buffering for check-{attr,ignore}
check-attr and check-ignore have the potential to deadlock callers
which do not read back the output in real-time. For example, if a
caller writes N paths out and then reads N lines back in, it risks
becoming blocked on write() to check-*, and check-* is blocked on
write back to the caller. Somebody has to buffer; the pipe buffers
provide some leeway, but they are limited.
Thanks to Peff for pointing this out:
http://article.gmane.org/gmane.comp.version-control.git/220534
Signed-off-by: Adam Spiers <git@adamspiers.org>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-check-ignore.txt')
| -rw-r--r-- | Documentation/git-check-ignore.txt | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt index 7e3cabc9dd..8e1f7ab7ea 100644 --- a/Documentation/git-check-ignore.txt +++ b/Documentation/git-check-ignore.txt @@ -81,6 +81,11 @@ not. (Without this option, it would be impossible to tell whether the absence of output for a given file meant that it didn't match any pattern, or that the output hadn't been generated yet.) +Buffering happens as documented under the `GIT_FLUSH` option in +linkgit:git[1]. The caller is responsible for avoiding deadlocks +caused by overfilling an input buffer or reading from an empty output +buffer. + EXIT STATUS ----------- |