summaryrefslogtreecommitdiff
path: root/branch.h
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-10-13 04:45:40 (GMT)
committerJunio C Hamano <gitster@pobox.com>2017-10-13 08:11:41 (GMT)
commitbc1c9c0e674bdd293c29ae84365915848ed01d7a (patch)
treeddde1bceda59ec50837294f152d49834aa9d6bdd /branch.h
parent8280c4c1ea59bc6d101c5616490627b63934318e (diff)
downloadgit-bc1c9c0e674bdd293c29ae84365915848ed01d7a.zip
git-bc1c9c0e674bdd293c29ae84365915848ed01d7a.tar.gz
git-bc1c9c0e674bdd293c29ae84365915848ed01d7a.tar.bz2
branch: split validate_new_branchname() into two
Checking if a proposed name is appropriate for a branch is strictly a subset of checking if we want to allow creating or updating a branch with such a name. The mysterious sounding 'attr_only' parameter to validate_new_branchname() is used to switch the function between these two roles. Instead, split the function into two, and adjust the callers. A new helper validate_branchname() only checks the name and reports if the branch already exists. This loses one NEEDSWORK from the branch API. Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'branch.h')
-rw-r--r--branch.h27
1 files changed, 12 insertions, 15 deletions
diff --git a/branch.h b/branch.h
index b077885..be5e5d1 100644
--- a/branch.h
+++ b/branch.h
@@ -23,22 +23,19 @@ void create_branch(const char *name, const char *start_name,
int clobber_head, int quiet, enum branch_track track);
/*
- * Validates that the requested branch may be created, returning the
- * interpreted ref in ref, force indicates whether (non-head) branches
- * may be overwritten. A non-zero return value indicates that the force
- * parameter was non-zero and the branch already exists.
- *
- * Contrary to all of the above, when attr_only is 1, the caller is
- * not interested in verifying if it is Ok to update the named
- * branch to point at a potentially different commit. It is merely
- * asking if it is OK to change some attribute for the named branch
- * (e.g. tracking upstream).
- *
- * NEEDSWORK: This needs to be split into two separate functions in the
- * longer run for sanity.
- *
+ * Check if 'name' can be a valid name for a branch; die otherwise.
+ * Return 1 if the named branch already exists; return 0 otherwise.
+ * Fill ref with the full refname for the branch.
+ */
+extern int validate_branchname(const char *name, struct strbuf *ref);
+
+/*
+ * Check if a branch 'name' can be created as a new branch; die otherwise.
+ * 'force' can be used when it is OK for the named branch already exists.
+ * Return 1 if the named branch already exists; return 0 otherwise.
+ * Fill ref with the full refname for the branch.
*/
-int validate_new_branchname(const char *name, struct strbuf *ref, int force, int attr_only);
+extern int validate_new_branchname(const char *name, struct strbuf *ref, int force);
/*
* Remove information about the state of working on the current