2007-07-14 23:14:45 +00:00
|
|
|
#include "builtin.h"
|
2006-09-15 20:30:02 +00:00
|
|
|
#include "cache.h"
|
2017-06-14 18:07:36 +00:00
|
|
|
#include "config.h"
|
2006-09-15 20:30:02 +00:00
|
|
|
#include "refs.h"
|
|
|
|
|
#include "object.h"
|
2007-10-13 18:40:46 +00:00
|
|
|
#include "parse-options.h"
|
2015-06-13 19:37:26 +00:00
|
|
|
#include "ref-filter.h"
|
2006-09-15 20:30:02 +00:00
|
|
|
|
2007-10-13 18:40:46 +00:00
|
|
|
static char const * const for_each_ref_usage[] = {
|
2015-01-13 07:44:47 +00:00
|
|
|
N_("git for-each-ref [<options>] [<pattern>]"),
|
2015-07-07 16:06:10 +00:00
|
|
|
N_("git for-each-ref [--points-at <object>]"),
|
2020-09-16 02:08:40 +00:00
|
|
|
N_("git for-each-ref [--merged [<commit>]] [--no-merged [<commit>]]"),
|
ref-filter: add --no-contains option to tag/branch/for-each-ref
Change the tag, branch & for-each-ref commands to have a --no-contains
option in addition to their longstanding --contains options.
This allows for finding the last-good rollout tag given a known-bad
<commit>. Given a hypothetically bad commit cf5c7253e0, the git
version to revert to can be found with this hacky two-liner:
(git tag -l 'v[0-9]*'; git tag -l --contains cf5c7253e0 'v[0-9]*') |
sort | uniq -c | grep -E '^ *1 ' | awk '{print $2}' | tail -n 10
With this new --no-contains option the same can be achieved with:
git tag -l --no-contains cf5c7253e0 'v[0-9]*' | sort | tail -n 10
As the filtering machinery is shared between the tag, branch &
for-each-ref commands, implement this for those commands too. A
practical use for this with "branch" is e.g. finding branches which
were branched off between v2.8.0 and v2.10.0:
git branch --contains v2.8.0 --no-contains v2.10.0
The "describe" command also has a --contains option, but its semantics
are unrelated to what tag/branch/for-each-ref use --contains for. A
--no-contains option for "describe" wouldn't make any sense, other
than being exactly equivalent to not supplying --contains at all,
which would be confusing at best.
Add a --without option to "tag" as an alias for --no-contains, for
consistency with --with and --contains. The --with option is
undocumented, and possibly the only user of it is
Junio (<xmqqefy71iej.fsf@gitster.mtv.corp.google.com>). But it's
trivial to support, so let's do that.
The additions to the the test suite are inverse copies of the
corresponding --contains tests. With this change --no-contains for
tag, branch & for-each-ref is just as well tested as the existing
--contains option.
In addition to those tests, add a test for "tag" which asserts that
--no-contains won't find tree/blob tags, which is slightly
unintuitive, but consistent with how --contains works & is documented.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-24 18:40:57 +00:00
|
|
|
N_("git for-each-ref [--contains [<commit>]] [--no-contains [<commit>]]"),
|
2007-10-13 18:40:46 +00:00
|
|
|
NULL
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
|
2006-09-15 20:30:02 +00:00
|
|
|
{
|
2015-06-13 19:37:22 +00:00
|
|
|
int i;
|
for-each-ref: delay parsing of --sort=<atom> options
The for-each-ref family of commands invoke parsers immediately when
it sees each --sort=<atom> option, and die before even seeing the
other options on the command line when the <atom> is unrecognised.
Instead, accumulate them in a string list, and have them parsed into
a ref_sorting structure after the command line parsing is done. As
a consequence, "git branch --sort=bogus -h" used to fail to give the
brief help, which arguably may have been a feature, now does so,
which is more consistent with how other options work.
The patch is smaller than the actual extent of the "damage" to the
codebase, thanks to the fact that the original code consistently
used OPT_REF_SORT() macro to handle command line options. We only
needed to replace the variable used for the list, and implementation
of the callback function used in the macro.
The old rule was for the users of the API to:
- Declare ref_sorting and ref_sorting_tail variables;
- OPT_REF_SORT() macro will instantiate ref_sorting instance (which
may barf and die) and append it to the tail;
- Append to the tail each ref_sorting read from the configuration
by parsing in the config callback (which may barf and die);
- See if ref_sorting is null and use ref_sorting_default() instead.
Now the rule is not all that different but is simpler:
- Declare ref_sorting_options string list.
- OPT_REF_SORT() macro will append it to the string list;
- Append to the string list the sort key read from the
configuration;
- call ref_sorting_options() to turn the string list to ref_sorting
structure (which also deals with the default value).
As side effects, this change also cleans up a few issues:
- 95be717c (parse_opt_ref_sorting: always use with NONEG flag,
2019-03-20) muses that "git for-each-ref --no-sort" should simply
clear the sort keys accumulated so far; it now does.
- The implementation detail of "struct ref_sorting" and the helper
function parse_ref_sorting() can now be private to the ref-filter
API implementation.
- If you set branch.sort to a bogus value, the any "git branch"
invocation, not only the listing mode, would abort with the
original code; now it doesn't
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-10-20 19:23:53 +00:00
|
|
|
struct ref_sorting *sorting;
|
|
|
|
|
struct string_list sorting_options = STRING_LIST_INIT_DUP;
|
2017-07-13 15:01:18 +00:00
|
|
|
int maxcount = 0, icase = 0;
|
2015-06-13 19:37:28 +00:00
|
|
|
struct ref_array array;
|
|
|
|
|
struct ref_filter filter;
|
2017-07-13 15:01:18 +00:00
|
|
|
struct ref_format format = REF_FORMAT_INIT;
|
2021-04-20 16:52:11 +00:00
|
|
|
struct strbuf output = STRBUF_INIT;
|
|
|
|
|
struct strbuf err = STRBUF_INIT;
|
2006-09-15 20:30:02 +00:00
|
|
|
|
2007-10-13 18:40:46 +00:00
|
|
|
struct option opts[] = {
|
2017-07-13 15:01:18 +00:00
|
|
|
OPT_BIT('s', "shell", &format.quote_style,
|
2012-08-20 12:32:11 +00:00
|
|
|
N_("quote placeholders suitably for shells"), QUOTE_SHELL),
|
2017-07-13 15:01:18 +00:00
|
|
|
OPT_BIT('p', "perl", &format.quote_style,
|
2012-08-20 12:32:11 +00:00
|
|
|
N_("quote placeholders suitably for perl"), QUOTE_PERL),
|
2017-07-13 15:01:18 +00:00
|
|
|
OPT_BIT(0 , "python", &format.quote_style,
|
2012-08-20 12:32:11 +00:00
|
|
|
N_("quote placeholders suitably for python"), QUOTE_PYTHON),
|
2017-07-13 15:01:18 +00:00
|
|
|
OPT_BIT(0 , "tcl", &format.quote_style,
|
2014-11-28 18:00:11 +00:00
|
|
|
N_("quote placeholders suitably for Tcl"), QUOTE_TCL),
|
2007-10-13 18:40:46 +00:00
|
|
|
|
|
|
|
|
OPT_GROUP(""),
|
2012-08-20 12:32:11 +00:00
|
|
|
OPT_INTEGER( 0 , "count", &maxcount, N_("show only <n> matched refs")),
|
2017-07-13 15:01:18 +00:00
|
|
|
OPT_STRING( 0 , "format", &format.format, N_("format"), N_("format to use for the output")),
|
2017-10-03 13:45:47 +00:00
|
|
|
OPT__COLOR(&format.use_color, N_("respect format colors")),
|
for-each-ref: delay parsing of --sort=<atom> options
The for-each-ref family of commands invoke parsers immediately when
it sees each --sort=<atom> option, and die before even seeing the
other options on the command line when the <atom> is unrecognised.
Instead, accumulate them in a string list, and have them parsed into
a ref_sorting structure after the command line parsing is done. As
a consequence, "git branch --sort=bogus -h" used to fail to give the
brief help, which arguably may have been a feature, now does so,
which is more consistent with how other options work.
The patch is smaller than the actual extent of the "damage" to the
codebase, thanks to the fact that the original code consistently
used OPT_REF_SORT() macro to handle command line options. We only
needed to replace the variable used for the list, and implementation
of the callback function used in the macro.
The old rule was for the users of the API to:
- Declare ref_sorting and ref_sorting_tail variables;
- OPT_REF_SORT() macro will instantiate ref_sorting instance (which
may barf and die) and append it to the tail;
- Append to the tail each ref_sorting read from the configuration
by parsing in the config callback (which may barf and die);
- See if ref_sorting is null and use ref_sorting_default() instead.
Now the rule is not all that different but is simpler:
- Declare ref_sorting_options string list.
- OPT_REF_SORT() macro will append it to the string list;
- Append to the string list the sort key read from the
configuration;
- call ref_sorting_options() to turn the string list to ref_sorting
structure (which also deals with the default value).
As side effects, this change also cleans up a few issues:
- 95be717c (parse_opt_ref_sorting: always use with NONEG flag,
2019-03-20) muses that "git for-each-ref --no-sort" should simply
clear the sort keys accumulated so far; it now does.
- The implementation detail of "struct ref_sorting" and the helper
function parse_ref_sorting() can now be private to the ref-filter
API implementation.
- If you set branch.sort to a bogus value, the any "git branch"
invocation, not only the listing mode, would abort with the
original code; now it doesn't
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-10-20 19:23:53 +00:00
|
|
|
OPT_REF_SORT(&sorting_options),
|
2015-07-07 16:06:10 +00:00
|
|
|
OPT_CALLBACK(0, "points-at", &filter.points_at,
|
|
|
|
|
N_("object"), N_("print only refs which points at the given object"),
|
|
|
|
|
parse_opt_object_name),
|
2015-07-07 16:06:13 +00:00
|
|
|
OPT_MERGED(&filter, N_("print only refs that are merged")),
|
|
|
|
|
OPT_NO_MERGED(&filter, N_("print only refs that are not merged")),
|
2015-07-07 16:06:17 +00:00
|
|
|
OPT_CONTAINS(&filter.with_commit, N_("print only refs which contain the commit")),
|
ref-filter: add --no-contains option to tag/branch/for-each-ref
Change the tag, branch & for-each-ref commands to have a --no-contains
option in addition to their longstanding --contains options.
This allows for finding the last-good rollout tag given a known-bad
<commit>. Given a hypothetically bad commit cf5c7253e0, the git
version to revert to can be found with this hacky two-liner:
(git tag -l 'v[0-9]*'; git tag -l --contains cf5c7253e0 'v[0-9]*') |
sort | uniq -c | grep -E '^ *1 ' | awk '{print $2}' | tail -n 10
With this new --no-contains option the same can be achieved with:
git tag -l --no-contains cf5c7253e0 'v[0-9]*' | sort | tail -n 10
As the filtering machinery is shared between the tag, branch &
for-each-ref commands, implement this for those commands too. A
practical use for this with "branch" is e.g. finding branches which
were branched off between v2.8.0 and v2.10.0:
git branch --contains v2.8.0 --no-contains v2.10.0
The "describe" command also has a --contains option, but its semantics
are unrelated to what tag/branch/for-each-ref use --contains for. A
--no-contains option for "describe" wouldn't make any sense, other
than being exactly equivalent to not supplying --contains at all,
which would be confusing at best.
Add a --without option to "tag" as an alias for --no-contains, for
consistency with --with and --contains. The --with option is
undocumented, and possibly the only user of it is
Junio (<xmqqefy71iej.fsf@gitster.mtv.corp.google.com>). But it's
trivial to support, so let's do that.
The additions to the the test suite are inverse copies of the
corresponding --contains tests. With this change --no-contains for
tag, branch & for-each-ref is just as well tested as the existing
--contains option.
In addition to those tests, add a test for "tag" which asserts that
--no-contains won't find tree/blob tags, which is slightly
unintuitive, but consistent with how --contains works & is documented.
Signed-off-by: Ævar Arnfjörð Bjarmason <avarab@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2017-03-24 18:40:57 +00:00
|
|
|
OPT_NO_CONTAINS(&filter.no_commit, N_("print only refs which don't contain the commit")),
|
2016-12-04 02:52:25 +00:00
|
|
|
OPT_BOOL(0, "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
|
2007-10-13 18:40:46 +00:00
|
|
|
OPT_END(),
|
|
|
|
|
};
|
|
|
|
|
|
2015-07-07 16:06:10 +00:00
|
|
|
memset(&array, 0, sizeof(array));
|
|
|
|
|
memset(&filter, 0, sizeof(filter));
|
|
|
|
|
|
2017-07-13 15:01:18 +00:00
|
|
|
format.format = "%(objectname) %(objecttype)\t%(refname)";
|
|
|
|
|
|
2017-07-13 15:07:14 +00:00
|
|
|
git_config(git_default_config, NULL);
|
|
|
|
|
|
2009-05-23 18:53:12 +00:00
|
|
|
parse_options(argc, argv, prefix, opts, for_each_ref_usage, 0);
|
2007-10-13 18:40:46 +00:00
|
|
|
if (maxcount < 0) {
|
|
|
|
|
error("invalid --count argument: `%d'", maxcount);
|
|
|
|
|
usage_with_options(for_each_ref_usage, opts);
|
2006-09-15 20:30:02 +00:00
|
|
|
}
|
2017-07-13 15:01:18 +00:00
|
|
|
if (HAS_MULTI_BITS(format.quote_style)) {
|
2007-12-06 12:24:39 +00:00
|
|
|
error("more than one quoting style?");
|
2007-10-13 18:40:46 +00:00
|
|
|
usage_with_options(for_each_ref_usage, opts);
|
|
|
|
|
}
|
2017-07-13 15:01:18 +00:00
|
|
|
if (verify_ref_format(&format))
|
2007-10-13 18:40:46 +00:00
|
|
|
usage_with_options(for_each_ref_usage, opts);
|
2006-09-15 20:30:02 +00:00
|
|
|
|
for-each-ref: delay parsing of --sort=<atom> options
The for-each-ref family of commands invoke parsers immediately when
it sees each --sort=<atom> option, and die before even seeing the
other options on the command line when the <atom> is unrecognised.
Instead, accumulate them in a string list, and have them parsed into
a ref_sorting structure after the command line parsing is done. As
a consequence, "git branch --sort=bogus -h" used to fail to give the
brief help, which arguably may have been a feature, now does so,
which is more consistent with how other options work.
The patch is smaller than the actual extent of the "damage" to the
codebase, thanks to the fact that the original code consistently
used OPT_REF_SORT() macro to handle command line options. We only
needed to replace the variable used for the list, and implementation
of the callback function used in the macro.
The old rule was for the users of the API to:
- Declare ref_sorting and ref_sorting_tail variables;
- OPT_REF_SORT() macro will instantiate ref_sorting instance (which
may barf and die) and append it to the tail;
- Append to the tail each ref_sorting read from the configuration
by parsing in the config callback (which may barf and die);
- See if ref_sorting is null and use ref_sorting_default() instead.
Now the rule is not all that different but is simpler:
- Declare ref_sorting_options string list.
- OPT_REF_SORT() macro will append it to the string list;
- Append to the string list the sort key read from the
configuration;
- call ref_sorting_options() to turn the string list to ref_sorting
structure (which also deals with the default value).
As side effects, this change also cleans up a few issues:
- 95be717c (parse_opt_ref_sorting: always use with NONEG flag,
2019-03-20) muses that "git for-each-ref --no-sort" should simply
clear the sort keys accumulated so far; it now does.
- The implementation detail of "struct ref_sorting" and the helper
function parse_ref_sorting() can now be private to the ref-filter
API implementation.
- If you set branch.sort to a bogus value, the any "git branch"
invocation, not only the listing mode, would abort with the
original code; now it doesn't
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-10-20 19:23:53 +00:00
|
|
|
sorting = ref_sorting_options(&sorting_options);
|
2021-01-07 09:51:51 +00:00
|
|
|
ref_sorting_set_sort_flags_all(sorting, REF_SORTING_ICASE, icase);
|
2016-12-04 02:52:25 +00:00
|
|
|
filter.ignore_case = icase;
|
2006-09-15 20:30:02 +00:00
|
|
|
|
2015-06-13 19:37:28 +00:00
|
|
|
filter.name_patterns = argv;
|
2015-09-10 15:48:26 +00:00
|
|
|
filter.match_as_path = 1;
|
ref-filter: stop setting FILTER_REFS_INCLUDE_BROKEN
Of the ref-filter callers, for-each-ref and git-branch both set the
INCLUDE_BROKEN flag (but git-tag does not, which is a weird
inconsistency). But now that GIT_REF_PARANOIA is on by default, that
produces almost the same outcome for all three.
The one exception is that GIT_REF_PARANOIA will omit dangling symrefs.
That's a better behavior for these tools, as they would never include
such a symref in the main output anyway (they can't, as it doesn't point
to an object). Instead they issue a warning to stderr. But that warning
is somewhat useless; a dangling symref is a perfectly reasonable thing
to have in your repository, and is not a sign of corruption. It's much
friendlier to just quietly ignore it.
And in terms of robustness, the warning gains us little. It does not
impact the exit code of either tool. So while the warning _might_ clue
in a user that they have an unexpected broken symref, it would not help
any kind of scripted use.
This patch converts for-each-ref and git-branch to stop using the
INCLUDE_BROKEN flag. That gives them more reasonable behavior, and
harmonizes them with git-tag.
We have to change one test to adapt to the situation. t1430 tries to
trigger all of the REF_ISBROKEN behaviors from the underlying ref code.
It uses for-each-ref to do so (because there isn't any other mechanism).
That will no longer issue a warning about the symref which points to an
invalid name, as it's considered dangling (and we can instead be sure
that it's _not_ mentioned on stderr). Note that we do still complain
about the illegally named "broken..symref"; its problem is not that it's
dangling, but the name of the symref itself is illegal.
Signed-off-by: Jeff King <peff@peff.net>
Reviewed-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2021-09-24 18:48:05 +00:00
|
|
|
filter_refs(&array, &filter, FILTER_REFS_ALL);
|
2015-06-13 19:37:28 +00:00
|
|
|
ref_array_sort(sorting, &array);
|
2006-09-15 20:30:02 +00:00
|
|
|
|
2015-06-13 19:37:28 +00:00
|
|
|
if (!maxcount || array.nr < maxcount)
|
|
|
|
|
maxcount = array.nr;
|
2021-04-19 11:28:44 +00:00
|
|
|
for (i = 0; i < maxcount; i++) {
|
2021-04-20 16:52:11 +00:00
|
|
|
strbuf_reset(&err);
|
|
|
|
|
strbuf_reset(&output);
|
2021-04-19 11:28:44 +00:00
|
|
|
if (format_ref_array_item(array.items[i], &format, &output, &err))
|
|
|
|
|
die("%s", err.buf);
|
|
|
|
|
fwrite(output.buf, 1, output.len, stdout);
|
|
|
|
|
putchar('\n');
|
|
|
|
|
}
|
2021-04-20 16:52:11 +00:00
|
|
|
|
|
|
|
|
strbuf_release(&err);
|
|
|
|
|
strbuf_release(&output);
|
2015-06-13 19:37:28 +00:00
|
|
|
ref_array_clear(&array);
|
2021-04-25 14:16:17 +00:00
|
|
|
free_commit_list(filter.with_commit);
|
|
|
|
|
free_commit_list(filter.no_commit);
|
2021-10-20 18:27:20 +00:00
|
|
|
ref_sorting_release(sorting);
|
2006-09-15 20:30:02 +00:00
|
|
|
return 0;
|
|
|
|
|
}
|