~ubuntu-branches/ubuntu/intrepid/git-core/intrepid-updates

« back to all changes in this revision

Viewing changes to Documentation/git-am.txt

  • Committer: Package Import Robot
  • Author(s): Gerrit Pape
  • Date: 2007-04-22 13:31:05 UTC
  • mto: This revision was merged to the branch mainline in revision 20.
  • Revision ID: package-import@ubuntu.com-20070422133105-xg8fnm18r2cxcbg1
Tags: upstream-1.5.1.2
ImportĀ upstreamĀ versionĀ 1.5.1.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
3
3
 
4
4
NAME
5
5
----
6
 
git-am - Apply a series of patches in a mailbox
 
6
git-am - Apply a series of patches from a mailbox
7
7
 
8
8
 
9
9
SYNOPSIS
10
10
--------
11
11
[verse]
12
 
'git-am' [--signoff] [--dotest=<dir>] [--utf8] [--binary] [--3way]
13
 
         [--interactive] [--whitespace=<option>] <mbox>...
 
12
'git-am' [--signoff] [--dotest=<dir>] [--utf8 | --no-utf8] [--binary] [--3way]
 
13
         [--interactive] [--whitespace=<option>] [-C<n>] [-p<n>]
 
14
         <mbox>...
14
15
'git-am' [--skip | --resolved]
15
16
 
16
17
DESCRIPTION
21
22
 
22
23
OPTIONS
23
24
-------
24
 
--signoff::
 
25
<mbox>...::
 
26
        The list of mailbox files to read patches from. If you do not
 
27
        supply this argument, reads from the standard input.
 
28
 
 
29
-s, --signoff::
25
30
        Add `Signed-off-by:` line to the commit message, using
26
31
        the committer identity of yourself.
27
32
 
28
 
--dotest=<dir>::
 
33
-d=<dir>, --dotest=<dir>::
29
34
        Instead of `.dotest` directory, use <dir> as a working
30
35
        area to store extracted patches.
31
36
 
32
 
--utf8, --keep::
33
 
        Pass `-u` and `-k` flags to `git-mailinfo` (see
 
37
-k, --keep::
 
38
        Pass `-k` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
 
39
 
 
40
-u, --utf8::
 
41
        Pass `-u` flag to `git-mailinfo` (see gitlink:git-mailinfo[1]).
 
42
        The proposed commit log message taken from the e-mail
 
43
        are re-coded into UTF-8 encoding (configuration variable
 
44
        `i18n.commitencoding` can be used to specify project's
 
45
        preferred encoding if it is not UTF-8).
 
46
+
 
47
This was optional in prior versions of git, but now it is the
 
48
default.   You could use `--no-utf8` to override this.
 
49
 
 
50
--no-utf8::
 
51
        Pass `-n` flag to `git-mailinfo` (see
34
52
        gitlink:git-mailinfo[1]).
35
53
 
36
 
--binary::
 
54
-b, --binary::
37
55
        Pass `--allow-binary-replacement` flag to `git-apply`
38
56
        (see gitlink:git-apply[1]).
39
57
 
40
 
--3way::
 
58
-3, --3way::
41
59
        When the patch does not apply cleanly, fall back on
42
60
        3-way merge, if the patch records the identity of blobs
43
61
        it is supposed to apply to, and we have those blobs
51
69
        This flag is passed to the `git-apply` program that applies
52
70
        the patch.
53
71
 
54
 
--interactive::
 
72
-C<n>, -p<n>::
 
73
        These flags are passed to the `git-apply` program that applies
 
74
        the patch.
 
75
 
 
76
-i, --interactive::
55
77
        Run interactively, just like git-applymbox.
56
78
 
57
 
--resolved::
 
79
-r, --resolved::
58
80
        After a patch failure (e.g. attempting to apply
59
81
        conflicting patch), the user has applied it by hand and
60
82
        the index file stores the result of the application.
62
84
        extracted from the e-mail message and the current index
63
85
        file, and continue.
64
86
 
 
87
--resolvemsg=<msg>::
 
88
        When a patch failure occurs, <msg> will be printed
 
89
        to the screen before exiting.  This overrides the
 
90
        standard message informing you to use `--resolved`
 
91
        or `--skip` to handle the failure.  This is solely
 
92
        for internal use between `git-rebase` and `git-am`.
 
93
 
65
94
DISCUSSION
66
95
----------
67
96
 
 
97
The commit author name is taken from the "From: " line of the
 
98
message, and commit author time is taken from the "Date: " line
 
99
of the message.  The "Subject: " line is used as the title of
 
100
the commit, after stripping common prefix "[PATCH <anything>]".
 
101
It is supposed to describe what the commit is about concisely as
 
102
a one line text.
 
103
 
 
104
The body of the message (iow, after a blank line that terminates
 
105
RFC2822 headers) can begin with "Subject: " and "From: " lines
 
106
that are different from those of the mail header, to override
 
107
the values of these fields.
 
108
 
 
109
The commit message is formed by the title taken from the
 
110
"Subject: ", a blank line and the body of the message up to
 
111
where the patch begins.  Excess whitespaces at the end of the
 
112
lines are automatically stripped.
 
113
 
 
114
The patch is expected to be inline, directly following the
 
115
message.  Any line that is of form:
 
116
 
 
117
* three-dashes and end-of-line, or
 
118
* a line that begins with "diff -", or
 
119
* a line that begins with "Index: "
 
120
 
 
121
is taken as the beginning of a patch, and the commit log message
 
122
is terminated before the first occurrence of such a line.
 
123
 
68
124
When initially invoking it, you give it names of the mailboxes
69
125
to crunch.  Upon seeing the first patch that does not apply, it
70
126
aborts in the middle, just like 'git-applymbox' does.  You can