Google Git
Sign in
googlers / jrn / git / 20769079d22a9f8010232bdf6131918c33a1bf69 / . / builtin / tag.c
blob: e40c4a96763a371b104a5bf47e6d839ed93e8ef5 [file] [log] [blame]
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]1/*
2 * Builtin "git tag"
3 *
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 */
8
9#include "cache.h"
10#include "builtin.h"
11#include "refs.h"
12#include "tag.h"
13#include "run-command.h"
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]14#include "parse-options.h"
Jeff Kingffc4b802011-06-11 19:04:08 +0000[diff] [blame]15#include "diff.h"
16#include "revision.h"
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700[diff] [blame]17#include "gpg-interface.h"
Tom Grennanae7706b2012-02-08 15:03:43 -0800[diff] [blame]18#include "sha1-array.h"
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700[diff] [blame]19#include "column.h"
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]20#include "ref-filter.h"
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]21
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]22static const char * const git_tag_usage[] = {
Alex Henrie9c9b4f22015-01-13 00:44:47 -0700[diff] [blame]23 N_("git tag [-a | -s | -u <key-id>] [-f] [-m <msg> | -F <file>] <tagname> [<head>]"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700[diff] [blame]24 N_("git tag -d <tagname>..."),
Alex Henrie9c9b4f22015-01-13 00:44:47 -0700[diff] [blame]25 N_("git tag -l [-n[<num>]] [--contains <commit>] [--points-at <object>]"
Karthik Nayak52428602015-09-10 21:52:49 +0530[diff] [blame]26 "\n\t\t[--format=<format>] [--[no-]merged [<commit>]] [<pattern>...]"),
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500[diff] [blame]27 N_("git tag -v [--format=<format>] <tagname>..."),
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]28 NULL
29};
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]30
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700[diff] [blame]31static unsigned int colopts;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100[diff] [blame]32static int force_sign_annotate;
Tom Grennanae7706b2012-02-08 15:03:43 -0800[diff] [blame]33
Karthik Nayakdf094742015-09-11 20:36:46 +0530[diff] [blame]34static int list_tags(struct ref_filter *filter, struct ref_sorting *sorting, const char *format)
Jeff King588d0e82011-06-20 12:59:28 -0400[diff] [blame]35{
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]36 struct ref_array array;
Karthik Nayakdf094742015-09-11 20:36:46 +0530[diff] [blame]37 char *to_free = NULL;
Jeff Kingca516992012-02-06 03:13:12 -0500[diff] [blame]38 int i;
Jeff Kingca516992012-02-06 03:13:12 -0500[diff] [blame]39
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]40 memset(&array, 0, sizeof(array));
Jeff Kingca516992012-02-06 03:13:12 -0500[diff] [blame]41
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]42 if (filter->lines == -1)
43 filter->lines = 0;
Junio C Hamano31fd8d72012-02-06 10:13:27 -0800[diff] [blame]44
Karthik Nayakdf094742015-09-11 20:36:46 +0530[diff] [blame]45 if (!format) {
46 if (filter->lines) {
47 to_free = xstrfmt("%s %%(contents:lines=%d)",
Jeff King05719792016-01-25 22:00:05 -0500[diff] [blame]48 "%(align:15)%(refname:strip=2)%(end)",
Karthik Nayakdf094742015-09-11 20:36:46 +0530[diff] [blame]49 filter->lines);
50 format = to_free;
51 } else
Jeff King05719792016-01-25 22:00:05 -0500[diff] [blame]52 format = "%(refname:strip=2)";
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]53 }
54
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]55 verify_ref_format(format);
Karthik Nayak008ed7d2015-10-18 15:55:04 +0530[diff] [blame]56 filter->with_commit_tag_algo = 1;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]57 filter_refs(&array, filter, FILTER_REFS_TAGS);
58 ref_array_sort(sorting, &array);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]59
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]60 for (i = 0; i < array.nr; i++)
61 show_ref_array_item(array.items[i], format, 0);
62 ref_array_clear(&array);
63 free(to_free);
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 19:56:52 +0700[diff] [blame]64
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]65 return 0;
66}
67
Carlos Ricae317cfa2007-07-21 14:13:12 +0200[diff] [blame]68typedef int (*each_tag_name_fn)(const char *name, const char *ref,
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500[diff] [blame]69 const unsigned char *sha1, const void *cb_data);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]70
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500[diff] [blame]71static int for_each_tag_name(const char **argv, each_tag_name_fn fn,
72 const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]73{
74 const char **p;
75 char ref[PATH_MAX];
76 int had_error = 0;
77 unsigned char sha1[20];
78
79 for (p = argv; *p; p++) {
80 if (snprintf(ref, sizeof(ref), "refs/tags/%s", *p)
81 >= sizeof(ref)) {
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]82 error(_("tag name too long: %.*s..."), 50, *p);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]83 had_error = 1;
84 continue;
85 }
Nguyễn Thái Ngọc Duyc6893322011-11-13 17:22:14 +0700[diff] [blame]86 if (read_ref(ref, sha1)) {
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]87 error(_("tag '%s' not found."), *p);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]88 had_error = 1;
89 continue;
90 }
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500[diff] [blame]91 if (fn(*p, ref, sha1, cb_data))
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]92 had_error = 1;
93 }
94 return had_error;
95}
96
97static int delete_tag(const char *name, const char *ref,
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500[diff] [blame]98 const unsigned char *sha1, const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]99{
Miklos Vajnaeca35a22008-10-26 03:33:56 +0100[diff] [blame]100 if (delete_ref(ref, sha1, 0))
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]101 return 1;
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]102 printf(_("Deleted tag '%s' (was %s)\n"), name, find_unique_abbrev(sha1, DEFAULT_ABBREV));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]103 return 0;
104}
105
106static int verify_tag(const char *name, const char *ref,
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500[diff] [blame]107 const unsigned char *sha1, const void *cb_data)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]108{
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500[diff] [blame]109 int flags;
110 const char *fmt_pretty = cb_data;
111 flags = GPG_VERIFY_VERBOSE;
112
113 if (fmt_pretty)
114 flags = GPG_VERIFY_OMIT_STATUS;
115
116 if (gpg_verify_tag(sha1, name, flags))
117 return -1;
118
119 if (fmt_pretty)
120 pretty_print_ref(name, sha1, fmt_pretty);
121
122 return 0;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]123}
124
Pierre Habouzitfd17f5b2007-09-10 12:35:09 +0200[diff] [blame]125static int do_sign(struct strbuf *buffer)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]126{
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700[diff] [blame]127 return sign_buffer(buffer, buffer, get_signing_key());
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]128}
129
130static const char tag_template[] =
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200[diff] [blame]131 N_("\nWrite a message for tag:\n %s\n"
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100[diff] [blame]132 "Lines starting with '%c' will be ignored.\n");
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]133
134static const char tag_template_nocleanup[] =
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200[diff] [blame]135 N_("\nWrite a message for tag:\n %s\n"
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100[diff] [blame]136 "Lines starting with '%c' will be kept; you may remove them"
137 " yourself if you want to.\n");
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]138
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]139/* Parse arg given and add it the ref_sorting array */
140static int parse_sorting_string(const char *arg, struct ref_sorting **sorting_tail)
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]141{
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]142 struct ref_sorting *s;
143 int len;
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]144
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]145 s = xcalloc(1, sizeof(*s));
146 s->next = *sorting_tail;
147 *sorting_tail = s;
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]148
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]149 if (*arg == '-') {
150 s->reverse = 1;
151 arg++;
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]152 }
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]153 if (skip_prefix(arg, "version:", &arg) ||
154 skip_prefix(arg, "v:", &arg))
155 s->version = 1;
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]156
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]157 len = strlen(arg);
158 s->atom = parse_ref_filter_atom(arg, arg+len);
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]159
160 return 0;
161}
162
Johannes Schindelinef90d6d2008-05-14 18:46:53 +0100[diff] [blame]163static int git_tag_config(const char *var, const char *value, void *cb)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]164{
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]165 int status;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]166 struct ref_sorting **sorting_tail = (struct ref_sorting **)cb;
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]167
168 if (!strcmp(var, "tag.sort")) {
169 if (!value)
170 return config_error_nonbool(var);
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]171 parse_sorting_string(value, sorting_tail);
Jacob Kellerb1507942014-07-16 14:48:02 -0700[diff] [blame]172 return 0;
173 }
174
175 status = git_gpg_config(var, value, cb);
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700[diff] [blame]176 if (status)
177 return status;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100[diff] [blame]178 if (!strcmp(var, "tag.forcesignannotated")) {
179 force_sign_annotate = git_config_bool(var, value);
180 return 0;
181 }
182
Christian Couder59556542013-11-30 21:55:40 +0100[diff] [blame]183 if (starts_with(var, "column."))
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700[diff] [blame]184 return git_column_config(var, value, "tag", &colopts);
Johannes Schindelinef90d6d2008-05-14 18:46:53 +0100[diff] [blame]185 return git_default_config(var, value, cb);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]186}
187
Mike Hommeybab81182007-11-04 01:11:14 +0100[diff] [blame]188static void write_tag_body(int fd, const unsigned char *sha1)
189{
190 unsigned long size;
191 enum object_type type;
Michael J Grubere10dfb62010-11-10 12:17:28 +0100[diff] [blame]192 char *buf, *sp;
Mike Hommeybab81182007-11-04 01:11:14 +0100[diff] [blame]193
194 buf = read_sha1_file(sha1, &type, &size);
195 if (!buf)
196 return;
197 /* skip header */
198 sp = strstr(buf, "\n\n");
199
200 if (!sp || !size || type != OBJ_TAG) {
201 free(buf);
202 return;
203 }
204 sp += 2; /* skip the 2 LFs */
Michael J Grubere10dfb62010-11-10 12:17:28 +0100[diff] [blame]205 write_or_die(fd, sp, parse_signature(sp, buf + size - sp));
Mike Hommeybab81182007-11-04 01:11:14 +0100[diff] [blame]206
207 free(buf);
208}
209
Jeff King3927bbe2008-12-06 14:40:34 -0500[diff] [blame]210static int build_tag_object(struct strbuf *buf, int sign, unsigned char *result)
211{
212 if (sign && do_sign(buf) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]213 return error(_("unable to sign the tag"));
Jeff King3927bbe2008-12-06 14:40:34 -0500[diff] [blame]214 if (write_sha1_file(buf->buf, buf->len, tag_type, result) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]215 return error(_("unable to write tag file"));
Jeff King3927bbe2008-12-06 14:40:34 -0500[diff] [blame]216 return 0;
217}
218
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]219struct create_tag_options {
220 unsigned int message_given:1;
221 unsigned int sign;
222 enum {
223 CLEANUP_NONE,
224 CLEANUP_SPACE,
225 CLEANUP_ALL
226 } cleanup_mode;
227};
228
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]229static void create_tag(const unsigned char *object, const char *tag,
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]230 struct strbuf *buf, struct create_tag_options *opt,
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800[diff] [blame]231 unsigned char *prev, unsigned char *result)
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]232{
233 enum object_type type;
Pierre Habouzitfd17f5b2007-09-10 12:35:09 +0200[diff] [blame]234 char header_buf[1024];
235 int header_len;
Jeff King3927bbe2008-12-06 14:40:34 -0500[diff] [blame]236 char *path = NULL;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]237
238 type = sha1_object_info(object, NULL);
Carlos Ricae317cfa2007-07-21 14:13:12 +0200[diff] [blame]239 if (type <= OBJ_NONE)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]240 die(_("bad object type."));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]241
242 header_len = snprintf(header_buf, sizeof(header_buf),
243 "object %s\n"
244 "type %s\n"
245 "tag %s\n"
246 "tagger %s\n\n",
247 sha1_to_hex(object),
248 typename(type),
249 tag,
Jeff Kingf9bc5732012-05-24 19:28:40 -0400[diff] [blame]250 git_committer_info(IDENT_STRICT));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]251
Carlos Ricae317cfa2007-07-21 14:13:12 +0200[diff] [blame]252 if (header_len > sizeof(header_buf) - 1)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]253 die(_("tag header too big."));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]254
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]255 if (!opt->message_given) {
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]256 int fd;
257
258 /* write the template message before editing: */
Alex Riesena4f34cb2008-10-27 11:22:09 +0100[diff] [blame]259 path = git_pathdup("TAG_EDITMSG");
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]260 fd = open(path, O_CREAT | O_TRUNC | O_WRONLY, 0600);
261 if (fd < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]262 die_errno(_("could not create file '%s'"), path);
Mike Hommeybab81182007-11-04 01:11:14 +0100[diff] [blame]263
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100[diff] [blame]264 if (!is_null_sha1(prev)) {
Mike Hommeybab81182007-11-04 01:11:14 +0100[diff] [blame]265 write_tag_body(fd, prev);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100[diff] [blame]266 } else {
267 struct strbuf buf = STRBUF_INIT;
268 strbuf_addch(&buf, '\n');
269 if (opt->cleanup_mode == CLEANUP_ALL)
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200[diff] [blame]270 strbuf_commented_addf(&buf, _(tag_template), tag, comment_line_char);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100[diff] [blame]271 else
Thorsten Glaserd78f3402013-08-30 00:03:10 +0200[diff] [blame]272 strbuf_commented_addf(&buf, _(tag_template_nocleanup), tag, comment_line_char);
Junio C Hamanoeff80a92013-01-16 20:18:48 +0100[diff] [blame]273 write_or_die(fd, buf.buf, buf.len);
274 strbuf_release(&buf);
275 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]276 close(fd);
277
Stephan Beyer71982032008-07-25 18:28:42 +0200[diff] [blame]278 if (launch_editor(path, buf, NULL)) {
279 fprintf(stderr,
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]280 _("Please supply the message using either -m or -F option.\n"));
Stephan Beyer71982032008-07-25 18:28:42 +0200[diff] [blame]281 exit(1);
282 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]283 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]284
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]285 if (opt->cleanup_mode != CLEANUP_NONE)
Tobias Klauser63af4a82015-10-16 17:16:42 +0200[diff] [blame]286 strbuf_stripspace(buf, opt->cleanup_mode == CLEANUP_ALL);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]287
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]288 if (!opt->message_given && !buf->len)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]289 die(_("no tag message?"));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]290
Pierre Habouzitfd17f5b2007-09-10 12:35:09 +0200[diff] [blame]291 strbuf_insert(buf, 0, header_buf, header_len);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]292
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]293 if (build_tag_object(buf, opt->sign, result) < 0) {
Jeff King3927bbe2008-12-06 14:40:34 -0500[diff] [blame]294 if (path)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]295 fprintf(stderr, _("The tag message has been left in %s\n"),
Jeff King3927bbe2008-12-06 14:40:34 -0500[diff] [blame]296 path);
297 exit(128);
298 }
299 if (path) {
Alex Riesen691f1a22009-04-29 23:22:56 +0200[diff] [blame]300 unlink_or_warn(path);
Jeff King3927bbe2008-12-06 14:40:34 -0500[diff] [blame]301 free(path);
302 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]303}
304
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800[diff] [blame]305struct msg_arg {
306 int given;
307 struct strbuf buf;
308};
309
310static int parse_msg_arg(const struct option *opt, const char *arg, int unset)
311{
312 struct msg_arg *msg = opt->value;
313
314 if (!arg)
315 return -1;
316 if (msg->buf.len)
317 strbuf_addstr(&(msg->buf), "\n\n");
318 strbuf_addstr(&(msg->buf), arg);
319 msg->given = 1;
320 return 0;
321}
322
Michael Schubert4f0accd2011-05-10 01:36:36 +0200[diff] [blame]323static int strbuf_check_tag_ref(struct strbuf *sb, const char *name)
324{
325 if (name[0] == '-')
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200[diff] [blame]326 return -1;
Michael Schubert4f0accd2011-05-10 01:36:36 +0200[diff] [blame]327
328 strbuf_reset(sb);
329 strbuf_addf(sb, "refs/tags/%s", name);
330
Michael Haggerty8d9c5012011-09-15 23:10:25 +0200[diff] [blame]331 return check_refname_format(sb->buf, 0);
Michael Schubert4f0accd2011-05-10 01:36:36 +0200[diff] [blame]332}
333
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]334int cmd_tag(int argc, const char **argv, const char *prefix)
335{
Brandon Caseyf285a2d2008-10-09 14:12:12 -0500[diff] [blame]336 struct strbuf buf = STRBUF_INIT;
Michael Schubert4f0accd2011-05-10 01:36:36 +0200[diff] [blame]337 struct strbuf ref = STRBUF_INIT;
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]338 unsigned char object[20], prev[20];
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]339 const char *object_ref, *tag;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]340 struct create_tag_options opt;
341 char *cleanup_arg = NULL;
David Turner144c76f2015-07-21 17:04:55 -0400[diff] [blame]342 int create_reflog = 0;
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]343 int annotate = 0, force = 0;
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100[diff] [blame]344 int cmdmode = 0, create_tag_object = 0;
Junio C Hamanodbd0f5c2008-08-06 11:43:47 -0700[diff] [blame]345 const char *msgfile = NULL, *keyid = NULL;
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800[diff] [blame]346 struct msg_arg msg = { 0, STRBUF_INIT };
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700[diff] [blame]347 struct ref_transaction *transaction;
348 struct strbuf err = STRBUF_INIT;
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]349 struct ref_filter filter;
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]350 static struct ref_sorting *sorting = NULL, **sorting_tail = &sorting;
Karthik Nayakdf094742015-09-11 20:36:46 +0530[diff] [blame]351 const char *format = NULL;
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700[diff] [blame]352 int icase = 0;
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]353 struct option options[] = {
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700[diff] [blame]354 OPT_CMDMODE('l', "list", &cmdmode, N_("list tag names"), 'l'),
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]355 { OPTION_INTEGER, 'n', NULL, &filter.lines, N_("n"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700[diff] [blame]356 N_("print <n> lines of each tag message"),
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]357 PARSE_OPT_OPTARG, NULL, 1 },
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700[diff] [blame]358 OPT_CMDMODE('d', "delete", &cmdmode, N_("delete tags"), 'd'),
359 OPT_CMDMODE('v', "verify", &cmdmode, N_("verify tags"), 'v'),
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]360
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700[diff] [blame]361 OPT_GROUP(N_("Tag creation options")),
Stefan Bellerd5d09d42013-08-03 13:51:19 +0200[diff] [blame]362 OPT_BOOL('a', "annotate", &annotate,
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700[diff] [blame]363 N_("annotated tag, needs a message")),
364 OPT_CALLBACK('m', "message", &msg, N_("message"),
365 N_("tag message"), parse_msg_arg),
366 OPT_FILENAME('F', "file", &msgfile, N_("read message from file")),
Stefan Bellerd5d09d42013-08-03 13:51:19 +0200[diff] [blame]367 OPT_BOOL('s', "sign", &opt.sign, N_("annotated and GPG-signed tag")),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700[diff] [blame]368 OPT_STRING(0, "cleanup", &cleanup_arg, N_("mode"),
369 N_("how to strip spaces and #comments from message")),
Junio C Hamanoe703d712014-03-23 15:58:12 -0700[diff] [blame]370 OPT_STRING('u', "local-user", &keyid, N_("key-id"),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700[diff] [blame]371 N_("use another key to sign the tag")),
372 OPT__FORCE(&force, N_("replace the tag if exists")),
Ralf Thielow98c32bd2015-09-11 18:04:13 +0200[diff] [blame]373 OPT_BOOL(0, "create-reflog", &create_reflog, N_("create a reflog")),
Jeff Kingdd059c62015-03-12 14:15:09 -0400[diff] [blame]374
375 OPT_GROUP(N_("Tag listing options")),
Nguyễn Thái Ngọc Duyc88bba12012-08-20 19:32:47 +0700[diff] [blame]376 OPT_COLUMN(0, "column", &colopts, N_("show tag list in columns")),
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]377 OPT_CONTAINS(&filter.with_commit, N_("print only tags that contain the commit")),
378 OPT_WITH(&filter.with_commit, N_("print only tags that contain the commit")),
Karthik Nayak52428602015-09-10 21:52:49 +0530[diff] [blame]379 OPT_MERGED(&filter, N_("print only tags that are merged")),
380 OPT_NO_MERGED(&filter, N_("print only tags that are not merged")),
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]381 OPT_CALLBACK(0 , "sort", sorting_tail, N_("key"),
382 N_("field name to sort on"), &parse_opt_ref_sorting),
Nguyễn Thái Ngọc Duy9ef176b2014-02-27 19:56:52 +0700[diff] [blame]383 {
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]384 OPTION_CALLBACK, 0, "points-at", &filter.points_at, N_("object"),
Karthik Nayakb2172fd2015-07-07 21:36:08 +0530[diff] [blame]385 N_("print only tags of the object"), 0, parse_opt_object_name
Tom Grennanae7706b2012-02-08 15:03:43 -0800[diff] [blame]386 },
Karthik Nayakdf094742015-09-11 20:36:46 +0530[diff] [blame]387 OPT_STRING( 0 , "format", &format, N_("format"), N_("format to use for the output")),
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700[diff] [blame]388 OPT_BOOL('i', "ignore-case", &icase, N_("sorting and filtering are case insensitive")),
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]389 OPT_END()
390 };
391
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]392 git_config(git_tag_config, sorting_tail);
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]393
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]394 memset(&opt, 0, sizeof(opt));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]395 memset(&filter, 0, sizeof(filter));
396 filter.lines = -1;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]397
Stephen Boyd37782922009-05-23 11:53:12 -0700[diff] [blame]398 argc = parse_options(argc, argv, prefix, options, git_tag_usage, 0);
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]399
Linus Torvaldsbe15f502007-12-10 20:08:06 -0800[diff] [blame]400 if (keyid) {
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]401 opt.sign = 1;
Junio C Hamano2f47eae2011-09-07 21:19:47 -0700[diff] [blame]402 set_signing_key(keyid);
Linus Torvaldsbe15f502007-12-10 20:08:06 -0800[diff] [blame]403 }
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100[diff] [blame]404 create_tag_object = (opt.sign || annotate || msg.given || msgfile);
405
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700[diff] [blame]406 if (argc == 0 && !cmdmode)
407 cmdmode = 'l';
Junio C Hamanoc1a41b92007-11-25 15:21:42 -0800[diff] [blame]408
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100[diff] [blame]409 if ((create_tag_object || force) && (cmdmode != 0))
Samuel Tardieu6fa83422008-11-05 00:20:31 +0100[diff] [blame]410 usage_with_options(git_tag_usage, options);
411
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700[diff] [blame]412 finalize_colopts(&colopts, -1);
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]413 if (cmdmode == 'l' && filter.lines != -1) {
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700[diff] [blame]414 if (explicitly_enable_column(colopts))
415 die(_("--column and -n are incompatible"));
416 colopts = 0;
417 }
Karthik Nayakb7cc53e2015-09-11 20:36:16 +0530[diff] [blame]418 if (!sorting)
419 sorting = ref_default_sorting();
Nguyễn Thái Ngọc Duy3bb16a82016-12-04 09:52:25 +0700[diff] [blame]420 sorting->ignore_case = icase;
421 filter.ignore_case = icase;
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700[diff] [blame]422 if (cmdmode == 'l') {
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700[diff] [blame]423 int ret;
424 if (column_active(colopts)) {
425 struct column_options copts;
426 memset(&copts, 0, sizeof(copts));
427 copts.padding = 2;
428 run_column_filter(colopts, &copts);
429 }
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]430 filter.name_patterns = argv;
Karthik Nayakdf094742015-09-11 20:36:46 +0530[diff] [blame]431 ret = list_tags(&filter, sorting, format);
Nguyễn Thái Ngọc Duyd96e3c12012-04-13 17:54:41 +0700[diff] [blame]432 if (column_active(colopts))
433 stop_column_filter();
434 return ret;
435 }
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]436 if (filter.lines != -1)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]437 die(_("-n option is only allowed with -l."));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]438 if (filter.with_commit)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]439 die(_("--contains option is only allowed with -l."));
Karthik Nayakac4cc862015-09-10 21:18:27 +0530[diff] [blame]440 if (filter.points_at.nr)
Tom Grennanae7706b2012-02-08 15:03:43 -0800[diff] [blame]441 die(_("--points-at option is only allowed with -l."));
Karthik Nayak52428602015-09-10 21:52:49 +0530[diff] [blame]442 if (filter.merge_commit)
443 die(_("--merged and --no-merged option are only allowed with -l"));
Junio C Hamanoe6b722d2013-07-30 12:31:27 -0700[diff] [blame]444 if (cmdmode == 'd')
Lukas Puehringer07d347c2017-01-17 18:37:21 -0500[diff] [blame]445 return for_each_tag_name(argv, delete_tag, NULL);
446 if (cmdmode == 'v') {
447 if (format)
448 verify_ref_format(format);
449 return for_each_tag_name(argv, verify_tag, format);
450 }
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]451
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800[diff] [blame]452 if (msg.given || msgfile) {
453 if (msg.given && msgfile)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]454 die(_("only one -F or -m option is allowed."));
Junio C Hamanobd46c9a2007-11-22 23:16:51 -0800[diff] [blame]455 if (msg.given)
456 strbuf_addbuf(&buf, &(msg.buf));
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]457 else {
458 if (!strcmp(msgfile, "-")) {
Pierre Habouzit387e7e12007-09-27 15:25:55 +0200[diff] [blame]459 if (strbuf_read(&buf, 0, 1024) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]460 die_errno(_("cannot read '%s'"), msgfile);
Pierre Habouzit387e7e12007-09-27 15:25:55 +0200[diff] [blame]461 } else {
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]462 if (strbuf_read_file(&buf, msgfile, 1024) < 0)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]463 die_errno(_("could not open or read '%s'"),
Thomas Rastd824cbb2009-06-27 17:58:46 +0200[diff] [blame]464 msgfile);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]465 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]466 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]467 }
468
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]469 tag = argv[0];
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]470
Carlos Rica39686582007-11-09 14:42:56 +0100[diff] [blame]471 object_ref = argc == 2 ? argv[1] : "HEAD";
472 if (argc > 2)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]473 die(_("too many params"));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]474
475 if (get_sha1(object_ref, object))
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]476 die(_("Failed to resolve '%s' as a valid ref."), object_ref);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]477
Michael Schubert4f0accd2011-05-10 01:36:36 +0200[diff] [blame]478 if (strbuf_check_tag_ref(&ref, tag))
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]479 die(_("'%s' is not a valid tag name."), tag);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]480
Nguyễn Thái Ngọc Duyc6893322011-11-13 17:22:14 +0700[diff] [blame]481 if (read_ref(ref.buf, prev))
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]482 hashclr(prev);
483 else if (!force)
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]484 die(_("tag '%s' already exists"), tag);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]485
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]486 opt.message_given = msg.given || msgfile;
487
488 if (!cleanup_arg || !strcmp(cleanup_arg, "strip"))
489 opt.cleanup_mode = CLEANUP_ALL;
490 else if (!strcmp(cleanup_arg, "verbatim"))
491 opt.cleanup_mode = CLEANUP_NONE;
492 else if (!strcmp(cleanup_arg, "whitespace"))
493 opt.cleanup_mode = CLEANUP_SPACE;
494 else
495 die(_("Invalid cleanup mode %s"), cleanup_arg);
496
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100[diff] [blame]497 if (create_tag_object) {
498 if (force_sign_annotate && !annotate)
499 opt.sign = 1;
Kirill A. Shutemovd3e05982011-12-07 05:01:45 +0200[diff] [blame]500 create_tag(object, tag, &buf, &opt, prev, object);
Laurent Arnoud61c2fe02016-03-22 21:41:26 +0100[diff] [blame]501 }
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]502
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700[diff] [blame]503 transaction = ref_transaction_begin(&err);
504 if (!transaction ||
505 ref_transaction_update(transaction, ref.buf, object, prev,
David Turner144c76f2015-07-21 17:04:55 -0400[diff] [blame]506 create_reflog ? REF_FORCE_CREATE_REFLOG : 0,
507 NULL, &err) ||
Ronnie Sahlbergdb7516a2014-04-30 12:22:42 -0700[diff] [blame]508 ref_transaction_commit(transaction, &err))
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700[diff] [blame]509 die("%s", err.buf);
510 ref_transaction_free(transaction);
Phil Hord3ae851e2013-03-12 19:13:41 -0400[diff] [blame]511 if (force && !is_null_sha1(prev) && hashcmp(prev, object))
Ævar Arnfjörð Bjarmasond08ebf92011-02-22 23:42:09 +0000[diff] [blame]512 printf(_("Updated tag '%s' (was %s)\n"), tag, find_unique_abbrev(prev, DEFAULT_ABBREV));
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]513
Ronnie Sahlberge5074bf2014-04-16 15:30:41 -0700[diff] [blame]514 strbuf_release(&err);
Pierre Habouzitfd17f5b2007-09-10 12:35:09 +0200[diff] [blame]515 strbuf_release(&buf);
Michael Schubert4f0accd2011-05-10 01:36:36 +0200[diff] [blame]516 strbuf_release(&ref);
Carlos Rica62e09ce2007-07-20 01:42:28 +0200[diff] [blame]517 return 0;
518}