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