mingw: implement getppid
[git/kusma.git] / Documentation / git-receive-pack.txt
blob2790eebaff3b9dd9a56358cc470396f36eb87085
1 git-receive-pack(1)
2 ===================
4 NAME
5 ----
6 git-receive-pack - Receive what is pushed into the repository
9 SYNOPSIS
10 --------
11 'git-receive-pack' <directory>
13 DESCRIPTION
14 -----------
15 Invoked by 'git send-pack' and updates the repository with the
16 information fed from the remote end.
18 This command is usually not invoked directly by the end user.
19 The UI for the protocol is on the 'git send-pack' side, and the
20 program pair is meant to be used to push updates to remote
21 repository.  For pull operations, see linkgit:git-fetch-pack[1].
23 The command allows for creation and fast-forwarding of sha1 refs
24 (heads/tags) on the remote end (strictly speaking, it is the
25 local end 'git-receive-pack' runs, but to the user who is sitting at
26 the send-pack end, it is updating the remote.  Confused?)
28 There are other real-world examples of using update and
29 post-update hooks found in the Documentation/howto directory.
31 'git-receive-pack' honours the receive.denyNonFastForwards config
32 option, which tells it if updates to a ref should be denied if they
33 are not fast-forwards.
35 OPTIONS
36 -------
37 <directory>::
38         The repository to sync into.
40 pre-receive Hook
41 ----------------
42 Before any ref is updated, if $GIT_DIR/hooks/pre-receive file exists
43 and is executable, it will be invoked once with no parameters.  The
44 standard input of the hook will be one line per ref to be updated:
46        sha1-old SP sha1-new SP refname LF
48 The refname value is relative to $GIT_DIR; e.g. for the master
49 head this is "refs/heads/master".  The two sha1 values before
50 each refname are the object names for the refname before and after
51 the update.  Refs to be created will have sha1-old equal to 0\{40},
52 while refs to be deleted will have sha1-new equal to 0\{40}, otherwise
53 sha1-old and sha1-new should be valid objects in the repository.
55 This hook is called before any refname is updated and before any
56 fast-forward checks are performed.
58 If the pre-receive hook exits with a non-zero exit status no updates
59 will be performed, and the update, post-receive and post-update
60 hooks will not be invoked either.  This can be useful to quickly
61 bail out if the update is not to be supported.
63 update Hook
64 -----------
65 Before each ref is updated, if $GIT_DIR/hooks/update file exists
66 and is executable, it is invoked once per ref, with three parameters:
68        $GIT_DIR/hooks/update refname sha1-old sha1-new
70 The refname parameter is relative to $GIT_DIR; e.g. for the master
71 head this is "refs/heads/master".  The two sha1 arguments are
72 the object names for the refname before and after the update.
73 Note that the hook is called before the refname is updated,
74 so either sha1-old is 0\{40} (meaning there is no such ref yet),
75 or it should match what is recorded in refname.
77 The hook should exit with non-zero status if it wants to disallow
78 updating the named ref.  Otherwise it should exit with zero.
80 Successful execution (a zero exit status) of this hook does not
81 ensure the ref will actually be updated, it is only a prerequisite.
82 As such it is not a good idea to send notices (e.g. email) from
83 this hook.  Consider using the post-receive hook instead.
85 post-receive Hook
86 -----------------
87 After all refs were updated (or attempted to be updated), if any
88 ref update was successful, and if $GIT_DIR/hooks/post-receive
89 file exists and is executable, it will be invoked once with no
90 parameters.  The standard input of the hook will be one line
91 for each successfully updated ref:
93        sha1-old SP sha1-new SP refname LF
95 The refname value is relative to $GIT_DIR; e.g. for the master
96 head this is "refs/heads/master".  The two sha1 values before
97 each refname are the object names for the refname before and after
98 the update.  Refs that were created will have sha1-old equal to
99 0\{40}, while refs that were deleted will have sha1-new equal to
100 0\{40}, otherwise sha1-old and sha1-new should be valid objects in
101 the repository.
103 Using this hook, it is easy to generate mails describing the updates
104 to the repository.  This example script sends one mail message per
105 ref listing the commits pushed to the repository:
107         #!/bin/sh
108         # mail out commit update information.
109         while read oval nval ref
110         do
111                 if expr "$oval" : '0*$' >/dev/null
112                 then
113                         echo "Created a new ref, with the following commits:"
114                         git rev-list --pretty "$nval"
115                 else
116                         echo "New commits:"
117                         git rev-list --pretty "$nval" "^$oval"
118                 fi |
119                 mail -s "Changes to ref $ref" commit-list@mydomain
120         done
121         exit 0
123 The exit code from this hook invocation is ignored, however a
124 non-zero exit code will generate an error message.
126 Note that it is possible for refname to not have sha1-new when this
127 hook runs.  This can easily occur if another user modifies the ref
128 after it was updated by 'git-receive-pack', but before the hook was able
129 to evaluate it.  It is recommended that hooks rely on sha1-new
130 rather than the current value of refname.
132 post-update Hook
133 ----------------
134 After all other processing, if at least one ref was updated, and
135 if $GIT_DIR/hooks/post-update file exists and is executable, then
136 post-update will be called with the list of refs that have been updated.
137 This can be used to implement any repository wide cleanup tasks.
139 The exit code from this hook invocation is ignored; the only thing
140 left for 'git-receive-pack' to do at that point is to exit itself
141 anyway.
143 This hook can be used, for example, to run `git update-server-info`
144 if the repository is packed and is served via a dumb transport.
146         #!/bin/sh
147         exec git update-server-info
150 SEE ALSO
151 --------
152 linkgit:git-send-pack[1]
155 Author
156 ------
157 Written by Linus Torvalds <torvalds@osdl.org>
159 Documentation
160 --------------
161 Documentation by Junio C Hamano.
165 Part of the linkgit:git[1] suite