Re: [PATCH v2 5/5] Documentation: add caveats about I/O buffering for check-{attr,ignore}
- From
Junio C Hamano <gitster@pobox.com>
- Date
- Apr 11, 2013, 18:09 UTC
- Message-ID
- <7vsj2xhrc7.fsf@alter.siamese.dyndns.org>
- In-Reply-To
- <1365681913-7059-5-git-send-email-git@adamspiers.org>
Adam Spiers <git@adamspiers.org> writes:
Show 40 quoted lines
> diff --git a/Documentation/git-check-ignore.txt b/Documentation/git-check-ignore.txt > index 7e3cabc..8e1f7ab 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 > ----------- > > diff --git a/Documentation/git.txt b/Documentation/git.txt > index 6a875f2..eecdb15 100644 > --- a/Documentation/git.txt > +++ b/Documentation/git.txt > @@ -808,13 +808,15 @@ for further details. > > 'GIT_FLUSH':: > If this environment variable is set to "1", then commands such > - as 'git blame' (in incremental mode), 'git rev-list', 'git log', > - and 'git whatchanged' will force a flush of the output stream > - after each commit-oriented record have been flushed. If this > - variable is set to "0", the output of these commands will be done > - using completely buffered I/O. If this environment variable is > - not set, Git will choose buffered or record-oriented flushing > - based on whether stdout appears to be redirected to a file or not. > + as 'git blame' (in incremental mode), 'git rev-list', 'git > + log', 'git check-attr', 'git check-ignore', and 'git > + whatchanged' will force a flush of the output stream after > + each commit-oriented record have been flushed. If this > + variable is set to "0", the output of these commands will be > + done using completely buffered I/O. If this environment > + variable is not set, Git will choose buffered or > + record-oriented flushing based on whether stdout appears to be > + redirected to a file or not.
Reflowing of the text is very much unappreciated X-<.
It took me five minutes to spot that you only added check-attr and check-ignore and forgot to adjust that "commit-oriented record" to an updated reality, where you now have commands that produce non-commit-oriented record to the output.
It would have been far simpler to review if it were like this, don't you think?
Show 11 quoted lines
> If this environment variable is set to "1", then commands such > as 'git blame' (in incremental mode), 'git rev-list', 'git log', > - and 'git whatchanged' will force a flush of the output stream > - after each commit-oriented record have been flushed. If this > + 'git check-attr', 'git check-ignore', and 'git whatchanged' will > + force a flush of the output stream > + after each record have been flushed. If this > variable is set to "0", the output of these commands will be done > using completely buffered I/O. If this environment variable is > not set, Git will choose buffered or record-oriented flushing > based on whether stdout appears to be redirected to a file or not.