From c4b6c80122d5300d38cad0f0a4f4696d0d39bef7 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Mon, 18 Nov 2013 13:21:19 -0400 Subject: page --- doc/index.mdwn | 43 +++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 41 insertions(+), 2 deletions(-) diff --git a/doc/index.mdwn b/doc/index.mdwn index b8b43b1..e924db8 100644 --- a/doc/index.mdwn +++ b/doc/index.mdwn @@ -1,3 +1,42 @@ -This is my wiki. There's nothing here yet. +`git-repair` can repair various forms of damage to git repositories. -All wikis are supposed to have a [[SandBox]], so this one does too. +It is a complement to `git fsck`, which finds problems, but does not fix +them. + +## install + +This is a Haskell program, developed as a spinoff of +[git-annex](http://git-annex.branchable.com/). + +You can clone the source `git clone git://git-repair.branchable.com/ git-repair` + +To build it, you will need to install the +[Haskell Platform](http://www.haskell.org/platform/). + +Then you can run `cabal update; cabal install git-repair --bindir=$HOME/bin` + +## how it works + +`git-repair` starts 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, delete +branches that are no longer available due to the lost data, and remove any +missing files from the index. It will only do this if run with the +`--force` option, since that rewrites history and throws out 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, +or the stash, if they were unable to be recovered. This command does not +try to clean up either the reflog or the stash. + +Also note that the `--force` option never touches tags, even if they are no +longer usable due to missing data, so fack may also find problems with +tags. + +Since this command unpacks all packs in the repository, you may want to +run `git gc`afterwards. -- cgit v1.2.3