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

Re: [RFC][PATCH v3] git on Mac OS and precomposed unicode

From
Jonathan Nieder <jrnieder@gmail.com>
Date
Jan 13, 2012, 22:56 UTC
Message-ID
<20120113225559.GA7343@burratino>
In-Reply-To
<201201132253.00799.tboegi@web.de>
Hi,
tb wrote:
> Purpose:
[...]
> Runtime configuration:
[...]
> Implementation:
[...]
> Compile time configuration:
[...]
> Implementation details:
[....]
> Thread safety:
[...]
> Auto sensing:
[...]
> New test case:

This information, to the extent that it is useful at all, belongs in the commit log. That is, the commit message should concisely say everything a person would want to know when reading a patch, whether reading it to review it for inclusion, to make sure it still works when making a related change, to consider whether it is safe to upgrade to a version including the change, to understand what is happening when a bug is tracked down to be caused by that commit, or for some other reason.

So please do not use a cover letter that separates this information when sending a single patch.

> Changes since [...]

This kind of information that does not belong in the commit message can go after the "---" in the same message as the patch.

I haven't read the patch yet, except to glance at it and see some nitpicks I can mention later (e.g., source files should not #include anything else before git-compat-util.h or cache.h), and the approach seems likely to be sane; I'm mentioning this to help you present the information in a way that can save myself and other reviewers some trouble for the next round.

Thanks much for your work, and hope that helps.

Regards, Jonathan

Previous: tb
Message 2 of 2 in “git on Mac OS and precomposed unicode”
  1. tbJan 13, 2012
  2. Jonathan NiederJan 13, 2012

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.