Documentation/user-manual: update outdated example output
[git.git] / builtin / for-each-ref.c
blob52be99cbacdd84f60e5b9f2efd1f1d50f602cdb8
1 #include "builtin.h"
2 #include "cache.h"
3 #include "config.h"
4 #include "refs.h"
5 #include "object.h"
6 #include "parse-options.h"
7 #include "ref-filter.h"
9 static char const * const for_each_ref_usage[] = {
10 N_("git for-each-ref [<options>] [<pattern>]"),
11 N_("git for-each-ref [--points-at <object>]"),
12 N_("git for-each-ref [(--merged | --no-merged) [<commit>]]"),
13 N_("git for-each-ref [--contains [<commit>]] [--no-contains [<commit>]]"),
14 NULL
17 int cmd_for_each_ref(int argc, const char **argv, const char *prefix)
19 int i;
20 const char *format = "%(objectname) %(objecttype)\t%(refname)";
21 struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
22 int maxcount = 0, quote_style = 0, icase = 0;
23 struct ref_array array;
24 struct ref_filter filter;
26 struct option opts[] = {
27 OPT_BIT('s', "shell", &quote_style,
28 N_("quote placeholders suitably for shells"), QUOTE_SHELL),
29 OPT_BIT('p', "perl", &quote_style,
30 N_("quote placeholders suitably for perl"), QUOTE_PERL),
31 OPT_BIT(0 , "python", &quote_style,
32 N_("quote placeholders suitably for python"), QUOTE_PYTHON),
33 OPT_BIT(0 , "tcl", &quote_style,
34 N_("quote placeholders suitably for Tcl"), QUOTE_TCL),
36 OPT_GROUP(""),
37 OPT_INTEGER( 0 , "count", &maxcount, N_("show only <n> matched refs")),
38 OPT_STRING( 0 , "format", &format, N_("format"), N_("format to use for the output")),
39 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
40 N_("field name to sort on"), &parse_opt_ref_sorting),
41 OPT_CALLBACK(0, "points-at", &filter.points_at,
42 N_("object"), N_("print only refs which points at the given object"),
43 parse_opt_object_name),
44 OPT_MERGED(&filter, N_("print only refs that are merged")),
45 OPT_NO_MERGED(&filter, N_("print only refs that are not merged")),
46 OPT_CONTAINS(&filter.with_commit, N_("print only refs which contain the commit")),
47 OPT_NO_CONTAINS(&filter.no_commit, N_("print only refs which don't contain the commit")),
48 OPT_BOOL(0, "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
49 OPT_END(),
52 memset(&array, 0, sizeof(array));
53 memset(&filter, 0, sizeof(filter));
55 parse_options(argc, argv, prefix, opts, for_each_ref_usage, 0);
56 if (maxcount < 0) {
57 error("invalid --count argument: `%d'", maxcount);
58 usage_with_options(for_each_ref_usage, opts);
60 if (HAS_MULTI_BITS(quote_style)) {
61 error("more than one quoting style?");
62 usage_with_options(for_each_ref_usage, opts);
64 if (verify_ref_format(format))
65 usage_with_options(for_each_ref_usage, opts);
67 if (!sorting)
68 sorting = ref_default_sorting();
69 sorting->ignore_case = icase;
70 filter.ignore_case = icase;
72 /* for warn_ambiguous_refs */
73 git_config(git_default_config, NULL);
75 filter.name_patterns = argv;
76 filter.match_as_path = 1;
77 filter_refs(&array, &filter, FILTER_REFS_ALL | FILTER_REFS_INCLUDE_BROKEN);
78 ref_array_sort(sorting, &array);
80 if (!maxcount || array.nr < maxcount)
81 maxcount = array.nr;
82 for (i = 0; i < maxcount; i++)
83 show_ref_array_item(array.items[i], format, quote_style);
84 ref_array_clear(&array);
85 return 0;