diff options
| author | Stephen Boyd <bebarino@gmail.com> | 2009-05-04 22:18:42 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-05-05 22:08:58 -0700 |
| commit | 3db964b551827e25f897cc75ffd8e520ee8b48cd (patch) | |
| tree | 7a977ad5a258e811b0f9b16572a3b4693e7f8c39 /Documentation/git-am.txt | |
| parent | a48f5d7153761fabf0b04fdfd1667adf7eeeddbe (diff) | |
| download | git-3db964b551827e25f897cc75ffd8e520ee8b48cd.tar.gz | |
git-am.txt: add an 'a', say what 'it' is, simplify a sentence
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-am.txt')
| -rw-r--r-- | 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 1e71dd536b..a497010ae6 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 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: |