summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess <joey@kitenet.net>2014-02-24 20:14:19 -0400
committerJoey Hess <joey@kitenet.net>2014-02-24 20:14:19 -0400
commitc7854d2734db2af11ccaf5282b7f22398ed6301b (patch)
tree359cd25f7309b691a85dbc80038b21801da96afe
parent313f29e64caa94faac481523fa78d1185f377d83 (diff)
downloadgit-repair-c7854d2734db2af11ccaf5282b7f22398ed6301b.tar.gz
document testing in man page
-rw-r--r--git-repair.112
1 files changed, 12 insertions, 0 deletions
diff --git a/git-repair.1 b/git-repair.1
index 146840f..7780095 100644
--- a/git-repair.1
+++ b/git-repair.1
@@ -28,6 +28,18 @@ stash.
.PP
Since this command unpacks all packs in the repository, you may want to
run \fBgit gc\fP afterwards.
+.SH TESTING
+git-repair is able to test itself, by making a temporary copy
+of the git reposiory it's run in, damaging it in random ways, and checking
+that it can repair it so that git fsck reports no problems.
+.PP
+This is done using the --test parameter and associated --numtests and
+--retry parameters.
+.PP
+Note that the testing will sometimes find repositories that can only be
+repaired when --force is used; this is expected. On the other hand,
+if it fails to recover a repository with --force, then the testing has
+found a bug!
.PP
.SH AUTHOR
Joey Hess <joey@kitenet.net>