summaryrefslogtreecommitdiff
path: root/Documentation/git-check-attr.txt
diff options
context:
space:
mode:
authorAdam Spiers <git@adamspiers.org>2013-04-11 12:05:13 (GMT)
committerJunio C Hamano <gitster@pobox.com>2013-04-11 18:11:36 (GMT)
commitf1ed7fea7974218db15155f3b8d2e29d3fe0971c (patch)
tree6e84f63ddd4fb3a927d2ef2cc2829c0d566ac7b8 /Documentation/git-check-attr.txt
parent0c8e8c080b08632d6dbee33d093b5df648196b49 (diff)
downloadgit-f1ed7fea7974218db15155f3b8d2e29d3fe0971c.zip
git-f1ed7fea7974218db15155f3b8d2e29d3fe0971c.tar.gz
git-f1ed7fea7974218db15155f3b8d2e29d3fe0971c.tar.bz2
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-attr.txt')
-rw-r--r--Documentation/git-check-attr.txt5
1 files changed, 5 insertions, 0 deletions
diff --git a/Documentation/git-check-attr.txt b/Documentation/git-check-attr.txt
index 5abdbaa..a7be80d 100644
--- a/Documentation/git-check-attr.txt
+++ b/Documentation/git-check-attr.txt
@@ -56,6 +56,11 @@ being queried and <info> can be either:
'set';; when the attribute is defined as true.
<value>;; when a value has been assigned to the attribute.
+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.
+
EXAMPLES
--------