[PATCH] Subject: [PATCH] Add some documentation.

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

diff --git a/Documentation/git-sh-setup-script.txt b/Documentation/git-sh-setup-script.txt
index 92addd71fec5e938eeafc9be98ebb6609e1802e8..5ac613a2c79999b5db08daa77ef3af574e4efa94 100644 (file)
--- 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
 ------