Merge branch 'lh/submodule'
[git/dkf.git] / Documentation / git-push.txt
blob366c5dbdce69854e7cc1e085cdf53e0e88f7bcb2
1 git-push(1)
2 ===========
4 NAME
5 ----
6 git-push - Update remote refs along with associated objects
9 SYNOPSIS
10 --------
11 [verse]
12 'git-push' [--all] [--tags] [--receive-pack=<git-receive-pack>]
13            [--repo=all] [-f | --force] [-v] [<repository> <refspec>...]
15 DESCRIPTION
16 -----------
18 Updates remote refs using local refs, while sending objects
19 necessary to complete the given refs.
21 You can make interesting things happen to a repository
22 every time you push into it, by setting up 'hooks' there.  See
23 documentation for gitlink:git-receive-pack[1].
26 OPTIONS
27 -------
28 <repository>::
29         The "remote" repository that is destination of a push
30         operation.  See the section <<URLS,GIT URLS>> below.
32 <refspec>::
33         The canonical format of a <refspec> parameter is
34         `+?<src>:<dst>`; that is, an optional plus `+`, followed
35         by the source ref, followed by a colon `:`, followed by
36         the destination ref.
38 The <src> side can be an
39 arbitrary "SHA1 expression" that can be used as an
40 argument to `git-cat-file -t`.  E.g. `master~4` (push
41 four parents before the current master head).
43 The local ref that matches <src> is used
44 to fast forward the remote ref that matches <dst>.  If
45 the optional plus `+` is used, the remote ref is updated
46 even if it does not result in a fast forward update.
48 Note: If no explicit refspec is found, (that is neither
49 on the command line nor in any Push line of the
50 corresponding remotes file---see below), then all the
51 refs that exist both on the local side and on the remote
52 side are updated.
54 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
56 A parameter <ref> without a colon is equivalent to
57 <ref>`:`<ref>, hence updates <ref> in the destination from <ref>
58 in the source.
60 Pushing an empty <src> allows you to delete the <dst> ref from
61 the remote repository.
63 \--all::
64         Instead of naming each ref to push, specifies that all
65         refs be pushed.
67 \--tags::
68         All refs under `$GIT_DIR/refs/tags` are pushed, in
69         addition to refspecs explicitly listed on the command
70         line.
72 \--receive-pack=<git-receive-pack>::
73         Path to the 'git-receive-pack' program on the remote
74         end.  Sometimes useful when pushing to a remote
75         repository over ssh, and you do not have the program in
76         a directory on the default $PATH.
78 \--exec=<git-receive-pack>::
79         Same as \--receive-pack=<git-receive-pack>.
81 -f, \--force::
82         Usually, the command refuses to update a remote ref that is
83         not a descendant of the local ref used to overwrite it.
84         This flag disables the check.  This can cause the
85         remote repository to lose commits; use it with care.
87 \--repo=<repo>::
88         When no repository is specified the command defaults to
89         "origin"; this overrides it.
91 \--thin, \--no-thin::
92         These options are passed to `git-send-pack`.  Thin
93         transfer spends extra cycles to minimize the number of
94         objects to be sent and meant to be used on slower connection.
96 -v::
97         Run verbosely.
99 include::urls.txt[]
101 Author
102 ------
103 Written by Junio C Hamano <junkio@cox.net>, later rewritten in C
104 by Linus Torvalds <torvalds@osdl.org>
106 Documentation
107 --------------
108 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
112 Part of the gitlink:git[7] suite