Mercurial > hg-stable
changeset 4390:052062b98f26
Flesh out bisect help text
| author | Brendan Cully <brendan@kublai.com> |
|---|---|
| date | Sun, 29 Apr 2007 17:35:03 -0700 |
| parents | 6186b6cba8ea |
| children | 722417b3d7fa |
| files | hgext/hbisect.py |
| diffstat | 1 files changed, 15 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/hgext/hbisect.py Sun Apr 29 12:33:24 2007 -0500 +++ b/hgext/hbisect.py Sun Apr 29 17:35:03 2007 -0700 @@ -252,8 +252,21 @@ return 0 def bisect_run(ui, repo, cmd=None, *args): - """bisect extension: dichotomic search in the DAG of changesets -for subcommands see "hg bisect help\" + """Dichotomic search in the DAG of changesets + +This extension helps to find changesets which cause problems. +To use, mark the earliest changeset you know introduces the problem +as bad, then mark the latest changeset which is free from the problem +as good. Bisect will update your working directory to a revision for +testing. Once you have performed tests, mark the working directory +as bad or good and bisect will either update to another candidate +changeset or announce that it has found the bad revision. + +Note: bisect expects bad revisions to be descendants of good revisions. +If you are looking for the point at which a problem was fixed, then make +the problem-free state "bad" and the problematic state "good." + +For subcommands see "hg bisect help\" """ def help_(cmd=None, *args): """show help for a given bisect subcommand or all subcommands"""