stash: remove now superfluos help for "stash push"
[git.git] / branch.c
blob4377ce2fb17d7467ee92d4db02cb4859f6397505
1 #include "git-compat-util.h"
2 #include "cache.h"
3 #include "config.h"
4 #include "branch.h"
5 #include "refs.h"
6 #include "remote.h"
7 #include "commit.h"
8 #include "worktree.h"
10 struct tracking {
11 struct refspec spec;
12 char *src;
13 const char *remote;
14 int matches;
17 static int find_tracked_branch(struct remote *remote, void *priv)
19 struct tracking *tracking = priv;
21 if (!remote_find_tracking(remote, &tracking->spec)) {
22 if (++tracking->matches == 1) {
23 tracking->src = tracking->spec.src;
24 tracking->remote = remote->name;
25 } else {
26 free(tracking->spec.src);
27 if (tracking->src) {
28 FREE_AND_NULL(tracking->src);
31 tracking->spec.src = NULL;
34 return 0;
37 static int should_setup_rebase(const char *origin)
39 switch (autorebase) {
40 case AUTOREBASE_NEVER:
41 return 0;
42 case AUTOREBASE_LOCAL:
43 return origin == NULL;
44 case AUTOREBASE_REMOTE:
45 return origin != NULL;
46 case AUTOREBASE_ALWAYS:
47 return 1;
49 return 0;
52 static const char tracking_advice[] =
53 N_("\n"
54 "After fixing the error cause you may try to fix up\n"
55 "the remote tracking information by invoking\n"
56 "\"git branch --set-upstream-to=%s%s%s\".");
58 int install_branch_config(int flag, const char *local, const char *origin, const char *remote)
60 const char *shortname = NULL;
61 struct strbuf key = STRBUF_INIT;
62 int rebasing = should_setup_rebase(origin);
64 if (skip_prefix(remote, "refs/heads/", &shortname)
65 && !strcmp(local, shortname)
66 && !origin) {
67 warning(_("Not setting branch %s as its own upstream."),
68 local);
69 return 0;
72 strbuf_addf(&key, "branch.%s.remote", local);
73 if (git_config_set_gently(key.buf, origin ? origin : ".") < 0)
74 goto out_err;
76 strbuf_reset(&key);
77 strbuf_addf(&key, "branch.%s.merge", local);
78 if (git_config_set_gently(key.buf, remote) < 0)
79 goto out_err;
81 if (rebasing) {
82 strbuf_reset(&key);
83 strbuf_addf(&key, "branch.%s.rebase", local);
84 if (git_config_set_gently(key.buf, "true") < 0)
85 goto out_err;
87 strbuf_release(&key);
89 if (flag & BRANCH_CONFIG_VERBOSE) {
90 if (shortname) {
91 if (origin)
92 printf_ln(rebasing ?
93 _("Branch '%s' set up to track remote branch '%s' from '%s' by rebasing.") :
94 _("Branch '%s' set up to track remote branch '%s' from '%s'."),
95 local, shortname, origin);
96 else
97 printf_ln(rebasing ?
98 _("Branch '%s' set up to track local branch '%s' by rebasing.") :
99 _("Branch '%s' set up to track local branch '%s'."),
100 local, shortname);
101 } else {
102 if (origin)
103 printf_ln(rebasing ?
104 _("Branch '%s' set up to track remote ref '%s' by rebasing.") :
105 _("Branch '%s' set up to track remote ref '%s'."),
106 local, remote);
107 else
108 printf_ln(rebasing ?
109 _("Branch '%s' set up to track local ref '%s' by rebasing.") :
110 _("Branch '%s' set up to track local ref '%s'."),
111 local, remote);
115 return 0;
117 out_err:
118 strbuf_release(&key);
119 error(_("Unable to write upstream branch configuration"));
121 advise(_(tracking_advice),
122 origin ? origin : "",
123 origin ? "/" : "",
124 shortname ? shortname : remote);
126 return -1;
130 * This is called when new_ref is branched off of orig_ref, and tries
131 * to infer the settings for branch.<new_ref>.{remote,merge} from the
132 * config.
134 static void setup_tracking(const char *new_ref, const char *orig_ref,
135 enum branch_track track, int quiet)
137 struct tracking tracking;
138 int config_flags = quiet ? 0 : BRANCH_CONFIG_VERBOSE;
140 memset(&tracking, 0, sizeof(tracking));
141 tracking.spec.dst = (char *)orig_ref;
142 if (for_each_remote(find_tracked_branch, &tracking))
143 return;
145 if (!tracking.matches)
146 switch (track) {
147 case BRANCH_TRACK_ALWAYS:
148 case BRANCH_TRACK_EXPLICIT:
149 case BRANCH_TRACK_OVERRIDE:
150 break;
151 default:
152 return;
155 if (tracking.matches > 1)
156 die(_("Not tracking: ambiguous information for ref %s"),
157 orig_ref);
159 if (install_branch_config(config_flags, new_ref, tracking.remote,
160 tracking.src ? tracking.src : orig_ref) < 0)
161 exit(-1);
163 free(tracking.src);
166 int read_branch_desc(struct strbuf *buf, const char *branch_name)
168 char *v = NULL;
169 struct strbuf name = STRBUF_INIT;
170 strbuf_addf(&name, "branch.%s.description", branch_name);
171 if (git_config_get_string(name.buf, &v)) {
172 strbuf_release(&name);
173 return -1;
175 strbuf_addstr(buf, v);
176 free(v);
177 strbuf_release(&name);
178 return 0;
181 int validate_new_branchname(const char *name, struct strbuf *ref,
182 int force, int attr_only)
184 if (strbuf_check_branch_ref(ref, name))
185 die(_("'%s' is not a valid branch name."), name);
187 if (!ref_exists(ref->buf))
188 return 0;
189 else if (!force && !attr_only)
190 die(_("A branch named '%s' already exists."), ref->buf + strlen("refs/heads/"));
192 if (!attr_only) {
193 const char *head;
195 head = resolve_ref_unsafe("HEAD", 0, NULL, NULL);
196 if (!is_bare_repository() && head && !strcmp(head, ref->buf))
197 die(_("Cannot force update the current branch."));
199 return 1;
202 static int check_tracking_branch(struct remote *remote, void *cb_data)
204 char *tracking_branch = cb_data;
205 struct refspec query;
206 memset(&query, 0, sizeof(struct refspec));
207 query.dst = tracking_branch;
208 return !remote_find_tracking(remote, &query);
211 static int validate_remote_tracking_branch(char *ref)
213 return !for_each_remote(check_tracking_branch, ref);
216 static const char upstream_not_branch[] =
217 N_("Cannot setup tracking information; starting point '%s' is not a branch.");
218 static const char upstream_missing[] =
219 N_("the requested upstream branch '%s' does not exist");
220 static const char upstream_advice[] =
221 N_("\n"
222 "If you are planning on basing your work on an upstream\n"
223 "branch that already exists at the remote, you may need to\n"
224 "run \"git fetch\" to retrieve it.\n"
225 "\n"
226 "If you are planning to push out a new local branch that\n"
227 "will track its remote counterpart, you may want to use\n"
228 "\"git push -u\" to set the upstream config as you push.");
230 void create_branch(const char *name, const char *start_name,
231 int force, int reflog, int clobber_head,
232 int quiet, enum branch_track track)
234 struct commit *commit;
235 struct object_id oid;
236 char *real_ref;
237 struct strbuf ref = STRBUF_INIT;
238 int forcing = 0;
239 int dont_change_ref = 0;
240 int explicit_tracking = 0;
242 if (track == BRANCH_TRACK_EXPLICIT || track == BRANCH_TRACK_OVERRIDE)
243 explicit_tracking = 1;
245 if (validate_new_branchname(name, &ref, force,
246 track == BRANCH_TRACK_OVERRIDE ||
247 clobber_head)) {
248 if (!force)
249 dont_change_ref = 1;
250 else
251 forcing = 1;
254 real_ref = NULL;
255 if (get_oid(start_name, &oid)) {
256 if (explicit_tracking) {
257 if (advice_set_upstream_failure) {
258 error(_(upstream_missing), start_name);
259 advise(_(upstream_advice));
260 exit(1);
262 die(_(upstream_missing), start_name);
264 die(_("Not a valid object name: '%s'."), start_name);
267 switch (dwim_ref(start_name, strlen(start_name), oid.hash, &real_ref)) {
268 case 0:
269 /* Not branching from any existing branch */
270 if (explicit_tracking)
271 die(_(upstream_not_branch), start_name);
272 break;
273 case 1:
274 /* Unique completion -- good, only if it is a real branch */
275 if (!starts_with(real_ref, "refs/heads/") &&
276 validate_remote_tracking_branch(real_ref)) {
277 if (explicit_tracking)
278 die(_(upstream_not_branch), start_name);
279 else
280 real_ref = NULL;
282 break;
283 default:
284 die(_("Ambiguous object name: '%s'."), start_name);
285 break;
288 if ((commit = lookup_commit_reference(&oid)) == NULL)
289 die(_("Not a valid branch point: '%s'."), start_name);
290 oidcpy(&oid, &commit->object.oid);
292 if (reflog)
293 log_all_ref_updates = LOG_REFS_NORMAL;
295 if (!dont_change_ref) {
296 struct ref_transaction *transaction;
297 struct strbuf err = STRBUF_INIT;
298 char *msg;
300 if (forcing)
301 msg = xstrfmt("branch: Reset to %s", start_name);
302 else
303 msg = xstrfmt("branch: Created from %s", start_name);
305 transaction = ref_transaction_begin(&err);
306 if (!transaction ||
307 ref_transaction_update(transaction, ref.buf,
308 oid.hash, forcing ? NULL : null_sha1,
309 0, msg, &err) ||
310 ref_transaction_commit(transaction, &err))
311 die("%s", err.buf);
312 ref_transaction_free(transaction);
313 strbuf_release(&err);
314 free(msg);
317 if (real_ref && track)
318 setup_tracking(ref.buf + 11, real_ref, track, quiet);
320 strbuf_release(&ref);
321 free(real_ref);
324 void remove_branch_state(void)
326 unlink(git_path_cherry_pick_head());
327 unlink(git_path_revert_head());
328 unlink(git_path_merge_head());
329 unlink(git_path_merge_rr());
330 unlink(git_path_merge_msg());
331 unlink(git_path_merge_mode());
332 unlink(git_path_squash_msg());
335 void die_if_checked_out(const char *branch, int ignore_current_worktree)
337 const struct worktree *wt;
339 wt = find_shared_symref("HEAD", branch);
340 if (!wt || (ignore_current_worktree && wt->is_current))
341 return;
342 skip_prefix(branch, "refs/heads/", &branch);
343 die(_("'%s' is already checked out at '%s'"),
344 branch, wt->path);
347 int replace_each_worktree_head_symref(const char *oldref, const char *newref,
348 const char *logmsg)
350 int ret = 0;
351 struct worktree **worktrees = get_worktrees(0);
352 int i;
354 for (i = 0; worktrees[i]; i++) {
355 struct ref_store *refs;
357 if (worktrees[i]->is_detached)
358 continue;
359 if (!worktrees[i]->head_ref)
360 continue;
361 if (strcmp(oldref, worktrees[i]->head_ref))
362 continue;
364 refs = get_worktree_ref_store(worktrees[i]);
365 if (refs_create_symref(refs, "HEAD", newref, logmsg))
366 ret = error(_("HEAD of working tree %s is not updated"),
367 worktrees[i]->path);
370 free_worktrees(worktrees);
371 return ret;