summaryrefslogtreecommitdiff
path: root/Documentation/git-sh-setup-script.txt
diff options
context:
space:
mode:
authorA Large Angry SCM <gitzilla@gmail.com>2005-08-27 01:18:48 (GMT)
committerJunio C Hamano <junkio@cox.net>2005-08-27 03:53:50 (GMT)
commit52a22d1e726f91b0ba4ea0afb7cfbfaaf624127b (patch)
treeb815188ded9ace02c6b0bce9a07451b44e0df1f5 /Documentation/git-sh-setup-script.txt
parent85002315798dfcd28da6120ac3a461ca3fadfd2e (diff)
downloadgit-52a22d1e726f91b0ba4ea0afb7cfbfaaf624127b.zip
git-52a22d1e726f91b0ba4ea0afb7cfbfaaf624127b.tar.gz
git-52a22d1e726f91b0ba4ea0afb7cfbfaaf624127b.tar.bz2
[PATCH] Subject: [PATCH] Add some documentation.
Add some documentation. Text taken from the the commit messages and the command sources.
Diffstat (limited to 'Documentation/git-sh-setup-script.txt')
-rw-r--r--Documentation/git-sh-setup-script.txt18
1 files changed, 7 insertions, 11 deletions
diff --git a/Documentation/git-sh-setup-script.txt b/Documentation/git-sh-setup-script.txt
index 92addd7..5ac613a 100644
--- a/Documentation/git-sh-setup-script.txt
+++ b/Documentation/git-sh-setup-script.txt
@@ -3,26 +3,22 @@ git-sh-setup-script(1)
NAME
----
-git-sh-setup-script - Some git command not yet documented.
-
+git-sh-setup-script - Common git shell script setup code.
SYNOPSIS
--------
-'git-sh-setup-script' [ --option ] <args>...
+'git-sh-setup-script'
DESCRIPTION
-----------
-Does something not yet documented.
-
-OPTIONS
--------
---option::
- Some option not yet documented.
+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
-<args>...::
- Some argument not yet documented.
+ . git-sh-setup-script || die "Not a git archive"
+to make the rest of the git scripts more careful and readable.
Author
------