git-annex/doc/git-annex-dead.mdwn
Joey Hess bcf276655c
Keys marked as dead are now skipped by --all.
fsck already special-cased dead keys to make --all not report errors with
them, and it makes sense to also expand that to whereis. I think it makes
sense for dead keys to be skipped by all uses of --all, so mistakes can be
completely forgotten about and not come back to haunt us.

The speed impact of testing if the key is dead is negligible for fsck and
whereis, since they use the location log anyway and it gets cached.
This does slow down a few commands that support --all, in particular
metadata --all runs around 2x as slow. I don't think metadata
--all is often used though. It might slow down copy/move/mirror
--all and get --all.
log --all is not affected (does not use the normal --all machinery).

Dead keys will still be processed by --incomplete, --branch,
--failed, and --key. Although it would be unlikely for a dead key to
ave in incomplete or failed transfer. It seems to make perfect sense for
--branch to process keys on the branch, even if dead.

(fsck's special-casing of dead keys was left in, so if one of these options
causes a dead key to be fscked, there will be a nice message.)

This commit was supported by the NSF-funded DataLad project.
2017-05-09 12:55:21 -04:00

45 lines
1.1 KiB
Markdown

# NAME
git-annex dead - hide a lost repository or key
# SYNOPSIS
git annex dead `[repository ...] [--key key]`
# DESCRIPTION
This command exists to deal with situations where data has been lost,
and you know it has, and you want to stop being reminded of that fact.
When a repository is specified, indicates that the repository has
been irretrievably lost, so it will not be listed in eg, `git annex info`.
Repositories can be specified using their remote name, their
description, or their UUID. (To undo, use `git-annex semitrust`.)
When a key is specified, indicates that the content of that key has been
irretrievably lost. This prevents commands like `git annex fsck --all`
from complaining about it; `--all` will not operate on the key anymore.
(To undo, add the key's content back to the repository,
by using eg, `git-annex reinject`.)
# SEE ALSO
[[git-annex]](1)
[[git-annex-trust]](1)
[[git-annex-semitrust]](1)
[[git-annex-untrust]](1)
[[git-annex-expire]](1)
[[git-annex-fsck]](1)
[[git-annex-reinject]](1)
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.