summary refs log tree commit diff
path: root/branch.h
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2017-12-27 11:16:25 -0800
committerJunio C Hamano <gitster@pobox.com>2017-12-27 11:16:25 -0800
commit0faff988eed719c53daf470cf0a88c26d0e83525 (patch)
tree418f15e9ae3b21871a5a7d8b0dcc732c83095bcf /branch.h
parenta13e45f1e7e6fc02d4e10e0589578a77e84f3ffb (diff)
parent255073ca59de7cd293e4a9d6c12831b6e505c37e (diff)
Merge branch 'ks/branch-cleanup'
Code clean-up.

* ks/branch-cleanup:
  builtin/branch: strip refs/heads/ using skip_prefix
  branch: update warning message shown when copying a misnamed branch
  branch: group related arguments of create_branch()
  branch: improve documentation and naming of create_branch() parameters
Diffstat (limited to 'branch.h')
-rw-r--r--branch.h10
1 files changed, 8 insertions, 2 deletions
diff --git a/branch.h b/branch.h
index be5e5d1308..473d0a93e9 100644
--- a/branch.h
+++ b/branch.h
@@ -13,14 +13,20 @@
  *
  *   - force enables overwriting an existing (non-head) branch
  *
+ *   - clobber_head_ok allows the currently checked out (hence existing)
+ *     branch to be overwritten; without 'force', it has no effect.
+ *
  *   - reflog creates a reflog for the branch
  *
+ *   - 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 force, int clobber_head_ok,
+		   int reflog, int quiet, enum branch_track track);
 
 /*
  * Check if 'name' can be a valid name for a branch; die otherwise.