git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael J Gruber <git@drmicha.warpmail.net>
To: Stephen Boyd <bebarino@gmail.com>
Cc: git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>
Subject: Re: [PATCH 1/3] git-am.txt: add an 'a', say what 'it' is, simplify a sentence
Date: Mon, 04 May 2009 13:43:25 +0200	[thread overview]
Message-ID: <49FED4DD.3090103@drmicha.warpmail.net> (raw)
In-Reply-To: <1241419618-20304-2-git-send-email-bebarino@gmail.com>

Stephen Boyd venit, vidit, dixit 04.05.2009 08:46:
> It's nice to know that 'it' is git-am or the subject line. Whitespace
> implies characters so just remove characters.
> 
> Signed-off-by: Stephen Boyd <bebarino@gmail.com>
> ---
>  Documentation/git-am.txt |   12 ++++++------
>  1 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/git-am.txt b/Documentation/git-am.txt
> index 1e71dd5..715531b 100644
> --- a/Documentation/git-am.txt
> +++ b/Documentation/git-am.txt
> @@ -32,7 +32,7 @@ OPTIONS
>  
>  -s::
>  --signoff::
> -	Add `Signed-off-by:` line to the commit message, using
> +	Add a `Signed-off-by:` line to the commit message, using
>  	the committer identity of yourself.
>  
>  -k::
> @@ -118,8 +118,8 @@ The commit author name is taken from the "From: " line of the
>  message, and commit author time is taken from the "Date: " line
>  of the message.  The "Subject: " line is used as the title of
>  the commit, after stripping common prefix "[PATCH <anything>]".
> -It is supposed to describe what the commit is about concisely as
> -a one line text.
> +The "Subject: " line is supposed to concisely describe what the
> +commit is about in one line of text.
>  
>  The body of the message (the rest of the message after the blank line
>  that terminates the RFC2822 headers) can begin with "Subject: " and
> @@ -128,8 +128,8 @@ to override the values of these fields.
>  
>  The commit message is formed by the title taken from the
>  "Subject: ", a blank line and the body of the message up to
> -where the patch begins.  Excess whitespace characters at the end of the
> -lines are automatically stripped.
> +where the patch begins.  Excess whitespace at the end of each
> +line is automatically stripped.
>  
>  The patch is expected to be inline, directly following the
>  message.  Any line that is of the form:
> @@ -141,7 +141,7 @@ message.  Any line that is of the form:
>  is taken as the beginning of a patch, and the commit log message
>  is terminated before the first occurrence of such a line.
>  
> -When initially invoking it, you give it the names of the mailboxes
> +When initially invoking 'git-am', you give it the names of the mailboxes

We try to spell git commands in the form 'git am' these days. Also, `git
am` should be the quoting for commands, although we don't have a style
guide and things are not consistent anyways.

>  to process.  Upon seeing the first patch that does not apply, it
>  aborts in the middle.  You can recover from this in one of two ways:
>  

      parent reply	other threads:[~2009-05-04 11:43 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2009-05-04  6:46 [PATCH 0/3] git-am documentation Stephen Boyd
2009-05-04  6:46 ` [PATCH 1/3] git-am.txt: add an 'a', say what 'it' is, simplify a sentence Stephen Boyd
2009-05-04  6:46   ` [PATCH 2/3] git-am.txt: Use date instead of time or timestamp Stephen Boyd
2009-05-04  6:46     ` [PATCH 3/3] git-am.txt: reword extra headers in message body Stephen Boyd
2009-05-04  7:15     ` [PATCH 2/3] git-am.txt: Use date instead of time or timestamp Jeff King
2009-05-04  7:23       ` Junio C Hamano
2009-05-04  7:25         ` Jeff King
2009-05-04 11:43   ` Michael J Gruber [this message]

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=49FED4DD.3090103@drmicha.warpmail.net \
    --to=git@drmicha.warpmail.net \
    --cc=bebarino@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=gitster@pobox.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).