threads / patch / 32205

patchDocumentation/git-push.txt: fix typo in remote tracking branch path

Subject: [PATCH] Documentation/git-push.txt: fix typo in remote tracking branch path

## tl;dr

4 messages between Nov 27, 2012 and Nov 27, 2012. Diffs are folded; open one to read it.

replies: 3people: 2as markdown or json

Brandon Casey· Nov 27, 2012, 00:55 UTC · lore

From: Brandon Casey <drafnel@gmail.com>

This example in the documentation seems to be trying to describe the likely remote tracking branch that will be updated by a push to the "origin" remote with the destination branch 'satellite/master', but it forgot to specify the remote name in the path specification.

So,

   refs/remotes/satellite/master

should be spelled like

   refs/remotes/origin/satellite/master

Signed-off-by: Brandon Casey <bcasey@nvidia.com>
---
 Documentation/git-push.txt |    4 ++--
 1 files changed, 2 insertions(+), 2 deletions(-)

Show changes to Documentation/git-push.txt +2 −2

diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
index fe46c42..a18f929 100644
--- a/Documentation/git-push.txt
+++ b/Documentation/git-push.txt
@@ -387,8 +387,8 @@ the ones in the examples below) can be configured as the default for
 `git push origin master:satellite/master dev:satellite/dev`::
 	Use the source ref that matches `master` (e.g. `refs/heads/master`)
 	to update the ref that matches `satellite/master` (most probably
-	`refs/remotes/satellite/master`) in the `origin` repository, then
-	do the same for `dev` and `satellite/dev`.
+	`refs/remotes/origin/satellite/master`) in the `origin` repository,
+	then do the same for `dev` and `satellite/dev`.
 
 `git push origin HEAD:master`::
 	Push the current branch to the remote ref matching `master` in the

-- 
1.7.8.4


-----------------------------------------------------------------------------------
This email message is for the sole use of the intended recipient(s) and may contain
confidential information.  Any unauthorized review, use, disclosure or distribution
is prohibited.  If you are not the intended recipient, please contact the sender by
reply email and destroy all copies of the original message.
-----------------------------------------------------------------------------------

Junio C Hamano· Nov 27, 2012, 01:30 UTC · re: Brandon Casey · lore

Re: [PATCH] Documentation/git-push.txt: fix typo in remote tracking branch path

Brandon Casey <bcasey@nvidia.com> writes:

Show 14 quoted lines

> From: Brandon Casey <drafnel@gmail.com>
>
> This example in the documentation seems to be trying to describe the likely
> remote tracking branch that will be updated by a push to the "origin" remote
> with the destination branch 'satellite/master', but it forgot to specify
> the remote name in the path specification.
>
> So,
>
>    refs/remotes/satellite/master
>
> should be spelled like
>
>    refs/remotes/origin/satellite/master

I might make sense to rename 'origin' to 'mothership' in that example and explain that this is emulating 'git fetch' run on the mothership to integrate the work done on 'satellite' using 'git push' in the opposite direction, which is often necessary when you can only make connection in one way (i.e. satellite can ssh into mothership but mothership cannot initiate connection to satellite because the latter is behind a firewall or does not run sshd).

If you were to run 'git fetch' on the mothership to intgrate the work on the 'satellite', it would have a remote called 'satellite', and would keep remote-tracking branches for the branches local to 'satellite' in the 'refs/remotes/satellite/' hierarchy. You would push your local 'master' to their 'refs/remotes/satellite/master', to emulate 'git fetch' done on the mothership in the reverse direction.

So refs are correct. The context is not sufficiently explained.

Show 21 quoted lines

>
> Signed-off-by: Brandon Casey <bcasey@nvidia.com>
> ---
>  Documentation/git-push.txt |    4 ++--
>  1 files changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt
> index fe46c42..a18f929 100644
> --- a/Documentation/git-push.txt
> +++ b/Documentation/git-push.txt
> @@ -387,8 +387,8 @@ the ones in the examples below) can be configured as the default for
>  `git push origin master:satellite/master dev:satellite/dev`::
>  	Use the source ref that matches `master` (e.g. `refs/heads/master`)
>  	to update the ref that matches `satellite/master` (most probably
> -	`refs/remotes/satellite/master`) in the `origin` repository, then
> -	do the same for `dev` and `satellite/dev`.
> +	`refs/remotes/origin/satellite/master`) in the `origin` repository,
> +	then do the same for `dev` and `satellite/dev`.
>  
>  `git push origin HEAD:master`::
>  	Push the current branch to the remote ref matching `master` in the

Brandon Casey· Nov 27, 2012, 01:57 UTC · re: Junio C Hamano · lore

Re: [PATCH] Documentation/git-push.txt: fix typo in remote tracking branch path

On 11/26/2012 5:30 PM, Junio C Hamano wrote:

Show 34 quoted lines

> Brandon Casey <bcasey@nvidia.com> writes:
>
>> From: Brandon Casey <drafnel@gmail.com>
>>
>> This example in the documentation seems to be trying to describe the likely
>> remote tracking branch that will be updated by a push to the "origin" remote
>> with the destination branch 'satellite/master', but it forgot to specify
>> the remote name in the path specification.
>>
>> So,
>>
>>     refs/remotes/satellite/master
>>
>> should be spelled like
>>
>>     refs/remotes/origin/satellite/master
>
> I might make sense to rename 'origin' to 'mothership' in that
> example and explain that this is emulating 'git fetch' run on the
> mothership to integrate the work done on 'satellite' using 'git
> push' in the opposite direction, which is often necessary when you
> can only make connection in one way (i.e. satellite can ssh into
> mothership but mothership cannot initiate connection to satellite
> because the latter is behind a firewall or does not run sshd).
>
> If you were to run 'git fetch' on the mothership to intgrate the
> work on the 'satellite', it would have a remote called 'satellite',
> and would keep remote-tracking branches for the branches local to
> 'satellite' in the 'refs/remotes/satellite/' hierarchy.  You would
> push your local 'master' to their 'refs/remotes/satellite/master',
> to emulate 'git fetch' done on the mothership in the reverse
> direction.
>
> So refs are correct. The context is not sufficiently explained.

Ah, I see. Yeah, I think that is complex enough to merit an extended explanation.

-Brandon

----------------------------------------------------------------------------------- This email message is for the sole use of the intended recipient(s) and may contain confidential information. Any unauthorized review, use, disclosure or distribution is prohibited. If you are not the intended recipient, please contact the sender by reply email and destroy all copies of the original message. -----------------------------------------------------------------------------------

Junio C Hamano· Nov 27, 2012, 23:52 UTC · re: Brandon Casey · lore

[PATCH] Documentation/git-push.txt: clarify the "push from satellite" workflow

The context of the example to push into refs/remotes/satellite/ hierarchy of the other repository needs to be spelled out explicitly for the value of this example to be fully appreciated. Make it so.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
---
Brandon Casey <bcasey@nvidia.com> writes:

>> So refs are correct. The context is not sufficiently explained.
>
> Ah, I see.  Yeah, I think that is complex enough to merit an
> extended explanation.

Something like this?

 Documentation/git-push.txt | 16 ++++++++++++++--
 1 file changed, 14 insertions(+), 2 deletions(-)

Show changes to diff +14 −2

diff --git c/Documentation/git-push.txt w/Documentation/git-push.txt
index 6d19d59..8b637d3 100644
--- c/Documentation/git-push.txt
+++ w/Documentation/git-push.txt
@@ -385,11 +385,23 @@ the ones in the examples below) can be configured as the default for
 	A handy way to push the current branch to the same name on the
 	remote.
 
-`git push origin master:satellite/master dev:satellite/dev`::
+`git push mothership master:satellite/master dev:satellite/dev`::
 	Use the source ref that matches `master` (e.g. `refs/heads/master`)
 	to update the ref that matches `satellite/master` (most probably
-	`refs/remotes/satellite/master`) in the `origin` repository, then
+	`refs/remotes/satellite/master`) in the `mothership` repository;
 	do the same for `dev` and `satellite/dev`.
++
+This is to emulate `git fetch` run on the `mothership` using `git
+push` that is run in the opposite direction in order to integrate
+the work done on `satellite`, and is often necessary when you can
+only make connection in one way (i.e. satellite can ssh into
+mothership but mothership cannot initiate connection to satellite
+because the latter is behind a firewall or does not run sshd).
++
+After running this `git push` on the `satellite` machine, you would
+ssh into the `mothership` and run `git merge` there to complete the
+emulation of `git pull` that were run on `mothership` to pull changes
+made on `satellite`.
 
 `git push origin HEAD:master`::
 	Push the current branch to the remote ref matching `master` in the