Big tool rename.

[git.git] / Documentation / git-sh-setup.txt

diff --git a/Documentation/git-sh-setup.txt b/Documentation/git-sh-setup.txt
new file mode 100644 (file)
index 0000000..fcf2cdf
--- /dev/null
+++ b/Documentation/git-sh-setup.txt
@@ -0,0 +1,34 @@
+git-sh-setup(1)
+===============
+
+NAME
+----
+git-sh-setup - Common git shell script setup code.
+
+SYNOPSIS
+--------
+'git-sh-setup'
+
+DESCRIPTION
+-----------
+
+Sets up the normal git environment variables and a few helper functions
+(currently just "die()"), and returns ok if it all looks like a git archive.
+So use it something like
+
+       . git-sh-setup || die "Not a git archive"
+
+to make the rest of the git scripts more careful and readable.
+
+Author
+------
+Written by Linus Torvalds <torvalds@osdl.org>
+
+Documentation
+--------------
+Documentation by Junio C Hamano and the git-list <git@vger.kernel.org>.
+
+GIT
+---
+Part of the link:git.html[git] suite
+