a02a2b051c1463604f69d9f06c8825f8e720ab34
[git.git] / Documentation / git-sh-setup.txt
1 git-sh-setup(1)
2 ===============
3
4 NAME
5 ----
6 git-sh-setup - Common git shell script setup code.
7
8 SYNOPSIS
9 --------
10 'git-sh-setup'
11
12 DESCRIPTION
13 -----------
14
15 Sets up the normal git environment variables and a few helper functions
16 (currently just "die()"), and returns ok if it all looks like a git archive.
17 So use it something like
18
19         . git-sh-setup || die "Not a git archive"
20
21 to make the rest of the git scripts more careful and readable.
22
23 Author
24 ------
25 Written by Linus Torvalds <torvalds@osdl.org>
26
27 Documentation
28 --------------
29 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
30
31 GIT
32 ---
33 Part of the gitlink:git[7] suite
34