]> git.ipfire.org Git - thirdparty/git.git/blobdiff - branch.c
Merge branch 'gc/branch-recurse-submodules'
[thirdparty/git.git] / branch.c
index 5d20a2e8484b22f321a60e01d63cb4c4bd8e88fe..6b31df539a5f72e07bc5efb4592f703ddd70d28c 100644 (file)
--- a/branch.c
+++ b/branch.c
@@ -8,6 +8,8 @@
 #include "sequencer.h"
 #include "commit.h"
 #include "worktree.h"
+#include "submodule-config.h"
+#include "run-command.h"
 
 struct tracking {
        struct refspec_item spec;
@@ -218,9 +220,11 @@ static int inherit_tracking(struct tracking *tracking, const char *orig_ref)
 }
 
 /*
- * This is called when new_ref is branched off of orig_ref, and tries
- * to infer the settings for branch.<new_ref>.{remote,merge} from the
- * config.
+ * Used internally to set the branch.<new_ref>.{remote,merge} config
+ * settings so that branch 'new_ref' tracks 'orig_ref'. Unlike
+ * dwim_and_setup_tracking(), this does not do DWIM, i.e. "origin/main"
+ * will not be expanded to "refs/remotes/origin/main", so it is not safe
+ * for 'orig_ref' to be raw user input.
  */
 static void setup_tracking(const char *new_ref, const char *orig_ref,
                           enum branch_track track, int quiet)
@@ -235,7 +239,7 @@ static void setup_tracking(const char *new_ref, const char *orig_ref,
        if (track != BRANCH_TRACK_INHERIT)
                for_each_remote(find_tracked_branch, &tracking);
        else if (inherit_tracking(&tracking, orig_ref))
-               return;
+               goto cleanup;
 
        if (!tracking.matches)
                switch (track) {
@@ -245,7 +249,7 @@ static void setup_tracking(const char *new_ref, const char *orig_ref,
                case BRANCH_TRACK_INHERIT:
                        break;
                default:
-                       return;
+                       goto cleanup;
                }
 
        if (tracking.matches > 1)
@@ -258,7 +262,8 @@ static void setup_tracking(const char *new_ref, const char *orig_ref,
                                tracking.remote, tracking.srcs) < 0)
                exit(-1);
 
-       string_list_clear(tracking.srcs, 0);
+cleanup:
+       string_list_clear(&tracking_srcs, 0);
 }
 
 int read_branch_desc(struct strbuf *buf, const char *branch_name)
@@ -346,31 +351,37 @@ N_("\n"
 "will track its remote counterpart, you may want to use\n"
 "\"git push -u\" to set the upstream config as you push.");
 
-void create_branch(struct repository *r,
-                  const char *name, const char *start_name,
-                  int force, int clobber_head_ok, int reflog,
-                  int quiet, enum branch_track track)
+/**
+ * DWIMs a user-provided ref to determine the starting point for a
+ * branch and validates it, where:
+ *
+ *   - r is the repository to validate the branch for
+ *
+ *   - start_name is the ref that we would like to test. This is
+ *     expanded with DWIM and assigned to out_real_ref.
+ *
+ *   - track is the tracking mode of the new branch. If tracking is
+ *     explicitly requested, start_name must be a branch (because
+ *     otherwise start_name cannot be tracked)
+ *
+ *   - out_oid is an out parameter containing the object_id of start_name
+ *
+ *   - out_real_ref is an out parameter containing the full, 'real' form
+ *     of start_name e.g. refs/heads/main instead of main
+ *
+ */
+static void dwim_branch_start(struct repository *r, const char *start_name,
+                          enum branch_track track, char **out_real_ref,
+                          struct object_id *out_oid)
 {
        struct commit *commit;
        struct object_id oid;
        char *real_ref;
-       struct strbuf ref = STRBUF_INIT;
-       int forcing = 0;
-       int dont_change_ref = 0;
        int explicit_tracking = 0;
 
        if (track == BRANCH_TRACK_EXPLICIT || track == BRANCH_TRACK_OVERRIDE)
                explicit_tracking = 1;
 
-       if ((track == BRANCH_TRACK_OVERRIDE || clobber_head_ok)
-           ? validate_branchname(name, &ref)
-           : validate_new_branchname(name, &ref, force)) {
-               if (!force)
-                       dont_change_ref = 1;
-               else
-                       forcing = 1;
-       }
-
        real_ref = NULL;
        if (get_oid_mb(start_name, &oid)) {
                if (explicit_tracking) {
@@ -407,40 +418,218 @@ void create_branch(struct repository *r,
 
        if ((commit = lookup_commit_reference(r, &oid)) == NULL)
                die(_("not a valid branch point: '%s'"), start_name);
-       oidcpy(&oid, &commit->object.oid);
+       if (out_real_ref) {
+               *out_real_ref = real_ref;
+               real_ref = NULL;
+       }
+       if (out_oid)
+               oidcpy(out_oid, &commit->object.oid);
+
+       FREE_AND_NULL(real_ref);
+}
+
+void create_branch(struct repository *r,
+                  const char *name, const char *start_name,
+                  int force, int clobber_head_ok, int reflog,
+                  int quiet, enum branch_track track, int dry_run)
+{
+       struct object_id oid;
+       char *real_ref;
+       struct strbuf ref = STRBUF_INIT;
+       int forcing = 0;
+       struct ref_transaction *transaction;
+       struct strbuf err = STRBUF_INIT;
+       char *msg;
+
+       if (track == BRANCH_TRACK_OVERRIDE)
+               BUG("'track' cannot be BRANCH_TRACK_OVERRIDE. Did you mean to call dwim_and_setup_tracking()?");
+       if (clobber_head_ok && !force)
+               BUG("'clobber_head_ok' can only be used with 'force'");
+
+       if (clobber_head_ok ?
+                         validate_branchname(name, &ref) :
+                         validate_new_branchname(name, &ref, force)) {
+               forcing = 1;
+       }
+
+       dwim_branch_start(r, start_name, track, &real_ref, &oid);
+       if (dry_run)
+               goto cleanup;
 
        if (reflog)
                log_all_ref_updates = LOG_REFS_NORMAL;
 
-       if (!dont_change_ref) {
-               struct ref_transaction *transaction;
-               struct strbuf err = STRBUF_INIT;
-               char *msg;
-
-               if (forcing)
-                       msg = xstrfmt("branch: Reset to %s", start_name);
-               else
-                       msg = xstrfmt("branch: Created from %s", start_name);
-
-               transaction = ref_transaction_begin(&err);
-               if (!transaction ||
-                   ref_transaction_update(transaction, ref.buf,
-                                          &oid, forcing ? NULL : null_oid(),
-                                          0, msg, &err) ||
-                   ref_transaction_commit(transaction, &err))
-                       die("%s", err.buf);
-               ref_transaction_free(transaction);
-               strbuf_release(&err);
-               free(msg);
-       }
+       if (forcing)
+               msg = xstrfmt("branch: Reset to %s", start_name);
+       else
+               msg = xstrfmt("branch: Created from %s", start_name);
+       transaction = ref_transaction_begin(&err);
+       if (!transaction ||
+               ref_transaction_update(transaction, ref.buf,
+                                       &oid, forcing ? NULL : null_oid(),
+                                       0, msg, &err) ||
+               ref_transaction_commit(transaction, &err))
+               die("%s", err.buf);
+       ref_transaction_free(transaction);
+       strbuf_release(&err);
+       free(msg);
 
        if (real_ref && track)
                setup_tracking(ref.buf + 11, real_ref, track, quiet);
 
+cleanup:
        strbuf_release(&ref);
        free(real_ref);
 }
 
+void dwim_and_setup_tracking(struct repository *r, const char *new_ref,
+                            const char *orig_ref, enum branch_track track,
+                            int quiet)
+{
+       char *real_orig_ref;
+       dwim_branch_start(r, orig_ref, track, &real_orig_ref, NULL);
+       setup_tracking(new_ref, real_orig_ref, track, quiet);
+}
+
+/**
+ * Creates a branch in a submodule by calling
+ * create_branches_recursively() in a child process. The child process
+ * is necessary because install_branch_config_multiple_remotes() (which
+ * is called by setup_tracking()) does not support writing configs to
+ * submodules.
+ */
+static int submodule_create_branch(struct repository *r,
+                                  const struct submodule *submodule,
+                                  const char *name, const char *start_oid,
+                                  const char *tracking_name, int force,
+                                  int reflog, int quiet,
+                                  enum branch_track track, int dry_run)
+{
+       int ret = 0;
+       struct child_process child = CHILD_PROCESS_INIT;
+       struct strbuf child_err = STRBUF_INIT;
+       struct strbuf out_buf = STRBUF_INIT;
+       char *out_prefix = xstrfmt("submodule '%s': ", submodule->name);
+       child.git_cmd = 1;
+       child.err = -1;
+       child.stdout_to_stderr = 1;
+
+       prepare_other_repo_env(&child.env_array, r->gitdir);
+       /*
+        * submodule_create_branch() is indirectly invoked by "git
+        * branch", but we cannot invoke "git branch" in the child
+        * process. "git branch" accepts a branch name and start point,
+        * where the start point is assumed to provide both the OID
+        * (start_oid) and the branch to use for tracking
+        * (tracking_name). But when recursing through submodules,
+        * start_oid and tracking name need to be specified separately
+        * (see create_branches_recursively()).
+        */
+       strvec_pushl(&child.args, "submodule--helper", "create-branch", NULL);
+       if (dry_run)
+               strvec_push(&child.args, "--dry-run");
+       if (force)
+               strvec_push(&child.args, "--force");
+       if (quiet)
+               strvec_push(&child.args, "--quiet");
+       if (reflog)
+               strvec_push(&child.args, "--create-reflog");
+       if (track == BRANCH_TRACK_ALWAYS || track == BRANCH_TRACK_EXPLICIT)
+               strvec_push(&child.args, "--track");
+
+       strvec_pushl(&child.args, name, start_oid, tracking_name, NULL);
+
+       if ((ret = start_command(&child)))
+               return ret;
+       ret = finish_command(&child);
+       strbuf_read(&child_err, child.err, 0);
+       strbuf_add_lines(&out_buf, out_prefix, child_err.buf, child_err.len);
+
+       if (ret)
+               fprintf(stderr, "%s", out_buf.buf);
+       else
+               printf("%s", out_buf.buf);
+
+       strbuf_release(&child_err);
+       strbuf_release(&out_buf);
+       return ret;
+}
+
+void create_branches_recursively(struct repository *r, const char *name,
+                                const char *start_commitish,
+                                const char *tracking_name, int force,
+                                int reflog, int quiet, enum branch_track track,
+                                int dry_run)
+{
+       int i = 0;
+       char *branch_point = NULL;
+       struct object_id super_oid;
+       struct submodule_entry_list submodule_entry_list;
+
+       /* Perform dwim on start_commitish to get super_oid and branch_point. */
+       dwim_branch_start(r, start_commitish, BRANCH_TRACK_NEVER,
+                         &branch_point, &super_oid);
+
+       /*
+        * If we were not given an explicit name to track, then assume we are at
+        * the top level and, just like the non-recursive case, the tracking
+        * name is the branch point.
+        */
+       if (!tracking_name)
+               tracking_name = branch_point;
+
+       submodules_of_tree(r, &super_oid, &submodule_entry_list);
+       /*
+        * Before creating any branches, first check that the branch can
+        * be created in every submodule.
+        */
+       for (i = 0; i < submodule_entry_list.entry_nr; i++) {
+               if (submodule_entry_list.entries[i].repo == NULL) {
+                       if (advice_enabled(ADVICE_SUBMODULES_NOT_UPDATED))
+                               advise(_("You may try updating the submodules using 'git checkout %s && git submodule update --init'"),
+                                      start_commitish);
+                       die(_("submodule '%s': unable to find submodule"),
+                           submodule_entry_list.entries[i].submodule->name);
+               }
+
+               if (submodule_create_branch(
+                           submodule_entry_list.entries[i].repo,
+                           submodule_entry_list.entries[i].submodule, name,
+                           oid_to_hex(&submodule_entry_list.entries[i]
+                                               .name_entry->oid),
+                           tracking_name, force, reflog, quiet, track, 1))
+                       die(_("submodule '%s': cannot create branch '%s'"),
+                           submodule_entry_list.entries[i].submodule->name,
+                           name);
+       }
+
+       create_branch(the_repository, name, start_commitish, force, 0, reflog, quiet,
+                     BRANCH_TRACK_NEVER, dry_run);
+       if (dry_run)
+               return;
+       /*
+        * NEEDSWORK If tracking was set up in the superproject but not the
+        * submodule, users might expect "git branch --recurse-submodules" to
+        * fail or give a warning, but this is not yet implemented because it is
+        * tedious to determine whether or not tracking was set up in the
+        * superproject.
+        */
+       setup_tracking(name, tracking_name, track, quiet);
+
+       for (i = 0; i < submodule_entry_list.entry_nr; i++) {
+               if (submodule_create_branch(
+                           submodule_entry_list.entries[i].repo,
+                           submodule_entry_list.entries[i].submodule, name,
+                           oid_to_hex(&submodule_entry_list.entries[i]
+                                               .name_entry->oid),
+                           tracking_name, force, reflog, quiet, track, 0))
+                       die(_("submodule '%s': cannot create branch '%s'"),
+                           submodule_entry_list.entries[i].submodule->name,
+                           name);
+               repo_clear(submodule_entry_list.entries[i].repo);
+       }
+}
+
 void remove_merge_branch_state(struct repository *r)
 {
        unlink(git_path_merge_head(r));