Skip to contentSkip to conversation

doc: attempt to clarify a blurry sentence.

PATCH In review Lars Berntzon via GitGitGadget 3 participants 3 messages May 6, 2021 – May 7, 2021 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 doc: attempt to clarify a blurry sentence.

From: Lars Berntzon <[email protected]>

---
Attempt to clarify a blurry sentence.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1019%2Flboclboc%2Fmaster-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1019/lboclboc/master-v1
Pull-Request: https://github.com/git/git/pull/1019

 Documentation/git-push.txt | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/git-push.txt +4 -4
index a953c7c38790..bbb30c52395e 100644
@@ -66,10 +66,10 @@ it can be any arbitrary "SHA-1 expression", such as `master~4` or
 The <dst> tells which ref on the remote side is updated with this
 push. Arbitrary expressions cannot be used here, an actual ref must
 be named.
-If `git push [<repository>]` without any `<refspec>` argument is set to
-update some ref at the destination with `<src>` with
-`remote.<repository>.push` configuration variable, `:<dst>` part can
-be omitted--such a push will update a ref that `<src>` normally updates
+If `git push [<repository>]` without any `<refspec>` argument then
+git will update the remote ref as defined by `remote.<repository>.push` configuration
+and it will be updated from HEAD.
+`:<dst>` part can be omitted--such a push will update a ref that `<src>` normally updates
 without any `<refspec>` on the command line.  Otherwise, missing
 `:<dst>` means to update the same ref as the `<src>`.
 +

base-commit: 7e391989789db82983665667013a46eabc6fc570

Signature · 1 line
gitgitgadget
#1 lore raw
Quoted 6 lines · Lars Berntzon via GitGitGadget
Documentation/git-push.txt +0 -0
index a953c7c38790..bbb30c52395e 100644
@@ -66,10 +66,10 @@ it can be any arbitrary "SHA-1 expression", such as `master~4` or
 The <dst> tells which ref on the remote side is updated with this

Documentation/git-push.txt it can be any arbitrary "SHA-1 expression", such as `master~4` or · line 72

Quoted 10 lines
Documentation/git-push.txt +4 -4
 push. Arbitrary expressions cannot be used here, an actual ref must
 be named.
-If `git push [<repository>]` without any `<refspec>` argument is set to
-update some ref at the destination with `<src>` with
-`remote.<repository>.push` configuration variable, `:<dst>` part can
-be omitted--such a push will update a ref that `<src>` normally updates
+If `git push [<repository>]` without any `<refspec>` argument then
+git will update the remote ref as defined by `remote.<repository>.push` configuration
+and it will be updated from HEAD.
+`:<dst>` part can be omitted--such a push will update a ref that `<src>` normally updates

Hmph, "If X then Git will do Y" expects X to be a full sentence with subject and verb, but I do not see any verb in

git push [<repository>] without any <refspec> argument

in the rewritten version.

More importantly, the updated description is wrong. The original may be hard to follow, but what it is trying to explain is the following.

Imagine that you have configured

[remote "origin"]
push = refs/heads/*:refs/remotes/satellite/*

Imagine further that you have a local branch 'next' and you want to push it out to the "origin". You also have other local branches like 'master' and 'maint', but you do not wish to push them out right now.

Under such a scenario, if you were to type

    $ git push origin

(i.e. "git push [<repository>] without <refspec> argument"), such a command is set to update refs/remotes/satellite/next (i.e. "some ref") at the "origin" (i.e. "the destination") with next (i.e. "with <src>") via the remote.origin.push configuration variable. So this scenario satisfies the precondition of the description we are discussing.

In such a case, you do not have to fully spell out

    $ git push origin next:refs/remotes/satellite/next

in order to push your 'next' branch (which may not be the current branch) from the command line to its usual/configured destination.

Instead, you can omit ":<dst>", i.e.

    $ git push origin next

and such a push will update the remote ref that would be normally updated by the local ref named on the command line, i.e. the remote 'refs/remotes/satellite/next' will be updated with your local 'refs/heads/next'. But your 'master' and 'maint' will not be pushed to their usual/configured destinations with such a push.

Again, the original may hard to read and it can use some rewriting to make it easier to read. Thanks for trying to help by attempting, and another try with the above information in mind is greatly appreciated.

#2 lore raw
In reply to Lars Berntzon via GitGitGadget

Yes, your text is clear. I realize now I miss-read the line as if it was:

  If git push [<repository>] without any <refspec> argument is set, to -update some ref at the destination with <src> with....

I mentally placed the comma there and then I could not get pass that (and for me there was no verb there to start with so I though it was the git-doc lingua).

But the main problem I have I guess is that the line refers to and , but those comes from the ref-spec, but the whole line is about when ref-spec is not specified so the placeholders and are not valid. Also your clarification contain <src> and <dst> but again without ref-spec that is not defined.

Regards, Lars

Quoted 36 lines · Lars Berntzon via GitGitGadget

From: Lars Berntzon <[email protected]>

---
Attempt to clarify a blurry sentence.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1019%2Flboclboc%2Fmaster-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1019/lboclboc/master-v1
Pull-Request: https://github.com/git/git/pull/1019

  Documentation/git-push.txt | 8 ++++----
  1 file changed, 4 insertions(+), 4 deletions(-)
Documentation/git-push.txt +4 -4
index a953c7c38790..bbb30c52395e 100644
@@ -66,10 +66,10 @@ it can be any arbitrary "SHA-1 expression", such as `master~4` or
  The <dst> tells which ref on the remote side is updated with this
  push. Arbitrary expressions cannot be used here, an actual ref must
  be named.
-If `git push [<repository>]` without any `<refspec>` argument is set to
-update some ref at the destination with `<src>` with
-`remote.<repository>.push` configuration variable, `:<dst>` part can
-be omitted--such a push will update a ref that `<src>` normally updates
+If `git push [<repository>]` without any `<refspec>` argument then
+git will update the remote ref as defined by `remote.<repository>.push` configuration
+and it will be updated from HEAD.
+`:<dst>` part can be omitted--such a push will update a ref that `<src>` normally updates
  without any `<refspec>` on the command line.  Otherwise, missing
  `:<dst>` means to update the same ref as the `<src>`.
  +

base-commit: 7e391989789db82983665667013a46eabc6fc570