git-annex/doc/git-annex-repair.mdwn

# NAME

git-annex repair - recover broken git repository

# SYNOPSIS

git annex repair

# DESCRIPTION

This can repair many of the problems with git repositories that `git fsck`
detects, but does not itself fix. It's useful if a repository has become
badly damaged. One way this can happen is if a repository used by git-annex
is on a removable drive that gets unplugged at the wrong time.
  
This command can actually be used inside git repositories that do not
use git-annex at all; when used in a repository using git-annex, it
does additional repairs of the git-annex branch.
  
It works by deleting any corrupt objects from the git repository, and
retrieving all missing objects 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.
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, or the stash, if they were unable to be
recovered. This command does not try to clean up either the reflog or the
stash.
  
It is also a good idea to run `git annex fsck --fast` after this command,
to make sure that the git-annex branch reflects reality.

# OPTIONS

* `--force`

  Enable repair actions that involve deleting data that has been
  lost due to git repository corruption.

* Also the [[git-annex-common-options]](1) can be used.

# SEE ALSO

[[git-annex]](1)

[[git-annex-fsck]](1)

# AUTHOR

Joey Hess <id@joeyh.name>

Warning: Automatically converted into a man page by mdwn2man. Edit with care.
separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00			`# NAME`

			`git-annex repair - recover broken git repository`

			`# SYNOPSIS`

			`git annex repair`

			`# DESCRIPTION`

			This can repair many of the problems with git repositories that `git fsck`
			`detects, but does not itself fix. It's useful if a repository has become`
			`badly damaged. One way this can happen is if a repository used by git-annex`
			`is on a removable drive that gets unplugged at the wrong time.`

			`This command can actually be used inside git repositories that do not`
			`use git-annex at all; when used in a repository using git-annex, it`
			`does additional repairs of the git-annex branch.`

			`It works by deleting any corrupt objects from the git repository, and`
			`retrieving all missing objects 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.
			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, or the stash, if they were unable to be`
			`recovered. This command does not try to clean up either the reflog or the`
			`stash.`

			It is also a good idea to run `git annex fsck --fast` after this command,
			`to make sure that the git-annex branch reflects reality.`

			`# OPTIONS`

			* `--force`

			`Enable repair actions that involve deleting data that has been`
			`lost due to git repository corruption.`

split out common options to its own page and mention it on each subcommand page Sometimes users would get confused because an option they were looking for was not mentioned on a subcommand's man page, and they had not noticed that the main git-annex man page had a list of common options. This change lets each subcommand mention the common options, similarly to how the matching options are handled. This commit was sponsored by Svenne Krap on Patreon. 2021-05-10 19:00:13 +00:00			`* Also the [[git-annex-common-options]](1) can be used.`

separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00			`# SEE ALSO`

expand manpages cross-references significantly i found that most man pages only had references to the main git-annex manpage, which i stillfind pretty huge and hard to navigate through. i tried to sift through all the man pages and add cross-references between relevant pages. my general rule of thumb is that links should be both ways unless one of the pages is a more general page that would become ridiculously huge if all backlinks would be added (git-annex-preferred-content comes to mind). i have also make the links one per line as this is how it was done in the metadata pages so far. i did everything but the plumbing, utility and test commands, although some of those are linked from the other commands so cross-links were added there as well. 2015-05-29 16:12:55 +00:00			`[[git-annex]](1)`

			`[[git-annex-fsck]](1)`
separated man pages for all the maintenance commands 2015-03-24 19:23:59 +00:00
			`# AUTHOR`

			`Joey Hess <id@joeyh.name>`

			`Warning: Automatically converted into a man page by mdwn2man. Edit with care.`