git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/8] generate-cmdlist.sh: avoid selecting synopsis at wrong place

From
Johannes Schindelin <johannes.schindelin@gmx.de>
Date
Dec 1, 2008, 15:39 UTC
Message-ID
<alpine.DEB.1.00.0812011546560.30769@pacific.mpi-cbg.de>
In-Reply-To
<7vtz9oq92i.fsf@gitster.siamese.dyndns.org>
Hi,
On Mon, 1 Dec 2008, Junio C Hamano wrote:
Show 9 quoted lines
> Johannes Schindelin <Johannes.Schindelin@gmx.de> writes:
> 
> > 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

Previous: Junio C Hamano
Message 13 of 13 in “Sparse checkout, the last half of the series”
  1. 0/8 Sparse checkout, the last half of the seriesNguyễn Thái Ngọc Duy, Nov 30, 2008
  2. 1/8 generate-cmdlist.sh: avoid selecting synopsis at wrong placeNguyễn Thái Ngọc Duy, Nov 30, 2008
  3. 2/8 Introduce "sparse patterns"Nguyễn Thái Ngọc Duy, Nov 30, 2008
  4. 3/8 unpack_trees(): keep track of unmerged entriesNguyễn Thái Ngọc Duy, Nov 30, 2008
  5. 4/8 unpack_trees(): add support for sparse checkoutNguyễn Thái Ngọc Duy, Nov 30, 2008
  6. 5/8 clone: support sparse checkout with --sparse-checkout optionNguyễn Thái Ngọc Duy, Nov 30, 2008
  7. 6/8 checkout: add new options to support sparse checkoutNguyễn Thái Ngọc Duy, Nov 30, 2008
  8. 7/8 Introduce default sparse patterns (core.defaultsparse)Nguyễn Thái Ngọc Duy, Nov 30, 2008
  9. 8/8 wt-status: show sparse checkout infoNguyễn Thái Ngọc Duy, Nov 30, 2008
  10. Johannes SchindelinDec 1, 2008
  11. Nguyen Thai Ngoc DuyDec 1, 2008
  12. Junio C HamanoDec 1, 2008
  13. Johannes SchindelinDec 1, 2008

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.