git@vger.kernel.org mailing list mirror (one of many)
 help / color / mirror / code / Atom feed
* Contradicting man page for git branch copy
@ 2021-10-23 15:25 Martin
  2021-10-23 23:57 ` Re* " Junio C Hamano
  0 siblings, 1 reply; 2+ messages in thread
From: Martin @ 2021-10-23 15:25 UTC (permalink / raw)
  To: Git List

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 ?




^ permalink raw reply	[flat|nested] 2+ messages in thread

* Re* Contradicting man page for git branch copy
  2021-10-23 15:25 Contradicting man page for git branch copy Martin
@ 2021-10-23 23:57 ` Junio C Hamano
  0 siblings, 0 replies; 2+ messages in thread
From: Junio C Hamano @ 2021-10-23 23:57 UTC (permalink / raw)
  To: Martin; +Cc: Git List

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 --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`.



^ permalink raw reply related	[flat|nested] 2+ messages in thread

end of thread, other threads:[~2021-10-23 23:57 UTC | newest]

Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-10-23 15:25 Contradicting man page for git branch copy Martin
2021-10-23 23:57 ` Re* " Junio C Hamano

Code repositories for project(s) associated with this public inbox

	https://80x24.org/mirrors/git.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).