X-Git-Url: https://git.verplant.org/?a=blobdiff_plain;ds=sidebyside;f=Documentation%2Fpull-fetch-param.txt;h=8f6b68cb5514958570196b4c3f725467c0279ed3;hb=ee6566e8d70da682ac4926dd8a67ac821b2c1743;hp=7ae4ba0bd895dbc1adc94d893cf8b5aa8d29a108;hpb=98e031f0bb6e857c684e6db24d03d22cfc1a532a;p=git.git
diff --git a/Documentation/pull-fetch-param.txt b/Documentation/pull-fetch-param.txt
index 7ae4ba0b..8f6b68cb 100644
--- a/Documentation/pull-fetch-param.txt
+++ b/Documentation/pull-fetch-param.txt
@@ -16,21 +16,67 @@
Local directory
/path/to/repo.git/
- In addition to that, as a short-hand, the name of a file
- in $GIT_DIR/branches directory can be specified; the
- named file should contain a single line, a URL in one of
- the above formats, optionally followed by a hash '#' and
- the name of remote head.
-
-
::
- The remote head name to fetch from. That is, make the
- objects reachable from the commit recorded in
- $GIT_DIR/refs/heads/ in the remote repository
- available locally.
-
-tag ::
- The remote head tag to fetch from. That is, make the
- objects reachable from the commit recorded in
- $GIT_DIR/refs/tags/ in the remote repository
- available locally.
+ In addition to the above, as a short-hand, the name of a
+ file in $GIT_DIR/remotes directory can be given; the
+ named file should be in the following format:
+ URL: one of the above URL format
+ Push: ...
+ Pull: ...
+
+ When such a short-hand is specified in place of
+ without parameters on the command
+ line, ... specified on Push lines or Pull lines
+ are used for "git push" and "git fetch/pull",
+ respectively.
+
+ The name of a file in $GIT_DIR/branches directory can be
+ specified as an older notation short-hand; the named
+ file should contain a single line, a URL in one of the
+ above formats, optionally followed by a hash '#' and the
+ name of remote head (URL fragment notation).
+ $GIT_DIR/branches/ file that stores a
+ without the fragment is equivalent to have this in the
+ corresponding file in the $GIT_DIR/remotes/ directory
+
+ URL:
+ Pull: refs/heads/master:
+
+ while having # is equivalent to
+
+ URL:
+ Pull: refs/heads/:
+
+::
+ The canonical format of a parameter is
+ '+?:'; that is, an optional plus '+', followed
+ by the source ref, followed by a colon ':', followed by
+ the destination ref.
+
+ When used in "git push", the side can be an
+ arbitrary "SHA1 expression" that can be used as an
+ argument to "git-cat-file -t". E.g. "master~4" (push
+ four parents before the current master head).
+
+ For "git push", the local ref that matches is used
+ to fast forward the remote ref that matches . If
+ the optional plus '+' is used, the remote ref is updated
+ even if it does not result in a fast forward update.
+
+ For "git fetch/pull", the remote ref that matches
+ is fetched, and if is not empty string, the local
+ ref that matches it is fast forwarded using .
+ Again, if the optional plus '+' is used, the local ref
+ is updated even if it does not result in a fast forward
+ update.
+
+ Some short-cut notations are also supported.
+
+ * For backward compatibility, "tag" is almost ignored;
+ it just makes the following parameter to mean a
+ refspec "refs/tags/:refs/tags/".
+
+ * A parameter [ without a colon is equivalent to
+ ][: when pulling/fetching, and ][:][ when
+ pushing. That is, do not store it locally if
+ fetching, and update the same name if pushing.
]