summaryrefslogtreecommitdiff
path: root/Documentation/git-bisect.txt
diff options
context:
space:
mode:
authorChristian Couder <chriscool@tuxfamily.org>2008-04-11 03:55:21 (GMT)
committerJunio C Hamano <gitster@pobox.com>2008-04-12 06:03:50 (GMT)
commit243a60fbb5e185e2bf3c4bb1c53128b4d04d5879 (patch)
tree8a067f0b2617cfa70618213530243747dd0b8338 /Documentation/git-bisect.txt
parent3c5283f8b19aaba3a6105fa486cabe4d0ca48009 (diff)
downloadgit-243a60fbb5e185e2bf3c4bb1c53128b4d04d5879.zip
git-243a60fbb5e185e2bf3c4bb1c53128b4d04d5879.tar.gz
git-243a60fbb5e185e2bf3c4bb1c53128b4d04d5879.tar.bz2
bisect: add "git bisect help" subcommand to get a long usage string
Users are not often aware of the fact that "git bisect -h" can give them a long usage description, as "git bisect" seems to accept only dashless subcommands like "start", "good", ... That's why this patch adds a "git bisect help" subcommand that just calls "git bisect -h". This new subcommand is also fully documented in the short usage string (that "git bisect" gives), in the long usage string and in the man page (that "git help bisect" gives). Signed-off-by: Christian Couder <chriscool@tuxfamily.org> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'Documentation/git-bisect.txt')
-rw-r--r--Documentation/git-bisect.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/git-bisect.txt b/Documentation/git-bisect.txt
index 96585ae..698ffde 100644
--- a/Documentation/git-bisect.txt
+++ b/Documentation/git-bisect.txt
@@ -15,6 +15,7 @@ DESCRIPTION
The command takes various subcommands, and different options depending
on the subcommand:
+ git bisect help
git bisect start [<bad> [<good>...]] [--] [<paths>...]
git bisect bad [<rev>]
git bisect good [<rev>...]
@@ -29,6 +30,12 @@ This command uses 'git-rev-list --bisect' option to help drive the
binary search process to find which change introduced a bug, given an
old "good" commit object name and a later "bad" commit object name.
+Getting help
+~~~~~~~~~~~~
+
+Use "git bisect" to get a short usage description, and "git bisect
+help" or "git bisect -h" to get a long usage description.
+
Basic bisect commands: start, bad, good
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~