[RFC PATCH v3 1/4] branch: improve documentation and naming of 'create_branch()'
- From
Kaartic Sivaraam <kaartic.sivaraam@gmail.com>
- Date
- Nov 2, 2017, 06:52 UTC
- Message-ID
- <20171102065242.25299-2-kaartic.sivaraam@gmail.com>
- In-Reply-To
- <20171102065242.25299-1-kaartic.sivaraam@gmail.com>
From: Kaartic Sivaraam <kaarticsivaraam91196@gmail.com>
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 <kaarticsivaraam91196@gmail.com> --- branch.c | 4 ++-- branch.h | 7 ++++++- 2 files changed, 8 insertions(+), 3 deletions(-)
diff --git a/branch.c b/branch.c index fe1e1c367..ea6e2b359 100644 --- a/branch.c +++ b/branch.c @@ -244,7 +244,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; @@ -258,7 +258,7 @@ void create_branch(const char *name, const char *start_name, if (track == BRANCH_TRACK_EXPLICIT || track == BRANCH_TRACK_OVERRIDE) explicit_tracking = 1; - if ((track == BRANCH_TRACK_OVERRIDE || clobber_head) + if ((track == BRANCH_TRACK_OVERRIDE || clobber_head_ok) ? validate_branchname(name, &ref) : validate_new_branchname(name, &ref, force)) { if (!force) diff --git a/branch.h b/branch.h index be5e5d130..1512b78d1 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); /* * Check if 'name' can be a valid name for a branch; die otherwise.
-- 2.15.0.461.gf957c703b.dirty