Skip to content

Commit 88d7891

Browse files
jonseymourgitster
authored andcommitted
bisect: add documentation for --no-checkout option.
Signed-off-by: Jon Seymour <[email protected]> Signed-off-by: Junio C Hamano <[email protected]>
1 parent b704a8b commit 88d7891

File tree

1 file changed

+31
-1
lines changed

1 file changed

+31
-1
lines changed

Documentation/git-bisect.txt

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ The command takes various subcommands, and different options depending
1717
on the subcommand:
1818

1919
git bisect help
20-
git bisect start [<bad> [<good>...]] [--] [<paths>...]
20+
git bisect start [--no-checkout] [<bad> [<good>...]] [--] [<paths>...]
2121
git bisect bad [<rev>]
2222
git bisect good [<rev>...]
2323
git bisect skip [(<rev>|<range>)...]
@@ -263,6 +263,17 @@ rewind the tree to the pristine state. Finally the script should exit
263263
with the status of the real test to let the "git bisect run" command loop
264264
determine the eventual outcome of the bisect session.
265265

266+
OPTIONS
267+
-------
268+
--no-checkout::
269+
+
270+
Do not checkout the new working tree at each iteration of the bisection
271+
process. Instead just update a special reference named 'BISECT_HEAD' to make
272+
it point to the commit that should be tested.
273+
+
274+
This option may be useful when the test you would perform in each step
275+
does not require a checked out tree.
276+
266277
EXAMPLES
267278
--------
268279

@@ -343,6 +354,25 @@ $ git bisect run sh -c "make || exit 125; ~/check_test_case.sh"
343354
This shows that you can do without a run script if you write the test
344355
on a single line.
345356

357+
* Locate a good region of the object graph in a damaged repository
358+
+
359+
------------
360+
$ git bisect start HEAD <known-good-commit> [ <boundary-commit> ... ] --no-checkout
361+
$ git bisect run sh -c '
362+
GOOD=$(git for-each-ref "--format=%(objectname)" refs/bisect/good-*) &&
363+
git rev-list --objects BISECT_HEAD --not $GOOD >tmp.$$ &&
364+
git pack-objects --stdout >/dev/null <tmp.$$
365+
rc=$?
366+
rm -f tmp.$$
367+
test $rc = 0'
368+
369+
------------
370+
+
371+
In this case, when 'git bisect run' finishes, bisect/bad will refer to a commit that
372+
has at least one parent whose reachable graph is fully traversable in the sense
373+
required by 'git pack objects'.
374+
375+
346376
SEE ALSO
347377
--------
348378
link:git-bisect-lk2009.html[Fighting regressions with git bisect],

0 commit comments

Comments
 (0)