{"thread":{"id":"13060","subject":"[PATCH] bisect: add \"git bisect help\" subcommand to get a long usage string","startedAt":"2008-04-11T03:55:21Z","lastAt":"2008-04-11T03:55:21Z","messageCount":1,"participants":["Christian Couder"],"isPatch":true,"patchVersion":1,"patchTotal":null},"messages":[{"id":"74110","messageId":"20080411055521.b2fe90b3.chriscool@tuxfamily.org","threadId":"13060","inReplyTo":null,"subject":"[PATCH] bisect: add \"git bisect help\" subcommand to get a long usage string","fromName":"Christian Couder","fromEmail":"chriscool@tuxfamily.org","sentAt":"2008-04-11T03:55:21Z","receivedAt":"2008-04-11T03:55:21Z","isPatch":true,"sender":{"key":"christian.couder@gmail.com","avatar":"https://avatars.githubusercontent.com/u/208954?v=4"},"body":"Users are not often aware of the fact that \"git bisect -h\" can give\nthem a long usage description, as \"git bisect\" seems to accept only\ndashless subcommands like \"start\", \"good\", ...\n\nThat's why this patch adds a \"git bisect help\" subcommand that just\ncalls \"git bisect -h\". This new subcommand is also fully documented\nin the short usage string (that \"git bisect\" gives), in the long\nusage string and in the man page (that \"git help bisect\" gives).\n\nSigned-off-by: Christian Couder <chriscool@tuxfamily.org>\n---\n Documentation/git-bisect.txt |    7 +++++++\n git-bisect.sh                |   12 +++++++++---\n 2 files changed, 16 insertions(+), 3 deletions(-)\n\n\tIngo,\n\n\tHere is a first step to help users help themselves when using\n\tgit bisect.\n\n\tThanks.\n\ndiff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt\nindex 96585ae..698ffde 100644\n--- a/Documentation/git-bisect.txt\n+++ b/Documentation/git-bisect.txt\n@@ -15,6 +15,7 @@ DESCRIPTION\n The command takes various subcommands, and different options depending\n on the subcommand:\n \n+ git bisect help\n  git bisect start [<bad> [<good>...]] [--] [<paths>...]\n  git bisect bad [<rev>]\n  git bisect good [<rev>...]\n@@ -29,6 +30,12 @@ This command uses 'git-rev-list --bisect' option to help drive the\n binary search process to find which change introduced a bug, given an\n old \"good\" commit object name and a later \"bad\" commit object name.\n \n+Getting help\n+~~~~~~~~~~~~\n+\n+Use \"git bisect\" to get a short usage description, and \"git bisect\n+help\" or \"git bisect -h\" to get a long usage description.\n+\n Basic bisect commands: start, bad, good\n ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n \ndiff --git a/git-bisect.sh b/git-bisect.sh\nindex 48fb92d..a1343f6 100755\n--- a/git-bisect.sh\n+++ b/git-bisect.sh\n@@ -1,7 +1,9 @@\n #!/bin/sh\n \n-USAGE='[start|bad|good|skip|next|reset|visualize|replay|log|run]'\n-LONG_USAGE='git bisect start [<bad> [<good>...]] [--] [<pathspec>...]\n+USAGE='[help|start|bad|good|skip|next|reset|visualize|replay|log|run]'\n+LONG_USAGE='git bisect help\n+        print this long help message.\n+git bisect start [<bad> [<good>...]] [--] [<pathspec>...]\n         reset bisect state and start bisection.\n git bisect bad [<rev>]\n         mark <rev> a known-bad revision.\n@@ -20,7 +22,9 @@ git bisect replay <logfile>\n git bisect log\n         show bisect log.\n git bisect run <cmd>...\n-        use <cmd>... to automatically bisect.'\n+        use <cmd>... to automatically bisect.\n+\n+Please use \"git help bisect\" to get the full man page.'\n \n OPTIONS_SPEC=\n . git-sh-setup\n@@ -465,6 +469,8 @@ case \"$#\" in\n     cmd=\"$1\"\n     shift\n     case \"$cmd\" in\n+    help)\n+        git bisect -h ;;\n     start)\n         bisect_start \"$@\" ;;\n     bad|good|skip)\n-- \n1.5.5.44.g62b31.dirty\n"}]}