Documentation: begin discussion of git-remote in user manual
[git/jrn.git] / Documentation / git-sh-setup.txt
blob79217d8a56193c6ba4a3406ec6cbd04abf19fec3
1 git-sh-setup(1)
2 ===============
4 NAME
5 ----
6 git-sh-setup - Common git shell script setup code
8 SYNOPSIS
9 --------
10 'git-sh-setup'
12 DESCRIPTION
13 -----------
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, to make the rest of the git scripts more careful and readable,
18 use it as follows:
20 -------------------------------------------------
21 . git-sh-setup || die "Not a git archive"
22 -------------------------------------------------
24 Author
25 ------
26 Written by Linus Torvalds <torvalds@osdl.org>
28 Documentation
29 --------------
30 Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
32 GIT
33 ---
34 Part of the gitlink:git[7] suite