--- v8
+++ v1
@@ -1,210 +1,87 @@
-This commit is preparation for a future commit that will simplify
-create_branch() so that it always creates a branch. This will allow
-create_branch() to accept a dry_run parameter (which is needed for "git
-branch --recurse-submodules").
+As we introduce a submodule UX with branches, we would like to be able
+to get the submodule commit ids in a superproject tree because those ids
+are the source of truth e.g. "git branch --recurse-submodules topic
+start-point" should create branches based off the commit ids recorded in
+the superproject's 'start-point' tree.
-create_branch() used to always create a branch, but 4fc5006676 (Add
-branch --set-upstream, 2010-01-18) changed it to also be able to set
-tracking information without creating a branch.
+To make this easy, introduce a submodules_of_tree() helper function that
+iterates through a tree and returns the tree's gitlink entries as a
+list.
-Refactor the code that sets tracking information into its own functions
-dwim_branch_start() and dwim_and_setup_tracking(). Also change an
-invocation of create_branch() in cmd_branch() in builtin/branch.c to use
-dwim_and_setup_tracking(), since that invocation is only for setting
-tracking information (in "git branch --set-upstream-to").
-
-As of this commit, create_branch() is no longer invoked in a way that
-does not create branches.
-
-Helped-by: Jonathan Tan <jonathantanmy@google.com>
Signed-off-by: Glen Choo <chooglen@google.com>
---
- branch.c | 87 +++++++++++++++++++++++++++++++++++++-----------
- branch.h | 22 ++++++++++++
- builtin/branch.c | 9 ++---
- 3 files changed, 92 insertions(+), 26 deletions(-)
+ submodule-config.c | 19 +++++++++++++++++++
+ submodule-config.h | 13 +++++++++++++
+ 2 files changed, 32 insertions(+)
-diff --git a/branch.c b/branch.c
-index a4e4631ef1..f3a31930fb 100644
---- a/branch.c
-+++ b/branch.c
-@@ -218,9 +218,11 @@ static int inherit_tracking(struct tracking *tracking, const char *orig_ref)
+diff --git a/submodule-config.c b/submodule-config.c
+index f95344028b..97da373301 100644
+--- a/submodule-config.c
++++ b/submodule-config.c
+@@ -7,6 +7,7 @@
+ #include "strbuf.h"
+ #include "object-store.h"
+ #include "parse-options.h"
++#include "tree-walk.h"
+
+ /*
+ * submodule cache lookup structure
+@@ -726,6 +727,24 @@ const struct submodule *submodule_from_path(struct repository *r,
+ return config_from(r->submodule_cache, treeish_name, path, lookup_path);
}
- /*
-- * 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)
-@@ -341,31 +343,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) {
-@@ -402,7 +410,37 @@ 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;
++struct submodule_entry_list *
++submodules_of_tree(struct repository *r, const struct object_id *treeish_name)
++{
++ struct tree_desc tree;
++ struct name_entry entry;
++ struct submodule_entry_list *ret;
++
++ CALLOC_ARRAY(ret, 1);
++ fill_tree_descriptor(r, &tree, treeish_name);
++ while (tree_entry(&tree, &entry)) {
++ if (!S_ISGITLINK(entry.mode))
++ continue;
++ ALLOC_GROW(ret->name_entries, ret->entry_nr + 1, ret->entry_alloc);
++ ret->name_entries[ret->entry_nr++] = entry;
+ }
-+ if (out_oid)
-+ oidcpy(out_oid, &commit->object.oid);
-+
-+ FREE_AND_NULL(real_ref);
++ return ret;
+}
+
-+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)
-+{
-+ struct object_id oid;
-+ char *real_ref;
-+ struct strbuf ref = STRBUF_INIT;
-+ int forcing = 0;
-+ int dont_change_ref = 0;
+ void submodule_free(struct repository *r)
+ {
+ if (r->submodule_cache)
+diff --git a/submodule-config.h b/submodule-config.h
+index 65875b94ea..4379ec77e3 100644
+--- a/submodule-config.h
++++ b/submodule-config.h
+@@ -6,6 +6,7 @@
+ #include "hashmap.h"
+ #include "submodule.h"
+ #include "strbuf.h"
++#include "tree-walk.h"
+
+ /**
+ * The submodule config cache API allows to read submodule
+@@ -67,6 +68,18 @@ const struct submodule *submodule_from_name(struct repository *r,
+ const struct object_id *commit_or_tree,
+ const char *name);
+
++struct submodule_entry_list {
++ struct name_entry *name_entries;
++ int entry_nr;
++ int entry_alloc;
++};
+
-+ 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;
-+ }
++/**
++ * Given a tree-ish, return all submodules in the tree.
++ */
++struct submodule_entry_list *
++submodules_of_tree(struct repository *r, const struct object_id *treeish_name);
+
-+ dwim_branch_start(r, start_name, track, &real_ref, &oid);
-
- if (reflog)
- log_all_ref_updates = LOG_REFS_NORMAL;
-@@ -436,6 +474,15 @@ void create_branch(struct repository *r,
- 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);
-+}
-+
- void remove_merge_branch_state(struct repository *r)
- {
- unlink(git_path_merge_head(r));
-diff --git a/branch.h b/branch.h
-index 815dcd40c0..ab2315c611 100644
---- a/branch.h
-+++ b/branch.h
-@@ -18,6 +18,28 @@ extern enum branch_track git_branch_track;
-
- /* Functions for acting on the information about branches. */
-
-+/**
-+ * Sets branch.<new_ref>.{remote,merge} config settings such that
-+ * new_ref tracks orig_ref according to the specified tracking mode.
-+ *
-+ * - new_ref is the name of the branch that we are setting tracking
-+ * for.
-+ *
-+ * - orig_ref is the name of the ref that is 'upstream' of new_ref.
-+ * orig_ref will be expanded with DWIM so that the config settings
-+ * are in the correct format e.g. "refs/remotes/origin/main" instead
-+ * of "origin/main".
-+ *
-+ * - track is the tracking mode e.g. BRANCH_TRACK_REMOTE causes
-+ * new_ref to track orig_ref directly, whereas BRANCH_TRACK_INHERIT
-+ * causes new_ref to track whatever orig_ref tracks.
-+ *
-+ * - quiet suppresses tracking information.
-+ */
-+void dwim_and_setup_tracking(struct repository *r, const char *new_ref,
-+ const char *orig_ref, enum branch_track track,
-+ int quiet);
-+
- /*
- * Creates a new branch, where:
- *
-diff --git a/builtin/branch.c b/builtin/branch.c
-index c5de1207e4..62b1a70b05 100644
---- a/builtin/branch.c
-+++ b/builtin/branch.c
-@@ -822,12 +822,9 @@ int cmd_branch(int argc, const char **argv, const char *prefix)
- if (!ref_exists(branch->refname))
- die(_("branch '%s' does not exist"), branch->name);
-
-- /*
-- * create_branch takes care of setting up the tracking
-- * info and making sure new_upstream is correct
-- */
-- create_branch(the_repository, branch->name, new_upstream,
-- 0, 0, 0, quiet, BRANCH_TRACK_OVERRIDE);
-+ dwim_and_setup_tracking(the_repository, branch->name,
-+ new_upstream, BRANCH_TRACK_OVERRIDE,
-+ quiet);
- } else if (unset_upstream) {
- struct branch *branch = branch_get(argv[0]);
- struct strbuf buf = STRBUF_INIT;
+ /**
+ * Given a tree-ish in the superproject and a path, return the submodule that
+ * is bound at the path in the named tree.
--
2.33.GIT