summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/git-recover-repository.mdwn16
1 files changed, 13 insertions, 3 deletions
diff --git a/doc/git-recover-repository.mdwn b/doc/git-recover-repository.mdwn
index b05903d14..d4972e961 100644
--- a/doc/git-recover-repository.mdwn
+++ b/doc/git-recover-repository.mdwn
@@ -15,9 +15,19 @@ It does by deleting all corrupt objects, and retreiving all missing
objects that it can from the remotes of the repository.
If that is not sufficient to fully recover the repository, it can also
-reset branches back to commits before the corruption happened. It will only
-do this if run with the --force option, since that rewrites history
-and throws out missing data.
+reset branches back to commits before the corruption happened, and delete
+branches that are no longer available due to the lost data. It will only
+do this if run with the `--force` option, since that rewrites history
+and throws out missing data. Note that the `--force` option never touches
+tags, even if they are no longer usable due to missing data.
+
+After running this command, you will probably want to run `git fsck` to
+verify it fixed the repository. Note that fsck may still complain about
+objects referenced by the reflog, if they were unable to be recovered.
+Use `git fsck --no-reflogs` to skip such objects.
+
+Since this command unpacks all packs in the repository, you may want to
+run `git gc` afterwards.
# AUTHOR