git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Nieder <jrnieder@gmail.com>
To: Brandon Casey <drafnel@gmail.com>
Cc: git@vger.kernel.org, Ralf Thielow <ralf.thielow@gmail.com>
Subject: Re: [PATCH 4/4] Documentation/git-commit.txt: correct a few minor grammatical mistakes
Date: Mon, 18 Feb 2013 22:43:04 -0800	[thread overview]
Message-ID: <20130219064304.GG19757@elie.Belkin> (raw)
In-Reply-To: <1361247427-438-4-git-send-email-drafnel@gmail.com>

Brandon Casey wrote:

> --- a/Documentation/git-commit.txt
> +++ b/Documentation/git-commit.txt
> @@ -174,10 +174,10 @@ OPTIONS
>  --cleanup=<mode>::
>  	This option sets how the commit message is cleaned up.
>  	The  '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
> -	and 'default'. The 'default' mode will strip leading and
> +	or 'default'. The 'default' mode will strip leading and
>  	trailing empty lines and #commentary from the commit message
> -	only if the message is to be edited. Otherwise only whitespace
> -	removed. The 'verbatim' mode does not change message at all,
> +	only if the message is to be edited. Otherwise only whitespace is
> +	removed. The 'verbatim' mode does not change the message at all,
>  	'whitespace' removes just leading/trailing whitespace lines
>  	and 'strip' removes both whitespace and commentary. The default
>  	can be changed by the 'commit.cleanup' configuration variable

Yeah, the current text is a bit choppy.  How about this?

Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>

--- i/Documentation/git-commit.txt
+++ w/Documentation/git-commit.txt
@@ -172,16 +172,25 @@ OPTIONS
        linkgit:git-commit-tree[1].
 
 --cleanup=<mode>::
-	This option sets how the commit message is cleaned up.
-	The  '<mode>' can be one of 'verbatim', 'whitespace', 'strip',
-	and 'default'. The 'default' mode will strip leading and
-	trailing empty lines and #commentary from the commit message
-	only if the message is to be edited. Otherwise only whitespace
-	removed. The 'verbatim' mode does not change message at all,
-	'whitespace' removes just leading/trailing whitespace lines
-	and 'strip' removes both whitespace and commentary. The default
-	can be changed by the 'commit.cleanup' configuration variable
-	(see linkgit:git-config[1]).
+	This option determines how the supplied commit message should be
+	cleaned up before committing. The '<mode>' can be `verbatim`,
+	`whitespace`, `strip`, or `default`.
++
+--
+default::
+	Strip leading and trailing empty lines and #commentary from
+	the commit message only if the message is to be edited.
+	Otherwise only remove whitespace.
+verbatim::
+	Do not change the message at all.
+whitespace::
+	Remove only leading and trailing whitespace lines.
+strip::
+	Remove both whitespace and commentary.
+--
++
+The default can be changed using the 'commit.cleanup' configuration
+variable (see linkgit:git-config[1]).
 
 -e::
 --edit::

  reply	other threads:[~2013-02-19  6:43 UTC|newest]

Thread overview: 19+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-02-19  4:17 [PATCH 1/4] t/t7502: compare entire commit message with what was expected Brandon Casey
2013-02-19  4:17 ` [PATCH 2/4] t7502: demonstrate breakage with a commit message with trailing newlines Brandon Casey
2013-02-19  5:39   ` Jonathan Nieder
2013-02-19  4:17 ` [PATCH 3/4] git-commit: only append a newline to -m mesg if necessary Brandon Casey
2013-02-19  6:31   ` Jonathan Nieder
2013-02-19  4:17 ` [PATCH 4/4] Documentation/git-commit.txt: correct a few minor grammatical mistakes Brandon Casey
2013-02-19  6:43   ` Jonathan Nieder [this message]
2013-02-19  7:18     ` Brandon Casey
2013-02-19  7:29       ` Jonathan Nieder
2013-02-19 17:33         ` Junio C Hamano
2013-02-19 18:14           ` [PATCH v2 4/4] Documentation/git-commit.txt: rework the --cleanup section Brandon Casey
2013-02-19 18:28           ` Brandon Casey
2013-02-19 18:29           ` Brandon Casey
2013-02-19 20:28             ` [PATCH] fixup! " Jonathan Nieder
2013-02-19 20:33               ` Brandon Casey
2013-02-19 20:35             ` [PATCH v2 4/4] " Junio C Hamano
2013-02-19  5:08 ` [PATCH 1/4] t/t7502: compare entire commit message with what was expected Jonathan Nieder
2013-02-19  5:10   ` Jonathan Nieder
2013-02-19 17:24   ` Junio C Hamano

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20130219064304.GG19757@elie.Belkin \
    --to=jrnieder@gmail.com \
    --cc=drafnel@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=ralf.thielow@gmail.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).