From f6cea74de63c2926a15b711bec09ed3ab34c2c1e Mon Sep 17 00:00:00 2001 From: Kaartic Sivaraam Date: Sat, 18 Nov 2017 22:56:45 +0530 Subject: 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 --- branch.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'branch.h') 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 -- cgit v1.2.1