Documentation/pull-fetch-param.txt

   1 <repository>::
   2         The "remote" repository to pull from.  One of the
   3         following notations can be used to name the repository
   4         to pull from:
   5
   6                 Rsync URL
   7                         rsync://remote.machine/path/to/repo.git/
   8
   9                 HTTP(s) URL
  10                         http://remote.machine/path/to/repo.git/
  11
  12                 GIT URL
  13                         git://remote.machine/path/to/repo.git/
  14                         remote.machine:/path/to/repo.git/
  15
  16                 Local directory
  17                         /path/to/repo.git/
  18
  19         In addition to the above, as a short-hand, the name of a
  20         file in $GIT_DIR/remotes directory can be given; the
  21         named file should be in the following format:
  22
  23                 URL: one of the above URL format
  24                 Push: <refspec>...
  25                 Pull: <refspec>...
  26
  27         When such a short-hand is specified in place of
  28         <repository> without <refspec> parameters on the command
  29         line, <refspec>... specified on Push lines or Pull lines
  30         are used for "git push" and "git fetch/pull",
  31         respectively.
  32
  33         The name of a file in $GIT_DIR/branches directory can be
  34         specified as an older notation short-hand; the named
  35         file should contain a single line, a URL in one of the
  36         above formats, optionally followed by a hash '#' and the
  37         name of remote head (URL fragment notation).
  38         $GIT_DIR/branches/<remote> file that stores a <url>
  39         without the fragment is equivalent to have this in the
  40         corresponding file in the $GIT_DIR/remotes/ directory
  41
  42                 URL: <url>
  43                 Pull: refs/heads/master:<remote>
  44
  45         while having <url>#<head> is equivalent to
  46
  47                 URL: <url>
  48                 Pull: refs/heads/<head>:<remote>
  49
  50 <refspec>::
  51         The canonical format of a <refspec> parameter is
  52         '+?<src>:<dst>'; that is, an optional plus '+', followed
  53         by the source ref, followed by a colon ':', followed by
  54         the destination ref.
  55
  56         When used in "git push", the <src> side can be an
  57         arbitrary "SHA1 expression" that can be used as an
  58         argument to "git-cat-file -t".  E.g. "master~4" (push
  59         four parents before the current master head).
  60
  61         For "git push", the local ref that matches <src> is used
  62         to fast forward the remote ref that matches <dst>.  If
  63         the optional plus '+' is used, the remote ref is updated
  64         even if it does not result in a fast forward update.
  65
  66         For "git fetch/pull", the remote ref that matches <src>
  67         is fetched, and if <dst> is not empty string, the local
  68         ref that matches it is fast forwarded using <src>.
  69         Again, if the optional plus '+' is used, the local ref
  70         is updated even if it does not result in a fast forward
  71         update.
  72
  73         Some short-cut notations are also supported.
  74
  75         * For backward compatibility, "tag" is almost ignored;
  76           it just makes the following parameter <tag> to mean a
  77           refspec "refs/tags/<tag>:refs/tags/<tag>".
  78
  79         * A parameter <ref> without a colon is equivalent to
  80           <ref>: when pulling/fetching, and <ref>:<ref> when
  81           pushing.  That is, do not store it locally if
  82           fetching, and update the same name if pushing.
  83
  84 -a, \--append::
  85         Append ref names and object names of fetched refs to the
  86         existing contents of $GIT_DIR/FETCH_HEAD.  Without this
  87         option old data in $GIT_DIR/FETCH_HEAD will be overwritten.
  88
  89 -f, \--force::
  90         Usually, the command refuses to update a local ref that is
  91         not an ancestor of the remote ref used to overwrite it.
  92         This flag disables the check.  What this means is that the
  93         local repository can lose commits; use it with care.