Documentation: begin discussion of git-remote in user manual
[git/jrn.git] / Documentation / git-push.txt
blob197f4b512fbcc969901034e47efa6acefdc5e0ac
1 git-push(1)
2 ===========
4 NAME
5 ----
6 git-push - Update remote refs along with associated objects
9 SYNOPSIS
10 --------
11 'git-push' [--all] [--tags] [-f | --force] <repository> <refspec>...
13 DESCRIPTION
14 -----------
16 Updates remote refs using local refs, while sending objects
17 necessary to complete the given refs.
19 You can make interesting things happen to a repository
20 every time you push into it, by setting up 'hooks' there.  See
21 documentation for gitlink:git-receive-pack[1].
24 OPTIONS
25 -------
26 <repository>::
27         The "remote" repository that is destination of a push
28         operation.  See the section <<URLS,GIT URLS>> below.
30 <refspec>::
31         The canonical format of a <refspec> parameter is
32         `+?<src>:<dst>`; that is, an optional plus `+`, followed
33         by the source ref, followed by a colon `:`, followed by
34         the destination ref.
36 The <src> side can be an
37 arbitrary "SHA1 expression" that can be used as an
38 argument to `git-cat-file -t`.  E.g. `master~4` (push
39 four parents before the current master head).
41 The local ref that matches <src> is used
42 to fast forward the remote ref that matches <dst>.  If
43 the optional plus `+` is used, the remote ref is updated
44 even if it does not result in a fast forward update.
46 Note: If no explicit refspec is found, (that is neither
47 on the command line nor in any Push line of the
48 corresponding remotes file---see below), then all the
49 refs that exist both on the local side and on the remote
50 side are updated.
52 `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
54 A parameter <ref> without a colon is equivalent to
55 <ref>`:`<ref>, hence updates <ref> in the destination from <ref>
56 in the source.
58 Pushing an empty <src> allows you to delete the <dst> ref from
59 the remote repository.
61 \--all::
62         Instead of naming each ref to push, specifies that all
63         refs be pushed.
65 \--tags::
66         All refs under `$GIT_DIR/refs/tags` are pushed, in
67         addition to refspecs explicitly listed on the command
68         line.
70 -f, \--force::
71         Usually, the command refuses to update a remote ref that is
72         not a descendant of the local ref used to overwrite it.
73         This flag disables the check.  This can cause the
74         remote repository to lose commits; use it with care.
76 include::urls.txt[]
78 Author
79 ------
80 Written by Junio C Hamano <junkio@cox.net>, later rewritten in C
81 by Linus Torvalds <torvalds@osdl.org>
83 Documentation
84 --------------
85 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
87 GIT
88 ---
89 Part of the gitlink:git[7] suite