@matheusbsbs / matheus-bagliano / commits / cc72385fe3

for-each-ref: let upstream/push optionally report the remote name

There are times when e.g. scripts want to know not only the name of the upstream branch on the remote repository, but also the name of the remote. This patch offers the new suffix :remotename for the upstream and for the push atoms, allowing to show exactly that. Example: $ cat .git/config ... [remote "origin"] url = https://where.do.we.come/from fetch = refs/heads/*:refs/remote/origin/* [remote "hello-world"] url = https://hello.world/git fetch = refs/heads/*:refs/remote/origin/* pushURL = hello.world:git push = refs/heads/*:refs/heads/* [branch "master"] remote = origin pushRemote = hello-world ... $ git for-each-ref \ --format='%(upstream) %(upstream:remotename) %(push:remotename)' \ refs/heads/master refs/remotes/origin/master origin hello-world The implementation chooses *not* to DWIM the push remote if no explicit push remote was configured; The reason is that it is possible to DWIM this by using %(if)%(push:remotename)%(then) %(push:remotename) %(else) %(upstream:remotename) %(end) while it would be impossible to "un-DWIM" the information in case the caller is really only interested in explicit push remotes. While `:remote` would be shorter, it would also be a bit more ambiguous, and it would also shut the door e.g. for `:remoteref` (which would obviously refer to the corresponding ref in the remote repository). Note: the dashless, non-CamelCased form `:remotename` follows the example of the `:trackshort` example. Signed-off-by: Johannes Schindelin <johannes.schindelin@gmx.de> Signed-off-by: Junio C Hamano <gitster@pobox.com>

Johannes Schindelin committed Oct 5, 2017 at 14:19 UTC cc72385fe350d4d7bc64f84e8817dbdfe27b04fe
2 files changed +38 -14
Documentation/git-for-each-ref.txt
+10 -7
@@ -140,17 +140,20 @@ upstream::
140 (behind), "<>" (ahead and behind), or "=" (in sync). `:track`
141 also prints "[gone]" whenever unknown upstream ref is
142 encountered. Append `:track,nobracket` to show tracking
143 - information without brackets (i.e "ahead N, behind M"). Has
144 - no effect if the ref does not have tracking information
145 - associated with it. All the options apart from `nobracket`
146 - are mutually exclusive, but if used together the last option
147 - is selected.
143 + information without brackets (i.e "ahead N, behind M").
144 ++
145 +Also respects `:remotename` to state the name of the *remote* instead of
146 +the ref.
147 ++
148 +Has no effect if the ref does not have tracking information associated
149 +with it. All the options apart from `nobracket` are mutually exclusive,
150 +but if used together the last option is selected.
151
152 push::
153 The name of a local ref which represents the `@{push}`
154 location for the displayed ref. Respects `:short`, `:lstrip`,
152 - `:rstrip`, `:track`, and `:trackshort` options as `upstream`
153 - does. Produces an empty string if no `@{push}` ref is
155 + `:rstrip`, `:track`, `:trackshort` and `:remotename` options as
156 + `upstream` does. Produces an empty string if no `@{push}` ref is
157 configured.
158
159 HEAD::
ref-filter.c
+28 -7
@@ -76,9 +76,11 @@ static struct used_atom {
76 char color[COLOR_MAXLEN];
77 struct align align;
78 struct {
79 - enum { RR_REF, RR_TRACK, RR_TRACKSHORT } option;
79 + enum {
80 + RR_REF, RR_TRACK, RR_TRACKSHORT, RR_REMOTE_NAME
81 + } option;
82 struct refname_atom refname;
81 - unsigned int nobracket : 1;
83 + unsigned int nobracket : 1, push : 1, push_remote : 1;
84 } remote_ref;
85 struct {
86 enum { C_BARE, C_BODY, C_BODY_DEP, C_LINES, C_SIG, C_SUB, C_TRAILERS } option;
@@ -137,6 +139,9 @@ static void remote_ref_atom_parser(const struct ref_format *format, struct used_
139 struct string_list params = STRING_LIST_INIT_DUP;
140 int i;
141
142 + if (!strcmp(atom->name, "push") || starts_with(atom->name, "push:"))
143 + atom->u.remote_ref.push = 1;
144 +
145 if (!arg) {
146 atom->u.remote_ref.option = RR_REF;
147 refname_atom_parser_internal(&atom->u.remote_ref.refname,
@@ -156,7 +161,10 @@ static void remote_ref_atom_parser(const struct ref_format *format, struct used_
161 atom->u.remote_ref.option = RR_TRACKSHORT;
162 else if (!strcmp(s, "nobracket"))
163 atom->u.remote_ref.nobracket = 1;
159 - else {
164 + else if (!strcmp(s, "remotename")) {
165 + atom->u.remote_ref.option = RR_REMOTE_NAME;
166 + atom->u.remote_ref.push_remote = 1;
167 + } else {
168 atom->u.remote_ref.option = RR_REF;
169 refname_atom_parser_internal(&atom->u.remote_ref.refname,
170 arg, atom->name);
@@ -1245,6 +1253,15 @@ static void fill_remote_ref_details(struct used_atom *atom, const char *refname,
1253 *s = ">";
1254 else
1255 *s = "<>";
1256 + } else if (atom->u.remote_ref.option == RR_REMOTE_NAME) {
1257 + int explicit;
1258 + const char *remote = atom->u.remote_ref.push ?
1259 + pushremote_for_branch(branch, &explicit) :
1260 + remote_for_branch(branch, &explicit);
1261 + if (explicit)
1262 + *s = xstrdup(remote);
1263 + else
1264 + *s = "";
1265 } else
1266 die("BUG: unhandled RR_* enum");
1267 }
@@ -1354,16 +1371,20 @@ static void populate_value(struct ref_array_item *ref)
1371 if (refname)
1372 fill_remote_ref_details(atom, refname, branch, &v->s);
1373 continue;
1357 - } else if (starts_with(name, "push")) {
1374 + } else if (atom->u.remote_ref.push) {
1375 const char *branch_name;
1376 if (!skip_prefix(ref->refname, "refs/heads/",
1377 &branch_name))
1378 continue;
1379 branch = branch_get(branch_name);
1380
1364 - refname = branch_get_push(branch, NULL);
1365 - if (!refname)
1366 - continue;
1381 + if (atom->u.remote_ref.push_remote)
1382 + refname = NULL;
1383 + else {
1384 + refname = branch_get_push(branch, NULL);
1385 + if (!refname)
1386 + continue;
1387 + }
1388 fill_remote_ref_details(atom, refname, branch, &v->s);
1389 continue;
1390 } else if (starts_with(name, "color:")) {