precheck: Add documentation in new manpage

Adds git-precheck(1) as the primary documentation for git-precheck.
Like with git-sonar, the previous 'git-precheck --help' text is
incorporated, and specifying --help now causes the new manpage to open.

Signed-off-by: Matt Hunter <m@lfurio.us>

1 files changed, 3 insertions, 32 deletions

diff --git a/git-precheck b/git-precheck
index fa42eb3..52f1781 100755
--- a/git-precheck
+++ b/git-precheck
@@ -1,35 +1,6 @@
 #!/bin/sh
 
-usage() {
-    echo "git-precheck [--quiet] [--ignore-dirty] [--ignore-untracked]"
-    echo ""
-    echo "If the current working directory is inside a git repository, examine"
-    echo "the repo for any abnormal state and return an exit code indicating"
-    echo "the status.  If unclean, print a line of text describing each"
-    echo "condition found."
-    echo ""
-    echo "  --quiet"
-    echo "      Don't actually print anything."
-    echo ""
-    echo "  --ignore-dirty"
-    echo "      Don't consider the presence of uncommitted changes to tracked"
-    echo "      files as an abnormal state."
-    echo ""
-    echo "  --ignore-untracked"
-    echo "      Don't consider the presence of untracked files as an abnormal"
-    echo "      state."
-    echo ""
-    echo "  Exit codes:"
-    echo "      0   If inside a repository and all checks return normal"
-    echo "      1   If untracked files detected"
-    echo "      2   If dirty/modified files detected"
-    echo "      3   If any ongoing git operation is in progress"
-    echo "      4   If not inside a git repository"
-    echo ""
-    echo "      Exit any other value on error or if 'precheck' operation is"
-    echo "      not completed, such as when viewing this help text."
-    exit 128
-}
+docs() { exec man 1 git-precheck; }
 
 quiet=""
 opt_dirty="true"
@@ -40,8 +11,8 @@ while true; do
         --quiet) quiet="true" ;;
         --ignore-dirty) opt_dirty="" ;;
         --ignore-untracked) opt_untracked="" ;;
-        --help) usage ;;
-        -h) usage ;;
+        --help) docs ;;
+        -h) docs ;;
         *) break
     esac
     shift