Merge branch 'dg/user-manual-hash-example'
[alt-git.git] / builtin / tag.c
blob19a7e06bf414ccf811c93f0ac941a142a7fabef2
1 /*
2 * Builtin "git tag"
4 * Copyright (c) 2007 Kristian Høgsberg <krh@redhat.com>,
5 * Carlos Rica <jasampler@gmail.com>
6 * Based on git-tag.sh and mktag.c by Linus Torvalds.
7 */
9 #include "builtin.h"
10 #include "advice.h"
11 #include "config.h"
12 #include "editor.h"
13 #include "environment.h"
14 #include "gettext.h"
15 #include "hex.h"
16 #include "refs.h"
17 #include "object-name.h"
18 #include "object-store-ll.h"
19 #include "path.h"
20 #include "tag.h"
21 #include "parse-options.h"
22 #include "diff.h"
23 #include "revision.h"
24 #include "gpg-interface.h"
25 #include "oid-array.h"
26 #include "column.h"
27 #include "ref-filter.h"
28 #include "date.h"
29 #include "write-or-die.h"
31 static const char * const git_tag_usage[] = {
32 N_("git tag [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] [-e]\n"
33 " <tagname> [<commit> | <object>]"),
34 N_("git tag -d <tagname>..."),
35 N_("git tag [-n[<num>]] -l [--contains <commit>] [--no-contains <commit>]\n"
36 " [--points-at <object>] [--column[=<options>] | --no-column]\n"
37 " [--create-reflog] [--sort=<key>] [--format=<format>]\n"
38 " [--merged <commit>] [--no-merged <commit>] [<pattern>...]"),
39 N_("git tag -v [--format=<format>] <tagname>..."),
40 NULL
43 static unsigned int colopts;
44 static int force_sign_annotate;
45 static int config_sign_tag = -1; /* unspecified */
47 static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting,
48 struct ref_format *format)
50 char *to_free = NULL;
52 if (filter->lines == -1)
53 filter->lines = 0;
55 if (!format->format) {
56 if (filter->lines) {
57 to_free = xstrfmt("%s %%(contents:lines=%d)",
58 "%(align:15)%(refname:lstrip=2)%(end)",
59 filter->lines);
60 format->format = to_free;
61 } else
62 format->format = "%(refname:lstrip=2)";
65 if (verify_ref_format(format))
66 die(_("unable to parse format string"));
67 filter->with_commit_tag_algo = 1;
68 filter_and_format_refs(filter, FILTER_REFS_TAGS, sorting, format);
70 free(to_free);
72 return 0;
75 typedef int (*each_tag_name_fn)(const char *name, const char *ref,
76 const struct object_id *oid, void *cb_data);
78 static int for_each_tag_name(const char **argv, each_tag_name_fn fn,
79 void *cb_data)
81 const char **p;
82 struct strbuf ref = STRBUF_INIT;
83 int had_error = 0;
84 struct object_id oid;
86 for (p = argv; *p; p++) {
87 strbuf_reset(&ref);
88 strbuf_addf(&ref, "refs/tags/%s", *p);
89 if (read_ref(ref.buf, &oid)) {
90 error(_("tag '%s' not found."), *p);
91 had_error = 1;
92 continue;
94 if (fn(*p, ref.buf, &oid, cb_data))
95 had_error = 1;
97 strbuf_release(&ref);
98 return had_error;
101 static int collect_tags(const char *name UNUSED, const char *ref,
102 const struct object_id *oid, void *cb_data)
104 struct string_list *ref_list = cb_data;
106 string_list_append(ref_list, ref);
107 ref_list->items[ref_list->nr - 1].util = oiddup(oid);
108 return 0;
111 static int delete_tags(const char **argv)
113 int result;
114 struct string_list refs_to_delete = STRING_LIST_INIT_DUP;
115 struct string_list_item *item;
117 result = for_each_tag_name(argv, collect_tags, (void *)&refs_to_delete);
118 if (delete_refs(NULL, &refs_to_delete, REF_NO_DEREF))
119 result = 1;
121 for_each_string_list_item(item, &refs_to_delete) {
122 const char *name = item->string;
123 struct object_id *oid = item->util;
124 if (!ref_exists(name))
125 printf(_("Deleted tag '%s' (was %s)\n"),
126 item->string + 10,
127 repo_find_unique_abbrev(the_repository, oid, DEFAULT_ABBREV));
129 free(oid);
131 string_list_clear(&refs_to_delete, 0);
132 return result;
135 static int verify_tag(const char *name, const char *ref UNUSED,
136 const struct object_id *oid, void *cb_data)
138 int flags;
139 struct ref_format *format = cb_data;
140 flags = GPG_VERIFY_VERBOSE;
142 if (format->format)
143 flags = GPG_VERIFY_OMIT_STATUS;
145 if (gpg_verify_tag(oid, name, flags))
146 return -1;
148 if (format->format)
149 pretty_print_ref(name, oid, format);
151 return 0;
154 static int do_sign(struct strbuf *buffer)
156 return sign_buffer(buffer, buffer, get_signing_key()) ? -1 : 0;
159 static const char tag_template[] =
160 N_("\nWrite a message for tag:\n %s\n"
161 "Lines starting with '%c' will be ignored.\n");
163 static const char tag_template_nocleanup[] =
164 N_("\nWrite a message for tag:\n %s\n"
165 "Lines starting with '%c' will be kept; you may remove them"
166 " yourself if you want to.\n");
168 static int git_tag_config(const char *var, const char *value,
169 const struct config_context *ctx, void *cb)
171 if (!strcmp(var, "tag.gpgsign")) {
172 config_sign_tag = git_config_bool(var, value);
173 return 0;
176 if (!strcmp(var, "tag.sort")) {
177 if (!value)
178 return config_error_nonbool(var);
179 string_list_append(cb, value);
180 return 0;
183 if (!strcmp(var, "tag.forcesignannotated")) {
184 force_sign_annotate = git_config_bool(var, value);
185 return 0;
188 if (starts_with(var, "column."))
189 return git_column_config(var, value, "tag", &colopts);
191 if (git_color_config(var, value, cb) < 0)
192 return -1;
194 return git_default_config(var, value, ctx, cb);
197 static void write_tag_body(int fd, const struct object_id *oid)
199 unsigned long size;
200 enum object_type type;
201 char *buf, *sp, *orig;
202 struct strbuf payload = STRBUF_INIT;
203 struct strbuf signature = STRBUF_INIT;
205 orig = buf = repo_read_object_file(the_repository, oid, &type, &size);
206 if (!buf)
207 return;
208 if (parse_signature(buf, size, &payload, &signature)) {
209 buf = payload.buf;
210 size = payload.len;
212 /* skip header */
213 sp = strstr(buf, "\n\n");
215 if (!sp || !size || type != OBJ_TAG) {
216 free(buf);
217 return;
219 sp += 2; /* skip the 2 LFs */
220 write_or_die(fd, sp, buf + size - sp);
222 free(orig);
223 strbuf_release(&payload);
224 strbuf_release(&signature);
227 static int build_tag_object(struct strbuf *buf, int sign, struct object_id *result)
229 if (sign && do_sign(buf) < 0)
230 return error(_("unable to sign the tag"));
231 if (write_object_file(buf->buf, buf->len, OBJ_TAG, result) < 0)
232 return error(_("unable to write tag file"));
233 return 0;
236 struct create_tag_options {
237 unsigned int message_given:1;
238 unsigned int use_editor:1;
239 unsigned int sign;
240 enum {
241 CLEANUP_NONE,
242 CLEANUP_SPACE,
243 CLEANUP_ALL
244 } cleanup_mode;
247 static const char message_advice_nested_tag[] =
248 N_("You have created a nested tag. The object referred to by your new tag is\n"
249 "already a tag. If you meant to tag the object that it points to, use:\n"
250 "\n"
251 "\tgit tag -f %s %s^{}");
253 static void create_tag(const struct object_id *object, const char *object_ref,
254 const char *tag,
255 struct strbuf *buf, struct create_tag_options *opt,
256 struct object_id *prev, struct object_id *result, char *path)
258 enum object_type type;
259 struct strbuf header = STRBUF_INIT;
261 type = oid_object_info(the_repository, object, NULL);
262 if (type <= OBJ_NONE)
263 die(_("bad object type."));
265 if (type == OBJ_TAG)
266 advise_if_enabled(ADVICE_NESTED_TAG, _(message_advice_nested_tag),
267 tag, object_ref);
269 strbuf_addf(&header,
270 "object %s\n"
271 "type %s\n"
272 "tag %s\n"
273 "tagger %s\n\n",
274 oid_to_hex(object),
275 type_name(type),
276 tag,
277 git_committer_info(IDENT_STRICT));
279 if (!opt->message_given || opt->use_editor) {
280 int fd;
282 /* write the template message before editing: */
283 fd = xopen(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
285 if (opt->message_given) {
286 write_or_die(fd, buf->buf, buf->len);
287 strbuf_reset(buf);
288 } else if (!is_null_oid(prev)) {
289 write_tag_body(fd, prev);
290 } else {
291 struct strbuf buf = STRBUF_INIT;
292 strbuf_addch(&buf, '\n');
293 if (opt->cleanup_mode == CLEANUP_ALL)
294 strbuf_commented_addf(&buf, comment_line_char,
295 _(tag_template), tag, comment_line_char);
296 else
297 strbuf_commented_addf(&buf, comment_line_char,
298 _(tag_template_nocleanup), tag, comment_line_char);
299 write_or_die(fd, buf.buf, buf.len);
300 strbuf_release(&buf);
302 close(fd);
304 if (launch_editor(path, buf, NULL)) {
305 fprintf(stderr,
306 _("Please supply the message using either -m or -F option.\n"));
307 exit(1);
311 if (opt->cleanup_mode != CLEANUP_NONE)
312 strbuf_stripspace(buf,
313 opt->cleanup_mode == CLEANUP_ALL ? comment_line_char : '\0');
315 if (!opt->message_given && !buf->len)
316 die(_("no tag message?"));
318 strbuf_insert(buf, 0, header.buf, header.len);
319 strbuf_release(&header);
321 if (build_tag_object(buf, opt->sign, result) < 0) {
322 if (path)
323 fprintf(stderr, _("The tag message has been left in %s\n"),
324 path);
325 exit(128);
329 static void create_reflog_msg(const struct object_id *oid, struct strbuf *sb)
331 enum object_type type;
332 struct commit *c;
333 char *buf;
334 unsigned long size;
335 int subject_len = 0;
336 const char *subject_start;
338 char *rla = getenv("GIT_REFLOG_ACTION");
339 if (rla) {
340 strbuf_addstr(sb, rla);
341 } else {
342 strbuf_addstr(sb, "tag: tagging ");
343 strbuf_add_unique_abbrev(sb, oid, DEFAULT_ABBREV);
346 strbuf_addstr(sb, " (");
347 type = oid_object_info(the_repository, oid, NULL);
348 switch (type) {
349 default:
350 strbuf_addstr(sb, "object of unknown type");
351 break;
352 case OBJ_COMMIT:
353 if ((buf = repo_read_object_file(the_repository, oid, &type, &size))) {
354 subject_len = find_commit_subject(buf, &subject_start);
355 strbuf_insert(sb, sb->len, subject_start, subject_len);
356 } else {
357 strbuf_addstr(sb, "commit object");
359 free(buf);
361 if ((c = lookup_commit_reference(the_repository, oid)))
362 strbuf_addf(sb, ", %s", show_date(c->date, 0, DATE_MODE(SHORT)));
363 break;
364 case OBJ_TREE:
365 strbuf_addstr(sb, "tree object");
366 break;
367 case OBJ_BLOB:
368 strbuf_addstr(sb, "blob object");
369 break;
370 case OBJ_TAG:
371 strbuf_addstr(sb, "other tag object");
372 break;
374 strbuf_addch(sb, ')');
377 struct msg_arg {
378 int given;
379 struct strbuf buf;
382 static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
384 struct msg_arg *msg = opt->value;
386 BUG_ON_OPT_NEG(unset);
388 if (!arg)
389 return -1;
390 if (msg->buf.len)
391 strbuf_addstr(&(msg->buf), "\n\n");
392 strbuf_addstr(&(msg->buf), arg);
393 msg->given = 1;
394 return 0;
397 static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
399 if (name[0] == '-')
400 return -1;
402 strbuf_reset(sb);
403 strbuf_addf(sb, "refs/tags/%s", name);
405 return check_refname_format(sb->buf, 0);
408 int cmd_tag(int argc, const char **argv, const char *prefix)
410 struct strbuf buf = STRBUF_INIT;
411 struct strbuf ref = STRBUF_INIT;
412 struct strbuf reflog_msg = STRBUF_INIT;
413 struct object_id object, prev;
414 const char *object_ref, *tag;
415 struct create_tag_options opt;
416 char *cleanup_arg = NULL;
417 int create_reflog = 0;
418 int annotate = 0, force = 0;
419 int cmdmode = 0, create_tag_object = 0;
420 char *msgfile = NULL;
421 const char *keyid = NULL;
422 struct msg_arg msg = { .buf = STRBUF_INIT };
423 struct ref_transaction *transaction;
424 struct strbuf err = STRBUF_INIT;
425 struct ref_filter filter = REF_FILTER_INIT;
426 struct ref_sorting *sorting;
427 struct string_list sorting_options = STRING_LIST_INIT_DUP;
428 struct ref_format format = REF_FORMAT_INIT;
429 int icase = 0;
430 int edit_flag = 0;
431 struct option options[] = {
432 OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
433 { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
434 N_("print <n> lines of each tag message"),
435 PARSE_OPT_OPTARG, NULL, 1 },
436 OPT_CMDMODE('d', "delete", &cmdmode, N_("delete tags"), 'd'),
437 OPT_CMDMODE('v', "verify", &cmdmode, N_("verify tags"), 'v'),
439 OPT_GROUP(N_("Tag creation options")),
440 OPT_BOOL('a', "annotate", &annotate,
441 N_("annotated tag, needs a message")),
442 OPT_CALLBACK_F('m', "message", &msg, N_("message"),
443 N_("tag message"), PARSE_OPT_NONEG, parse_msg_arg),
444 OPT_FILENAME('F', "file", &msgfile, N_("read message from file")),
445 OPT_BOOL('e', "edit", &edit_flag, N_("force edit of tag message")),
446 OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
447 OPT_CLEANUP(&cleanup_arg),
448 OPT_STRING('u', "local-user", &keyid, N_("key-id"),
449 N_("use another key to sign the tag")),
450 OPT__FORCE(&force, N_("replace the tag if exists"), 0),
451 OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
453 OPT_GROUP(N_("Tag listing options")),
454 OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
455 OPT_CONTAINS(&filter.with_commit, N_("print only tags that contain the commit")),
456 OPT_NO_CONTAINS(&filter.no_commit, N_("print only tags that don't contain the commit")),
457 OPT_WITH(&filter.with_commit, N_("print only tags that contain the commit")),
458 OPT_WITHOUT(&filter.no_commit, N_("print only tags that don't contain the commit")),
459 OPT_MERGED(&filter, N_("print only tags that are merged")),
460 OPT_NO_MERGED(&filter, N_("print only tags that are not merged")),
461 OPT_BOOL(0, "omit-empty", &format.array_opts.omit_empty,
462 N_("do not output a newline after empty formatted refs")),
463 OPT_REF_SORT(&sorting_options),
465 OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
466 N_("print only tags of the object"), PARSE_OPT_LASTARG_DEFAULT,
467 parse_opt_object_name, (intptr_t) "HEAD"
469 OPT_STRING( 0 , "format", &format.format, N_("format"),
470 N_("format to use for the output")),
471 OPT__COLOR(&format.use_color, N_("respect format colors")),
472 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
473 OPT_END()
475 int ret = 0;
476 const char *only_in_list = NULL;
477 char *path = NULL;
479 setup_ref_filter_porcelain_msg();
482 * Try to set sort keys from config. If config does not set any,
483 * fall back on default (refname) sorting.
485 git_config(git_tag_config, &sorting_options);
486 if (!sorting_options.nr)
487 string_list_append(&sorting_options, "refname");
489 memset(&opt, 0, sizeof(opt));
490 filter.lines = -1;
491 opt.sign = -1;
493 argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
495 if (!cmdmode) {
496 if (argc == 0)
497 cmdmode = 'l';
498 else if (filter.with_commit || filter.no_commit ||
499 filter.reachable_from || filter.unreachable_from ||
500 filter.points_at.nr || filter.lines != -1)
501 cmdmode = 'l';
504 if (cmdmode == 'l')
505 setup_auto_pager("tag", 1);
507 if (opt.sign == -1)
508 opt.sign = cmdmode ? 0 : config_sign_tag > 0;
510 if (keyid) {
511 opt.sign = 1;
512 set_signing_key(keyid);
514 create_tag_object = (opt.sign || annotate || msg.given || msgfile);
516 if ((create_tag_object || force) && (cmdmode != 0))
517 usage_with_options(git_tag_usage, options);
519 finalize_colopts(&colopts, -1);
520 if (cmdmode == 'l' && filter.lines != -1) {
521 if (explicitly_enable_column(colopts))
522 die(_("options '%s' and '%s' cannot be used together"), "--column", "-n");
523 colopts = 0;
525 sorting = ref_sorting_options(&sorting_options);
526 ref_sorting_set_sort_flags_all(sorting, REF_SORTING_ICASE, icase);
527 filter.ignore_case = icase;
528 if (cmdmode == 'l') {
529 if (column_active(colopts)) {
530 struct column_options copts;
531 memset(&copts, 0, sizeof(copts));
532 copts.padding = 2;
533 if (run_column_filter(colopts, &copts))
534 die(_("could not start 'git column'"));
536 filter.name_patterns = argv;
537 ret = list_tags(&filter, sorting, &format);
538 if (column_active(colopts))
539 stop_column_filter();
540 goto cleanup;
542 if (filter.lines != -1)
543 only_in_list = "-n";
544 else if (filter.with_commit)
545 only_in_list = "--contains";
546 else if (filter.no_commit)
547 only_in_list = "--no-contains";
548 else if (filter.points_at.nr)
549 only_in_list = "--points-at";
550 else if (filter.reachable_from)
551 only_in_list = "--merged";
552 else if (filter.unreachable_from)
553 only_in_list = "--no-merged";
554 if (only_in_list)
555 die(_("the '%s' option is only allowed in list mode"), only_in_list);
556 if (cmdmode == 'd') {
557 ret = delete_tags(argv);
558 goto cleanup;
560 if (cmdmode == 'v') {
561 if (format.format && verify_ref_format(&format))
562 usage_with_options(git_tag_usage, options);
563 ret = for_each_tag_name(argv, verify_tag, &format);
564 goto cleanup;
567 if (msg.given || msgfile) {
568 if (msg.given && msgfile)
569 die(_("options '%s' and '%s' cannot be used together"), "-F", "-m");
570 if (msg.given)
571 strbuf_addbuf(&buf, &(msg.buf));
572 else {
573 if (!strcmp(msgfile, "-")) {
574 if (strbuf_read(&buf, 0, 1024) < 0)
575 die_errno(_("cannot read '%s'"), msgfile);
576 } else {
577 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
578 die_errno(_("could not open or read '%s'"),
579 msgfile);
584 tag = argv[0];
586 object_ref = argc == 2 ? argv[1] : "HEAD";
587 if (argc > 2)
588 die(_("too many arguments"));
590 if (repo_get_oid(the_repository, object_ref, &object))
591 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
593 if (strbuf_check_tag_ref(&ref, tag))
594 die(_("'%s' is not a valid tag name."), tag);
596 if (read_ref(ref.buf, &prev))
597 oidclr(&prev);
598 else if (!force)
599 die(_("tag '%s' already exists"), tag);
601 opt.message_given = msg.given || msgfile;
602 opt.use_editor = edit_flag;
604 if (!cleanup_arg || !strcmp(cleanup_arg, "strip"))
605 opt.cleanup_mode = CLEANUP_ALL;
606 else if (!strcmp(cleanup_arg, "verbatim"))
607 opt.cleanup_mode = CLEANUP_NONE;
608 else if (!strcmp(cleanup_arg, "whitespace"))
609 opt.cleanup_mode = CLEANUP_SPACE;
610 else
611 die(_("Invalid cleanup mode %s"), cleanup_arg);
613 create_reflog_msg(&object, &reflog_msg);
615 if (create_tag_object) {
616 if (force_sign_annotate && !annotate)
617 opt.sign = 1;
618 path = git_pathdup("TAG_EDITMSG");
619 create_tag(&object, object_ref, tag, &buf, &opt, &prev, &object,
620 path);
623 transaction = ref_transaction_begin(&err);
624 if (!transaction ||
625 ref_transaction_update(transaction, ref.buf, &object, &prev,
626 create_reflog ? REF_FORCE_CREATE_REFLOG : 0,
627 reflog_msg.buf, &err) ||
628 ref_transaction_commit(transaction, &err)) {
629 if (path)
630 fprintf(stderr,
631 _("The tag message has been left in %s\n"),
632 path);
633 die("%s", err.buf);
635 if (path) {
636 unlink_or_warn(path);
637 free(path);
639 ref_transaction_free(transaction);
640 if (force && !is_null_oid(&prev) && !oideq(&prev, &object))
641 printf(_("Updated tag '%s' (was %s)\n"), tag,
642 repo_find_unique_abbrev(the_repository, &prev, DEFAULT_ABBREV));
644 cleanup:
645 ref_sorting_release(sorting);
646 ref_filter_clear(&filter);
647 strbuf_release(&buf);
648 strbuf_release(&ref);
649 strbuf_release(&reflog_msg);
650 strbuf_release(&msg.buf);
651 strbuf_release(&err);
652 free(msgfile);
653 return ret;