Johannes Schindelin [off-list ref] writes:
On Sun, 30 Nov 2008, Nguyễn Thái Ngọc Duy wrote:
quoted
In "common" man pages there is luckily no "NAME" anywhere except at
beginning of documents. If there is another "NAME", sed could mis-select
it and lead to common-cmds.h corruption. So better nail it at beginning
of line, which would reduce corruption chance.
I have no idea why you put this into the sparse checkout patch series.
That is because a documentation that triggers the misfortune this patch
fixes is introduced in the series. I actually scratched head myself,
though, and come to think of it, I should have complained that this patch
should state that because it does not look like it has anything do with
the main topic of the series.
As it is, the patch series is _already_ hard to review (as it is large not
only in term of number of patches, but also individual patch size),
_especially_ given the fact that there is no clear, precise and short
description of why/how the sparse checkout is implemented.
Hmm, can you really tell the lack of such description without reading the
series, I have to wonder...
Hi,
On Mon, 1 Dec 2008, Junio C Hamano wrote:
Johannes Schindelin [off-list ref] writes:
quoted
As it is, the patch series is _already_ hard to review (as it is large
not only in term of number of patches, but also individual patch
size), _especially_ given the fact that there is no clear, precise and
short description of why/how the sparse checkout is implemented.
Hmm, can you really tell the lack of such description without reading
the series, I have to wonder...
Okay, I thought it was obvious, but here is a template for the BLURP of
the cover letter that would at least get me started:
-- snip --
A "sparse checkout" is an index/working directory pair where not all
files/directories of the HEAD commit are actually checked out in the
working directory. Instead, they are marked as "not being checked out" in
the index.
The real meat of this series is patch *** M/N *** which teaches Git to
understand the *** XYZ flag *** for index entries.
The following operations are affected by sparse checkout: *** X, Y, Z ***
These operations respect sparse checkouts by *** THIS, THIS AND THIS ***.
The first patch really should be independent, but patch *** M/N *** would
fail without it.
-- snap --
And of course, the whole BLURP should not consist of 10-20 line
paragraphs, but try to fit everything into 3-4 line paragraphs (I seem to
remember that there was a mail on this list saying than more than 4
lines/paragraph are too much for the average attention span...).
Ciao,
Dscho