Merge http://www.kernel.org/pub/scm/gitk/gitk
[git/git.git] / Documentation / git-receive-pack.txt
1 git-receive-pack(1)
2 ===================
3
4 NAME
5 ----
6 git-receive-pack - Receive what is pushed into it
7
8
9 SYNOPSIS
10 --------
11 'git-receive-pack' <directory>
12
13 DESCRIPTION
14 -----------
15 Invoked by 'git-send-pack' and updates the repository with the
16 information fed from the remote end.
17
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 'git-fetch-pack' and
22 'git-clone-pack'.
23
24 The command allows for creation and fast forwarding of sha1 refs
25 (heads/tags) on the remote end (strictly speaking, it is the
26 local end receive-pack runs, but to the user who is sitting at
27 the send-pack end, it is updating the remote. Confused?)
28
29 Before each ref is updated, if $GIT_DIR/hooks/update file exists
30 and executable, it is called with three parameters:
31
32 $GIT_DIR/hooks/update refname sha1-old sha1-new
33
34 The refname parameter is relative to $GIT_DIR; e.g. for the
35 master head this is "refs/heads/master". Two sha1 are the
36 object names for the refname before and after the update. Note
37 that the hook is called before the refname is updated, so either
38 sha1-old is 0{40} (meaning there is no such ref yet), or it
39 should match what is recorded in refname.
40
41 The hook should exit with non-zero status if it wants to
42 disallow updating the named ref. Otherwise it should exit with
43 zero.
44
45 Using this hook, it is easy to generate mails on updates to
46 the local repository. This example script sends a mail with
47 the commits pushed to the repository:
48
49 #!/bin/sh
50 # mail out commit update information.
51 if expr "$2" : '0*$' >/dev/null
52 then
53 echo "Created a new ref, with the following commits:"
54 git-rev-list --pretty "$2"
55 else
56 echo "New commits:"
57 git-rev-list --pretty "$3" "^$2"
58 fi |
59 mail -s "Changes to ref $1" commit-list@mydomain
60 exit 0
61
62 Another hook $GIT_DIR/hooks/post-update, if exists and
63 executable, is called with the list of refs that have been
64 updated. This can be used to implement repository wide cleanup
65 task if needed. The exit code from this hook invocation is
66 ignored; the only thing left for git-receive-pack to do at that
67 point is to exit itself anyway. This hook can be used, for
68 example, to run "git-update-server-info" if the repository is
69 packed and is served via a dumb transport.
70
71 #!/bin/sh
72 exec git-update-server-info
73
74 OPTIONS
75 -------
76 <directory>::
77 The repository to sync into.
78
79
80 SEE ALSO
81 --------
82 gitlink:git-send-pack[1]
83
84
85 Author
86 ------
87 Written by Linus Torvalds <torvalds@osdl.org>
88
89 Documentation
90 --------------
91 Documentation by Junio C Hamano.
92
93 GIT
94 ---
95 Part of the gitlink:git[7] suite