push: document the status output
The output was meant to be a balance of self-explanatory and terse. In case we have erred too far on the terse side, it doesn't hurt to explain in more detail what each line means. Signed-off-by: Jeff King <peff@peff.net> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Jeff King committed
Feb 19, 2008 at 11:26 UTC
066a5268db8bff70ebd31d7887e060d1463fe57c
1 file changed
+49
Documentation/git-push.txt
+49
@@ -108,6 +108,55 @@ the remote repository.
108
109
include::urls-remotes.txt[]
110
111
+OUTPUT
112
+------
113
+
114
+The output of "git push" depends on the transport method used; this
115
+section describes the output when pushing over the git protocol (either
116
+locally or via ssh).
117
+
118
+The status of the push is output in tabular form, with each line
119
+representing the status of a single ref. Each line is of the form:
120
+
121
+-------------------------------
122
+ <flag> <summary> <from> -> <to> (<reason>)
123
+-------------------------------
124
+
125
+flag::
126
+ A single character indicating the status of the ref. This is
127
+ blank for a successfully pushed ref, `!` for a ref that was
128
+ rejected or failed to push, and '=' for a ref that was up to
129
+ date and did not need pushing (note that the status of up to
130
+ date refs is shown only when `git push` is running verbosely).
131
+
132
+summary::
133
+ For a successfully pushed ref, the summary shows the old and new
134
+ values of the ref in a form suitable for using as an argument to
135
+ `git log` (this is `<old>..<new>` in most cases, and
136
+ `<old>...<new>` for forced non-fast forward updates). For a
137
+ failed update, more details are given for the failure.
138
+ The string `rejected` indicates that git did not try to send the
139
+ ref at all (typically because it is not a fast forward). The
140
+ string `remote rejected` indicates that the remote end refused
141
+ the update; this rejection is typically caused by a hook on the
142
+ remote side. The string `remote failure` indicates that the
143
+ remote end did not report the successful update of the ref
144
+ (perhaps because of a temporary error on the remote side, a
145
+ break in the network connection, or other transient error).
146
+
147
+from::
148
+ The name of the local ref being pushed, minus its
149
+ `refs/<type>/` prefix. In the case of deletion, the
150
+ name of the local ref is omitted.
151
+
152
+to::
153
+ The name of the remote ref being updated, minus its
154
+ `refs/<type>/` prefix.
155
+
156
+reason::
157
+ A human-readable explanation. In the case of successfully pushed
158
+ refs, no explanation is needed. For a failed ref, the reason for
159
+ failure is described.
160
161
Examples
162
--------