diff options
| author | Junio C Hamano <gitster@pobox.com> | 2009-01-25 22:25:20 -0800 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2009-01-25 22:25:20 -0800 |
| commit | 7a0d911f116e437628035d7b07035dbff707a172 (patch) | |
| tree | eb8f48f25c35579370fd54d9b3594f45b8478920 | |
| parent | 5c415311f743ccb11a50f350ff1c385778f049d6 (diff) | |
| download | git-7a0d911f116e437628035d7b07035dbff707a172.tar.gz git-7a0d911f116e437628035d7b07035dbff707a172.tar.xz | |
Documentation: simplify refspec format description
The refspec format description was a mix of regexp and BNF, making it
very difficult to read. The format was also wrong: it did not show
that each part of a refspec is optional in different situations.
Rather than having a confusing grammar, just present the format in
informal prose.
Signed-off-by: Anders Melchiorsen <mail@cup.kalibalik.dk>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | Documentation/git-push.txt | 9 | ||||
| -rw-r--r-- | Documentation/pull-fetch-param.txt | 9 |
2 files changed, 9 insertions, 9 deletions
diff --git a/Documentation/git-push.txt b/Documentation/git-push.txt index 7b27dc60b..ea45935a7 100644 --- a/Documentation/git-push.txt +++ b/Documentation/git-push.txt @@ -33,10 +33,11 @@ OPTIONS of a remote (see the section <<REMOTES,REMOTES>> below). <refspec>...:: - The canonical format of a <refspec> parameter is - `+?<src>:<dst>`; that is, an optional plus `{plus}`, followed - by the source ref, followed by a colon `:`, followed by - the destination ref. + The format of a <refspec> parameter is an optional plus + `{plus}`, followed by the source ref <src>, followed + by a colon `:`, followed by the destination ref <dst>. + It is used to specify with what <src> object the <dst> ref + in the remote repository is to be updated. + The <src> side represents the source branch (or arbitrary "SHA1 expression", such as `master~4` (four parents before the diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt index ebdd948cd..f9811f247 100644 --- a/Documentation/pull-fetch-param.txt +++ b/Documentation/pull-fetch-param.txt @@ -5,15 +5,14 @@ of a remote (see the section <<REMOTES,REMOTES>> below). <refspec>:: - The canonical format of a <refspec> parameter is - `+?<src>:<dst>`; that is, an optional plus `{plus}`, followed - by the source ref, followed by a colon `:`, followed by - the destination ref. + The format of a <refspec> parameter is an optional plus + `{plus}`, followed by the source ref <src>, followed + by a colon `:`, followed by the destination ref <dst>. + The remote ref that matches <src> is fetched, and if <dst> is not empty string, the local ref that matches it is fast forwarded using <src>. -Again, if the optional plus `+` is used, the local ref +If the optional plus `+` is used, the local ref is updated even if it does not result in a fast forward update. + |