diff mbox series

[v2,8/9] doc: git-http-push: describe the refs as pattern pairs

Message ID 20900b019f835e9293fb5d70ae8dbdced3b781c0.1635438124.git.gitgitgadget@gmail.com (mailing list archive)
State Superseded
Headers show
Series doc: fix grammar rules in commands' syntax | expand

Commit Message

Jean-Noël Avila Oct. 28, 2021, 4:22 p.m. UTC 
From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>

Each member of the pair is explained but they are not defined
beforehand.

Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
---
 Documentation/git-http-push.txt | 13 ++++++-------
 1 file changed, 6 insertions(+), 7 deletions(-)

Comments

Junio C Hamano Oct. 28, 2021, 5:55 p.m. UTC | #1 
"Jean-Noël Avila via GitGitGadget"  <gitgitgadget@gmail.com> writes:

> -Each pattern pair consists of the source side (before the colon)
> -and the destination side (after the colon).  The ref to be
> -pushed is determined by finding a match that matches the source
> -side, and where it is pushed is determined by using the
> -destination side.
> +Each pattern pair '<src>:<dst>' consists of the source side (before
> +the colon) and the destination side (after the colon).  The ref to be
> +pushed is determined by finding a match that matches the source side,
> +and where it is pushed is determined by using the destination side.

Looks good.  It is unfortunate that this does not share the text
with description of refspec in "git push" documentation page, but
let's not worry about it too much.  I think we will probably start
talking about deprecating "git http-push".  Who still uses it and
why, I do not think of a good reason offhand.

Thanks.
diff mbox series

Patch

diff --git a/Documentation/git-http-push.txt b/Documentation/git-http-push.txt
index 78f2bb75523..7c6a6dd7f6a 100644
--- a/Documentation/git-http-push.txt
+++ b/Documentation/git-http-push.txt
@@ -63,16 +63,15 @@  of such patterns separated by a colon ":" (this means that a ref name
 cannot have a colon in it).  A single pattern '<name>' is just a
 shorthand for '<name>:<name>'.
 
-Each pattern pair consists of the source side (before the colon)
-and the destination side (after the colon).  The ref to be
-pushed is determined by finding a match that matches the source
-side, and where it is pushed is determined by using the
-destination side.
+Each pattern pair '<src>:<dst>' consists of the source side (before
+the colon) and the destination side (after the colon).  The ref to be
+pushed is determined by finding a match that matches the source side,
+and where it is pushed is determined by using the destination side.
 
- - It is an error if <src> does not match exactly one of the
+ - It is an error if '<src>' does not match exactly one of the
    local refs.
 
- - If <dst> does not match any remote ref, either
+ - If '<dst>' does not match any remote ref, either
 
    * it has to start with "refs/"; <dst> is used as the
      destination literally in this case.