[thirdparty/git.git] / Documentation / git-receive-pack.txt

git-receive-pack(1)
===================

NAME
----
git-receive-pack - Receive what is pushed into it


SYNOPSIS
--------
'git-receive-pack' <directory>

DESCRIPTION
-----------
Invoked by 'git-send-pack' and updates the repository with the
information fed from the remote end.

This command is usually not invoked directly by the end user.
The UI for the protocol is on the 'git-send-pack' side, and the
program pair is meant to be used to push updates to remote
repository.  For pull operations, see 'git-fetch-pack' and
'git-clone-pack'.

The command allows for creation and fast forwarding of sha1 refs
(heads/tags) on the remote end (strictly speaking, it is the
local end receive-pack runs, but to the user who is sitting at
the send-pack end, it is updating the remote.  Confused?)

Before each ref is updated, if $GIT_DIR/hooks/update file exists
and executable, it is called with three parameters:

       $GIT_DIR/hooks/update refname sha1-old sha1-new

The refname parameter is relative to $GIT_DIR; e.g. for the
master head this is "refs/heads/master".  Two sha1 are the
object names for the refname before and after the update.  Note
that the hook is called before the refname is updated, so either
sha1-old is 0{40} (meaning there is no such ref yet), or it
should match what is recorded in refname.

The hook should exit with non-zero status if it wants to
disallow updating the named ref.  Otherwise it should exit with
zero.

Using this hook, it is easy to generate mails on updates to
the local repository. This example script sends a mail with
the commits pushed to the repository:

	#!/bin/sh
	# mail out commit update information.
	if expr "$2" : '0*$' >/dev/null
	then
		echo "Created a new ref, with the following commits:"
		git-rev-list --pretty "$2"
	else
		echo "New commits:"
		git-rev-list --pretty "$3" "^$2"
	fi |
	mail -s "Changes to ref $1" commit-list@mydomain
	exit 0

Another hook $GIT_DIR/hooks/post-update, if exists and
executable, is called with the list of refs that have been
updated.  This can be used to implement repository wide cleanup
task if needed.  The exit code from this hook invocation is
ignored; the only thing left for git-receive-pack to do at that
point is to exit itself anyway.  This hook can be used, for
example, to run "git-update-server-info" if the repository is
packed and is served via a dumb transport.

	#!/bin/sh
	exec git-update-server-info

There are other real-world examples of using update and
post-update hooks found in the Documentation/howto directory.


OPTIONS
-------
<directory>::
	The repository to sync into.


SEE ALSO
--------
gitlink:git-send-pack[1]


Author
------
Written by Linus Torvalds <torvalds@osdl.org>

Documentation
--------------
Documentation by Junio C Hamano.

GIT
---
Part of the gitlink:git[7] suite
Commit	Line	Data
	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	There are other real-world examples of using update and
	75	post-update hooks found in the Documentation/howto directory.
	76
	77
	78	OPTIONS
	79	-------
	80	<directory>::
	81	The repository to sync into.
	82
	83
	84	SEE ALSO
	85	--------
	86	gitlink:git-send-pack[1]
	87
	88
	89	Author
	90	------
	91	Written by Linus Torvalds <torvalds@osdl.org>
	92
	93	Documentation
	94	--------------
	95	Documentation by Junio C Hamano.
	96
	97	GIT
	98	---
	99	Part of the gitlink:git[7] suite