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

Re: [PATCH] Clarify documentation on commit message strip

From
Junio C Hamano <gitster@pobox.com>
Date
Apr 25, 2015, 04:36 UTC
Message-ID
<xmqqmw1w259r.fsf@gitster.dls.corp.google.com>
In-Reply-To
<1429905998-9089-1-git-send-email-iveqy@iveqy.com>
Fredrik Gustafsson <iveqy@iveqy.com> writes:
Show 13 quoted lines
> diff --git a/Documentation/git-commit.txt b/Documentation/git-commit.txt
> index 617e29b..e31d828 100644
> --- a/Documentation/git-commit.txt
> +++ b/Documentation/git-commit.txt
> @@ -180,8 +180,9 @@ OPTIONS
>  +
>  --
>  strip::
> -	Strip leading and trailing empty lines, trailing whitespace, and
> -	#commentary and collapse consecutive empty lines.
> +	Strip leading and trailing empty lines, trailing whitespace,
> +	#commentary, unified diff added with `-v` and collapse
> +	consecutive empty lines.

I'd prefer the description not to be _too_ explicit e.g. by mentioning "unified diff", etc.

Personally I think it is sufficient to do s/#comment/comment/ to the existing text, without doing anything else. What is "commentary" to be removed is fairly clear in the contents given to the user in the editor.

Previous: Fredrik GustafssonNext: Fredrik Gustafsson
Message 2 of 5 in “Clarify documentation on commit message strip”
  1. Clarify documentation on commit message stripFredrik Gustafsson, Apr 24, 2015
  2. Junio C HamanoApr 25, 2015
  3. Clarify documentation on commit message stripFredrik Gustafsson, Apr 25, 2015
  4. Junio C HamanoApr 27, 2015
  5. Fredrik GustafssonApr 27, 2015

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.