diff mbox series

Re* Contradicting man page for git branch copy

Message ID xmqq5ytn8fbp.fsf@gitster.g (mailing list archive)
State Accepted
Commit efc3d304571f27c7a0a1e54a74222238c6f80ee3
Headers show
Series Re* Contradicting man page for git branch copy | expand

Commit Message

Junio C Hamano Oct. 23, 2021, 11:57 p.m. UTC 
Martin <git@mfriebe.de> writes:

> The man page says
>
> 1) Under "Description"
> https://git-scm.com/docs/git-branch#_description
>> The |-c| and |-C| options have the exact same semantics as |-m| and
>> |-M|, except instead of the branch being renamed, it will be copied
>> to a new name, along with its config and reflog.
>
> But on the option itself
> https://git-scm.com/docs/git-branch#Documentation/git-branch.txt--c
>>
>> -c
>> --copy
>>
>>     Copy a branch and the corresponding reflog.
>>
>
> The latter does not mention the config.
>
> So does it copy the config or not ?

Thanks for a report.  

I hope that builtin/branch.c::copy_or_rename_branch() is a
relatively easy read.

----- >8 --------- >8 --------- >8 --------- >8 -----
Subject: branch (doc): -m/-c copies config and reflog

The description section for the command mentions config and reflog
are moved or copied by these options, but the description for these
options did not.  Make them match.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
 Documentation/git-branch.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git i/Documentation/git-branch.txt w/Documentation/git-branch.txt
index 5449767121..8af42eff89 100644
--- i/Documentation/git-branch.txt
+++ w/Documentation/git-branch.txt
@@ -125,14 +125,14 @@  OPTIONS
 
 -m::
 --move::
-	Move/rename a branch and the corresponding reflog.
+	Move/rename a branch, together with its config and reflog.
 
 -M::
 	Shortcut for `--move --force`.
 
 -c::
 --copy::
-	Copy a branch and the corresponding reflog.
+	Copy a branch, together with its config and reflog.
 
 -C::
 	Shortcut for `--copy --force`.