Documentation for a certain function 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 it's name more
communicative.
Signed-off-by: Kaartic Sivaraam <kaarticsivaraam91196@xxxxxxxxx>
---
branch.c | 4 ++--
branch.h | 7 ++++++-
2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/branch.c b/branch.c
index 703ded69c..8d4360aa5 100644
--- a/branch.c
+++ b/branch.c
@@ -229,7 +229,7 @@ N_("\n"
"\"git push -u\" to set the upstream config as you push.");
void create_branch(const char *name, const char *start_name,
- int force, int reflog, int clobber_head,
+ int force, int reflog, int clobber_head_ok,
int quiet, enum branch_track track)
{
struct commit *commit;
@@ -245,7 +245,7 @@ void create_branch(const char *name, const char *start_name,
if (validate_new_branchname(name, &ref, force,
track == BRANCH_TRACK_OVERRIDE ||
- clobber_head)) {
+ clobber_head_ok)) {
if (!force)
dont_change_ref = 1;
else
diff --git a/branch.h b/branch.h
index b07788558..cb6411f84 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
--
2.14.1.935.ge2b2bcd8a
