Documentation/user-manual: update outdated example output
[git.git] / builtin / check-attr.c
blob91444dc0448b32e854f1923fe1e57e28c87f5b35
1 #include "builtin.h"
2 #include "cache.h"
3 #include "config.h"
4 #include "attr.h"
5 #include "quote.h"
6 #include "parse-options.h"
8 static int all_attrs;
9 static int cached_attrs;
10 static int stdin_paths;
11 static const char * const check_attr_usage[] = {
12 N_("git check-attr [-a | --all | <attr>...] [--] <pathname>..."),
13 N_("git check-attr --stdin [-z] [-a | --all | <attr>...]"),
14 NULL
17 static int nul_term_line;
19 static const struct option check_attr_options[] = {
20 OPT_BOOL('a', "all", &all_attrs, N_("report all attributes set on file")),
21 OPT_BOOL(0, "cached", &cached_attrs, N_("use .gitattributes only from the index")),
22 OPT_BOOL(0 , "stdin", &stdin_paths, N_("read file names from stdin")),
23 OPT_BOOL('z', NULL, &nul_term_line,
24 N_("terminate input and output records by a NUL character")),
25 OPT_END()
28 static void output_attr(struct attr_check *check, const char *file)
30 int j;
31 int cnt = check->nr;
33 for (j = 0; j < cnt; j++) {
34 const char *value = check->items[j].value;
36 if (ATTR_TRUE(value))
37 value = "set";
38 else if (ATTR_FALSE(value))
39 value = "unset";
40 else if (ATTR_UNSET(value))
41 value = "unspecified";
43 if (nul_term_line) {
44 printf("%s%c" /* path */
45 "%s%c" /* attrname */
46 "%s%c" /* attrvalue */,
47 file, 0,
48 git_attr_name(check->items[j].attr), 0, value, 0);
49 } else {
50 quote_c_style(file, NULL, stdout, 0);
51 printf(": %s: %s\n",
52 git_attr_name(check->items[j].attr), value);
57 static void check_attr(const char *prefix,
58 struct attr_check *check,
59 int collect_all,
60 const char *file)
62 char *full_path =
63 prefix_path(prefix, prefix ? strlen(prefix) : 0, file);
65 if (collect_all) {
66 git_all_attrs(full_path, check);
67 } else {
68 if (git_check_attr(full_path, check))
69 die("git_check_attr died");
71 output_attr(check, file);
73 free(full_path);
76 static void check_attr_stdin_paths(const char *prefix,
77 struct attr_check *check,
78 int collect_all)
80 struct strbuf buf = STRBUF_INIT;
81 struct strbuf unquoted = STRBUF_INIT;
82 strbuf_getline_fn getline_fn;
84 getline_fn = nul_term_line ? strbuf_getline_nul : strbuf_getline_lf;
85 while (getline_fn(&buf, stdin) != EOF) {
86 if (!nul_term_line && buf.buf[0] == '"') {
87 strbuf_reset(&unquoted);
88 if (unquote_c_style(&unquoted, buf.buf, NULL))
89 die("line is badly quoted");
90 strbuf_swap(&buf, &unquoted);
92 check_attr(prefix, check, collect_all, buf.buf);
93 maybe_flush_or_die(stdout, "attribute to stdout");
95 strbuf_release(&buf);
96 strbuf_release(&unquoted);
99 static NORETURN void error_with_usage(const char *msg)
101 error("%s", msg);
102 usage_with_options(check_attr_usage, check_attr_options);
105 int cmd_check_attr(int argc, const char **argv, const char *prefix)
107 struct attr_check *check;
108 int cnt, i, doubledash, filei;
110 if (!is_bare_repository())
111 setup_work_tree();
113 git_config(git_default_config, NULL);
115 argc = parse_options(argc, argv, prefix, check_attr_options,
116 check_attr_usage, PARSE_OPT_KEEP_DASHDASH);
118 if (read_cache() < 0) {
119 die("invalid cache");
122 if (cached_attrs)
123 git_attr_set_direction(GIT_ATTR_INDEX, NULL);
125 doubledash = -1;
126 for (i = 0; doubledash < 0 && i < argc; i++) {
127 if (!strcmp(argv[i], "--"))
128 doubledash = i;
131 /* Process --all and/or attribute arguments: */
132 if (all_attrs) {
133 if (doubledash >= 1)
134 error_with_usage("Attributes and --all both specified");
136 cnt = 0;
137 filei = doubledash + 1;
138 } else if (doubledash == 0) {
139 error_with_usage("No attribute specified");
140 } else if (doubledash < 0) {
141 if (!argc)
142 error_with_usage("No attribute specified");
144 if (stdin_paths) {
145 /* Treat all arguments as attribute names. */
146 cnt = argc;
147 filei = argc;
148 } else {
149 /* Treat exactly one argument as an attribute name. */
150 cnt = 1;
151 filei = 1;
153 } else {
154 cnt = doubledash;
155 filei = doubledash + 1;
158 /* Check file argument(s): */
159 if (stdin_paths) {
160 if (filei < argc)
161 error_with_usage("Can't specify files with --stdin");
162 } else {
163 if (filei >= argc)
164 error_with_usage("No file specified");
167 check = attr_check_alloc();
168 if (!all_attrs) {
169 for (i = 0; i < cnt; i++) {
170 const struct git_attr *a = git_attr(argv[i]);
172 if (!a)
173 return error("%s: not a valid attribute name",
174 argv[i]);
175 attr_check_append(check, a);
179 if (stdin_paths)
180 check_attr_stdin_paths(prefix, check, all_attrs);
181 else {
182 for (i = filei; i < argc; i++)
183 check_attr(prefix, check, all_attrs, argv[i]);
184 maybe_flush_or_die(stdout, "attribute to stdout");
187 attr_check_free(check);
188 return 0;