path: root/branch.h
diff options
authorKaartic Sivaraam <>2017-11-18 17:26:45 (GMT)
committerJunio C Hamano <>2017-12-07 23:06:38 (GMT)
commitf6cea74de63c2926a15b711bec09ed3ab34c2c1e (patch)
tree3dbb5c414a7269b3242cb003a41d0dd964e79ec1 /branch.h
parent5f9953d2c365bffed6f9ee0c6966556bd4d7e2f4 (diff)
branch: improve documentation and naming of create_branch() parameters
The documentation for 'create_branch()' was incomplete as it didn't say what certain parameters were used for. Further a parameter name wasn't very communicative. So, add missing documentation for the sake of completeness and easy reference. Also, rename the concerned parameter to make its name more communicative. Signed-off-by: Kaartic Sivaraam <> Signed-off-by: Junio C Hamano <>
Diffstat (limited to 'branch.h')
1 files changed, 6 insertions, 1 deletions
diff --git a/branch.h b/branch.h
index b077885..cb6411f 100644
--- a/branch.h
+++ b/branch.h
@@ -15,12 +15,17 @@
* - reflog creates a reflog for the branch
+ * - clobber_head_ok allows the currently checked out (hence existing)
+ * branch to be overwritten; without 'force', it has no effect.
+ *
+ * - quiet suppresses tracking information
+ *
* - track causes the new branch to be configured to merge the remote branch
* that start_name is a tracking branch for (if any).
void create_branch(const char *name, const char *start_name,
int force, int reflog,
- int clobber_head, int quiet, enum branch_track track);
+ int clobber_head_ok, int quiet, enum branch_track track);
* Validates that the requested branch may be created, returning the