blame-options.txt: explain that -L <start> and <end> are optional
[git/gitweb.git] / builtin / shortlog.c
blob1fd6f8ac5977ee670bf8ba230cec8553393baafd
1 #include "builtin.h"
2 #include "cache.h"
3 #include "commit.h"
4 #include "diff.h"
5 #include "string-list.h"
6 #include "revision.h"
7 #include "utf8.h"
8 #include "mailmap.h"
9 #include "shortlog.h"
10 #include "parse-options.h"
12 static char const * const shortlog_usage[] = {
13 N_("git shortlog [<options>] [<revision range>] [[--] [<path>...]]"),
14 NULL
17 static int compare_by_number(const void *a1, const void *a2)
19 const struct string_list_item *i1 = a1, *i2 = a2;
20 const struct string_list *l1 = i1->util, *l2 = i2->util;
22 if (l1->nr < l2->nr)
23 return 1;
24 else if (l1->nr == l2->nr)
25 return 0;
26 else
27 return -1;
30 static void insert_one_record(struct shortlog *log,
31 const char *author,
32 const char *oneline)
34 const char *dot3 = log->common_repo_prefix;
35 char *buffer, *p;
36 struct string_list_item *item;
37 const char *mailbuf, *namebuf;
38 size_t namelen, maillen;
39 const char *eol;
40 struct strbuf subject = STRBUF_INIT;
41 struct strbuf namemailbuf = STRBUF_INIT;
42 struct ident_split ident;
44 if (split_ident_line(&ident, author, strlen(author)))
45 return;
47 namebuf = ident.name_begin;
48 mailbuf = ident.mail_begin;
49 namelen = ident.name_end - ident.name_begin;
50 maillen = ident.mail_end - ident.mail_begin;
52 map_user(&log->mailmap, &mailbuf, &maillen, &namebuf, &namelen);
53 strbuf_add(&namemailbuf, namebuf, namelen);
55 if (log->email)
56 strbuf_addf(&namemailbuf, " <%.*s>", (int)maillen, mailbuf);
58 item = string_list_insert(&log->list, namemailbuf.buf);
59 if (item->util == NULL)
60 item->util = xcalloc(1, sizeof(struct string_list));
62 /* Skip any leading whitespace, including any blank lines. */
63 while (*oneline && isspace(*oneline))
64 oneline++;
65 eol = strchr(oneline, '\n');
66 if (!eol)
67 eol = oneline + strlen(oneline);
68 if (!prefixcmp(oneline, "[PATCH")) {
69 char *eob = strchr(oneline, ']');
70 if (eob && (!eol || eob < eol))
71 oneline = eob + 1;
73 while (*oneline && isspace(*oneline) && *oneline != '\n')
74 oneline++;
75 format_subject(&subject, oneline, " ");
76 buffer = strbuf_detach(&subject, NULL);
78 if (dot3) {
79 int dot3len = strlen(dot3);
80 if (dot3len > 5) {
81 while ((p = strstr(buffer, dot3)) != NULL) {
82 int taillen = strlen(p) - dot3len;
83 memcpy(p, "/.../", 5);
84 memmove(p + 5, p + dot3len, taillen + 1);
89 string_list_append(item->util, buffer);
92 static void read_from_stdin(struct shortlog *log)
94 char author[1024], oneline[1024];
96 while (fgets(author, sizeof(author), stdin) != NULL) {
97 if (!(author[0] == 'A' || author[0] == 'a') ||
98 prefixcmp(author + 1, "uthor: "))
99 continue;
100 while (fgets(oneline, sizeof(oneline), stdin) &&
101 oneline[0] != '\n')
102 ; /* discard headers */
103 while (fgets(oneline, sizeof(oneline), stdin) &&
104 oneline[0] == '\n')
105 ; /* discard blanks */
106 insert_one_record(log, author + 8, oneline);
110 void shortlog_add_commit(struct shortlog *log, struct commit *commit)
112 const char *author = NULL, *buffer;
113 struct strbuf buf = STRBUF_INIT;
114 struct strbuf ufbuf = STRBUF_INIT;
116 pp_commit_easy(CMIT_FMT_RAW, commit, &buf);
117 buffer = buf.buf;
118 while (*buffer && *buffer != '\n') {
119 const char *eol = strchr(buffer, '\n');
121 if (eol == NULL)
122 eol = buffer + strlen(buffer);
123 else
124 eol++;
126 if (!prefixcmp(buffer, "author "))
127 author = buffer + 7;
128 buffer = eol;
130 if (!author)
131 die(_("Missing author: %s"),
132 sha1_to_hex(commit->object.sha1));
133 if (log->user_format) {
134 struct pretty_print_context ctx = {0};
135 ctx.fmt = CMIT_FMT_USERFORMAT;
136 ctx.abbrev = log->abbrev;
137 ctx.subject = "";
138 ctx.after_subject = "";
139 ctx.date_mode = DATE_NORMAL;
140 pretty_print_commit(&ctx, commit, &ufbuf);
141 buffer = ufbuf.buf;
142 } else if (*buffer) {
143 buffer++;
145 insert_one_record(log, author, !*buffer ? "<none>" : buffer);
146 strbuf_release(&ufbuf);
147 strbuf_release(&buf);
150 static void get_from_rev(struct rev_info *rev, struct shortlog *log)
152 struct commit *commit;
154 if (prepare_revision_walk(rev))
155 die(_("revision walk setup failed"));
156 while ((commit = get_revision(rev)) != NULL)
157 shortlog_add_commit(log, commit);
160 static int parse_uint(char const **arg, int comma, int defval)
162 unsigned long ul;
163 int ret;
164 char *endp;
166 ul = strtoul(*arg, &endp, 10);
167 if (*endp && *endp != comma)
168 return -1;
169 if (ul > INT_MAX)
170 return -1;
171 ret = *arg == endp ? defval : (int)ul;
172 *arg = *endp ? endp + 1 : endp;
173 return ret;
176 static const char wrap_arg_usage[] = "-w[<width>[,<indent1>[,<indent2>]]]";
177 #define DEFAULT_WRAPLEN 76
178 #define DEFAULT_INDENT1 6
179 #define DEFAULT_INDENT2 9
181 static int parse_wrap_args(const struct option *opt, const char *arg, int unset)
183 struct shortlog *log = opt->value;
185 log->wrap_lines = !unset;
186 if (unset)
187 return 0;
188 if (!arg) {
189 log->wrap = DEFAULT_WRAPLEN;
190 log->in1 = DEFAULT_INDENT1;
191 log->in2 = DEFAULT_INDENT2;
192 return 0;
195 log->wrap = parse_uint(&arg, ',', DEFAULT_WRAPLEN);
196 log->in1 = parse_uint(&arg, ',', DEFAULT_INDENT1);
197 log->in2 = parse_uint(&arg, '\0', DEFAULT_INDENT2);
198 if (log->wrap < 0 || log->in1 < 0 || log->in2 < 0)
199 return error(wrap_arg_usage);
200 if (log->wrap &&
201 ((log->in1 && log->wrap <= log->in1) ||
202 (log->in2 && log->wrap <= log->in2)))
203 return error(wrap_arg_usage);
204 return 0;
207 void shortlog_init(struct shortlog *log)
209 memset(log, 0, sizeof(*log));
211 read_mailmap(&log->mailmap, &log->common_repo_prefix);
213 log->list.strdup_strings = 1;
214 log->wrap = DEFAULT_WRAPLEN;
215 log->in1 = DEFAULT_INDENT1;
216 log->in2 = DEFAULT_INDENT2;
219 int cmd_shortlog(int argc, const char **argv, const char *prefix)
221 static struct shortlog log;
222 static struct rev_info rev;
223 int nongit = !startup_info->have_repository;
225 static const struct option options[] = {
226 OPT_BOOLEAN('n', "numbered", &log.sort_by_number,
227 N_("sort output according to the number of commits per author")),
228 OPT_BOOLEAN('s', "summary", &log.summary,
229 N_("Suppress commit descriptions, only provides commit count")),
230 OPT_BOOLEAN('e', "email", &log.email,
231 N_("Show the email address of each author")),
232 { OPTION_CALLBACK, 'w', NULL, &log, N_("w[,i1[,i2]]"),
233 N_("Linewrap output"), PARSE_OPT_OPTARG, &parse_wrap_args },
234 OPT_END(),
237 struct parse_opt_ctx_t ctx;
239 git_config(git_default_config, NULL);
240 shortlog_init(&log);
241 init_revisions(&rev, prefix);
242 parse_options_start(&ctx, argc, argv, prefix, options,
243 PARSE_OPT_KEEP_DASHDASH | PARSE_OPT_KEEP_ARGV0);
245 for (;;) {
246 switch (parse_options_step(&ctx, options, shortlog_usage)) {
247 case PARSE_OPT_HELP:
248 exit(129);
249 case PARSE_OPT_DONE:
250 goto parse_done;
252 parse_revision_opt(&rev, &ctx, options, shortlog_usage);
254 parse_done:
255 argc = parse_options_end(&ctx);
257 if (setup_revisions(argc, argv, &rev, NULL) != 1) {
258 error(_("unrecognized argument: %s"), argv[1]);
259 usage_with_options(shortlog_usage, options);
262 log.user_format = rev.commit_format == CMIT_FMT_USERFORMAT;
263 log.abbrev = rev.abbrev;
265 /* assume HEAD if from a tty */
266 if (!nongit && !rev.pending.nr && isatty(0))
267 add_head_to_pending(&rev);
268 if (rev.pending.nr == 0) {
269 if (isatty(0))
270 fprintf(stderr, _("(reading log message from standard input)\n"));
271 read_from_stdin(&log);
273 else
274 get_from_rev(&rev, &log);
276 shortlog_output(&log);
277 return 0;
280 static void add_wrapped_shortlog_msg(struct strbuf *sb, const char *s,
281 const struct shortlog *log)
283 strbuf_add_wrapped_text(sb, s, log->in1, log->in2, log->wrap);
284 strbuf_addch(sb, '\n');
287 void shortlog_output(struct shortlog *log)
289 int i, j;
290 struct strbuf sb = STRBUF_INIT;
292 if (log->sort_by_number)
293 qsort(log->list.items, log->list.nr, sizeof(struct string_list_item),
294 compare_by_number);
295 for (i = 0; i < log->list.nr; i++) {
296 struct string_list *onelines = log->list.items[i].util;
298 if (log->summary) {
299 printf("%6d\t%s\n", onelines->nr, log->list.items[i].string);
300 } else {
301 printf("%s (%d):\n", log->list.items[i].string, onelines->nr);
302 for (j = onelines->nr - 1; j >= 0; j--) {
303 const char *msg = onelines->items[j].string;
305 if (log->wrap_lines) {
306 strbuf_reset(&sb);
307 add_wrapped_shortlog_msg(&sb, msg, log);
308 fwrite(sb.buf, sb.len, 1, stdout);
310 else
311 printf(" %s\n", msg);
313 putchar('\n');
316 onelines->strdup_strings = 1;
317 string_list_clear(onelines, 0);
318 free(onelines);
319 log->list.items[i].util = NULL;
322 strbuf_release(&sb);
323 log->list.strdup_strings = 1;
324 string_list_clear(&log->list, 1);
325 clear_mailmap(&log->mailmap);