Docs: minor git-push copyediting
[git.git] / Documentation / git-push.txt
1 git-push(1)
2 ===========
3
4 NAME
5 ----
6 git-push - Update remote refs along with associated objects.
7
8
9 SYNOPSIS
10 --------
11 'git-push' [--all] [--tags] [--force] <repository> <refspec>...
12
13 DESCRIPTION
14 -----------
15
16 Updates remote refs using local refs, while sending objects
17 necessary to complete the given refs.
18
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].
22
23
24 OPTIONS
25 -------
26 <repository>::
27         The "remote" repository that is destination of a push
28         operation.  See the section <<URLS,GIT URLS>> below.
29
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.
35 +
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).
40 +
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.
45 +
46 Some short-cut notations are also supported.
47 +
48 * `tag <tag>` means the same as `refs/tags/<tag>:refs/tags/<tag>`.
49 * A parameter <ref> without a colon is equivalent to
50   <ref>`:`<ref>, hence updates <ref> in the destination from <ref>
51   in the source.
52
53 \--all::
54         Instead of naming each ref to push, specifies that all
55         refs be pushed.
56
57 \--tags::
58         All refs under `$GIT_DIR/refs/tags` are pushed, in
59         addition to refspecs explicitly listed on the command
60         line.
61
62 -f, \--force::
63         Usually, the command refuses to update a remote ref that is
64         not a descendent of the local ref used to overwrite it.
65         This flag disables the check.  This can cause the
66         remote repository to lose commits; use it with care.
67
68 include::urls.txt[]
69
70 Author
71 ------
72 Written by Junio C Hamano <junkio@cox.net>
73
74 Documentation
75 --------------
76 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
77
78 GIT
79 ---
80 Part of the gitlink:git[7] suite
81