From d025524d9d85b057c3caae68a8398eaf7ba3be1a Mon Sep 17 00:00:00 2001 From: Fredrik Kuivinen Date: Sun, 11 Dec 2005 10:55:49 +0100 Subject: Usage message clean-up, take #2 There were some problems with the usage message clean-up patch series. I hadn't realised that subdirectory aware scripts can't source git-sh-setup. I propose that we change this and let the scripts which are subdirectory aware set a variable, SUBDIRECTORY_OK, before they source git-sh-setup. The scripts will also set USAGE and possibly LONG_USAGE before they source git-sh-setup. If LONG_USAGE isn't set it defaults to USAGE. If we go this way it's easy to catch --help in git-sh-setup, print the (long) usage message to stdout and exit cleanly. git-sh-setup can define a 'usage' shell function which can be called by the scripts to print the short usage string to stderr and exit non-cleanly. It will also be easy to change $0 to basename $0 or something else, if would like to do that sometime in the future. What follows is a patch to convert a couple of the commands to this style. If it's ok with everyone to do it this way I will convert the rest of the scripts too. [jc: thrown in to proposed updates queue for comments.] Signed-off-by: Junio C Hamano diff --git a/git-bisect.sh b/git-bisect.sh index 05dae8a..51e1e44 100755 --- a/git-bisect.sh +++ b/git-bisect.sh @@ -1,4 +1,15 @@ #!/bin/sh + +USAGE='[start|bad|good|next|reset|visualize]' +LONG_USAGE='git bisect start [] reset bisect state and start bisection. +git bisect bad [] mark a known-bad revision. +git bisect good [...] mark ... known-good revisions. +git bisect next find next bisection to test and check it out. +git bisect reset [] finish bisection search and go back to branch. +git bisect visualize show bisect status in gitk. +git bisect replay replay bisection log +git bisect log show bisect log.' + . git-sh-setup sq() { @@ -11,19 +22,6 @@ sq() { ' "$@" } -usage() { - echo >&2 'usage: git bisect [start|bad|good|next|reset|visualize] -git bisect start [] reset bisect state and start bisection. -git bisect bad [] mark a known-bad revision. -git bisect good [...] mark ... known-good revisions. -git bisect next find next bisection to test and check it out. -git bisect reset [] finish bisection search and go back to branch. -git bisect visualize show bisect status in gitk. -git bisect replay replay bisection log -git bisect log show bisect log.' - exit 1 -} - bisect_autostart() { test -d "$GIT_DIR/refs/bisect" || { echo >&2 'You need to start by "git bisect start"' diff --git a/git-branch.sh b/git-branch.sh index 5306b27..0266f462 100755 --- a/git-branch.sh +++ b/git-branch.sh @@ -1,21 +1,12 @@ #!/bin/sh -GIT_DIR=`git-rev-parse --git-dir` || exit $? - -die () { - echo >&2 "$*" - exit 1 -} - -usage () { - echo >&2 "usage: $(basename $0)"' [-d ] | [[-f] [start-point]] - -If no arguments, show available branches and mark current branch with a star. +USAGE='[-d ] | [[-f] [start-point]]' +LONG_USAGE='If no arguments, show available branches and mark current branch with a star. If one argument, create a new branch based off of current HEAD. -If two arguments, create a new branch based off of . -' - exit 1 -} +If two arguments, create a new branch based off of .' + +SUBDIRECTORY_OK='Yes' +. git-sh-setup headref=$(git-symbolic-ref HEAD | sed -e 's|^refs/heads/||') diff --git a/git-sh-setup.sh b/git-sh-setup.sh index b4f1022..1e638e4 100755 --- a/git-sh-setup.sh +++ b/git-sh-setup.sh @@ -11,13 +11,37 @@ # exporting it. unset CDPATH -: ${GIT_DIR=.git} -: ${GIT_OBJECT_DIRECTORY="$GIT_DIR/objects"} - die() { echo >&2 "$@" exit 1 } -# Make sure we are in a valid repository of a vintage we understand. -GIT_DIR="$GIT_DIR" git-var GIT_AUTHOR_IDENT >/dev/null || exit +usage() { + die "Usage: $0 $USAGE" +} + +if [ -z "$LONG_USAGE" ] +then + LONG_USAGE="Usage: $0 $USAGE" +else + LONG_USAGE="Usage: $0 $USAGE + +$LONG_USAGE" +fi + +case "$1" in + --h|--he|--hel|--help) + echo "$LONG_USAGE" + exit +esac + +if [ -z "$SUBDIRECTORY_OK" ] +then + : ${GIT_DIR=.git} + : ${GIT_OBJECT_DIRECTORY="$GIT_DIR/objects"} + + # Make sure we are in a valid repository of a vintage we understand. + GIT_DIR="$GIT_DIR" git-var GIT_AUTHOR_IDENT >/dev/null || exit +else + GIT_DIR=$(git-rev-parse --git-dir) || exit +fi diff --git a/git-status.sh b/git-status.sh index 2dda0c5..50ccd24 100755 --- a/git-status.sh +++ b/git-status.sh @@ -2,7 +2,16 @@ # # Copyright (c) 2005 Linus Torvalds # -GIT_DIR=$(git-rev-parse --git-dir) || exit + +USAGE='' +SUBDIRECTORY_OK='Yes' + +. git-sh-setup + +if [ "$#" != "0" ] +then + usage +fi report () { header="# -- cgit v0.10.2-6-g49f6 From aa9dc7afd2fc40466b430b35fc5c82d3c820cb26 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 12 Dec 2005 23:38:47 -0800 Subject: t3200: branch --help does not die anymore. Signed-off-by: Junio C Hamano diff --git a/t/t3200-branch.sh b/t/t3200-branch.sh index 36f7749..c3de151 100755 --- a/t/t3200-branch.sh +++ b/t/t3200-branch.sh @@ -16,8 +16,8 @@ test_expect_success \ git-update-index --add A && git-commit -m "Initial commit."' -test_expect_failure \ - 'git branch --help should return error code' \ +test_expect_success \ + 'git branch --help should return success now.' \ 'git-branch --help' test_expect_failure \ -- cgit v0.10.2-6-g49f6 From 806f36d4d7caf75b6d3e098cb0353d85d3477c7d Mon Sep 17 00:00:00 2001 From: "freku045@student.liu.se" Date: Tue, 13 Dec 2005 23:30:31 +0100 Subject: Trivial usage string clean-up Signed-off-by: Fredrik Kuivinen Signed-off-by: Junio C Hamano diff --git a/git-add.sh b/git-add.sh index fdec86d..f719b4b 100755 --- a/git-add.sh +++ b/git-add.sh @@ -1,13 +1,8 @@ #!/bin/sh -die () { - echo >&2 "$*" - exit 1 -} - -usage() { - die "usage: git add [-n] [-v] ..." -} +USAGE='[-n] [-v] ...' +SUBDIRECTORY_OK='Yes' +. git-sh-setup show_only= verbose= @@ -29,8 +24,6 @@ while : ; do shift done -GIT_DIR=$(git-rev-parse --git-dir) || exit - if test -f "$GIT_DIR/info/exclude" then git-ls-files -z \ diff --git a/git-applymbox.sh b/git-applymbox.sh index c686cc8..61c8c02 100755 --- a/git-applymbox.sh +++ b/git-applymbox.sh @@ -18,13 +18,9 @@ ## ## git-am is supposed to be the newer and better tool for this job. +USAGE='[-u] [-k] [-q] [-m] (-c .dotest/ | mbox) [signoff]' . git-sh-setup -usage () { - echo >&2 "applymbox [-u] [-k] [-q] [-m] (-c .dotest/ | mbox) [signoff]" - exit 1 -} - keep_subject= query_apply= continue= utf8= resume=t while case "$#" in 0) break ;; esac do diff --git a/git-checkout.sh b/git-checkout.sh index 4cf30e2..f241d4b 100755 --- a/git-checkout.sh +++ b/git-checkout.sh @@ -1,9 +1,7 @@ #!/bin/sh -. git-sh-setup -usage () { - die "usage: git checkout [-f] [-b ] [] [...]" -} +USAGE='[-f] [-b ] [] [...]' +. git-sh-setup old=$(git-rev-parse HEAD) new= diff --git a/git-clone.sh b/git-clone.sh index e49028f..280cc2e 100755 --- a/git-clone.sh +++ b/git-clone.sh @@ -9,7 +9,7 @@ unset CDPATH usage() { - echo >&2 "* git clone [-l [-s]] [-q] [-u ] [-n] []" + echo >&2 "Usage: $0 [-l [-s]] [-q] [-u ] [-n] []" exit 1 } diff --git a/git-commit.sh b/git-commit.sh index 3d250ec..7e39c10 100755 --- a/git-commit.sh +++ b/git-commit.sh @@ -3,12 +3,9 @@ # Copyright (c) 2005 Linus Torvalds # +USAGE='[-a] [-s] [-v | --no-verify] [-m | -F | (-C|-c) ] [-e] [...]' . git-sh-setup -usage () { - die 'git commit [-a] [-s] [-v | --no-verify] [-m | -F | (-C|-c) ] [-e] [...]' -} - all= logfile= use_commit= no_edit= log_given= log_message= verify=t signoff= while case "$#" in 0) break;; esac do diff --git a/git-format-patch.sh b/git-format-patch.sh index 921feee..01508e3 100755 --- a/git-format-patch.sh +++ b/git-format-patch.sh @@ -3,19 +3,8 @@ # Copyright (c) 2005 Junio C Hamano # -. git-sh-setup - -# Force diff to run in C locale. -LANG=C LC_ALL=C -export LANG LC_ALL - -usage () { - echo >&2 "usage: $0"' [-n] [-o dir | --stdout] [--keep-subject] [--mbox] - [--check] [--signoff] [-...] - [--help] - ( from..to ... | upstream [ our-head ] ) - -Prepare each commit with its patch since our-head forked from upstream, +USAGE='[-n | -k] [-o | --stdout] [--signoff] [--check] [--mbox] [--diff-options] []' +LONG_USAGE='Prepare each commit with its patch since our-head forked from upstream, one file per patch, for e-mail submission. Each output file is numbered sequentially from 1, and uses the first line of the commit message (massaged for pathname safety) as the filename. @@ -28,10 +17,12 @@ as "[PATCH N/M] Subject", unless you have only one patch. When --mbox is specified, the output is formatted to resemble UNIX mailbox format, and can be concatenated together for processing -with applymbox. -' - exit 1 -} +with applymbox.' +. git-sh-setup + +# Force diff to run in C locale. +LANG=C LC_ALL=C +export LANG LC_ALL diff_opts= LF=' diff --git a/git-grep.sh b/git-grep.sh index 44c1613..2ed8e95 100755 --- a/git-grep.sh +++ b/git-grep.sh @@ -3,6 +3,10 @@ # Copyright (c) Linus Torvalds, 2005 # +USAGE='