Thread (1 message) 1 message, 1 author, 2021-10-23

Re* Contradicting man page for git branch copy

From: Junio C Hamano <hidden>
Date: 2021-10-23 23:57:35

Martin [off-list ref] writes:
The man page says

1) Under "Description"
https://git-scm.com/docs/git-branch#_description
quoted
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
quoted
-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 <redacted>
---
 Documentation/git-branch.txt | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)
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`.

Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help