mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
git-annex/doc/git-annex-dead.mdwn

66 lines
1.5 KiB
Text
Raw Normal View History

separated man pages for all the setup commands while at the gate in ATL
2015-03-23 22:20:42 +00:00
# NAME
dead --key: Can be used to mark a key as dead.
2015-06-09 18:52:05 +00:00
git-annex dead - hide a lost repository or key
separated man pages for all the setup commands while at the gate in ATL
2015-03-23 22:20:42 +00:00
# SYNOPSIS
expire, trust et al, dead, describe: Support --json and --json-error-messages For expire, the normal output is unchanged, but the --json output includes the uuid in machine parseable form. Which could be very useful for this somewhat obscure command. That needed ActionItemUUID to be implemented, which seemed like a lot of work, but then --- I had been going to skip implementing them for trust, untrust, dead, semitrust, and describe, but putting the uuid in the json is useful information, it tells what uuid git-annex picked given the input. It was not hard to support these once ActionItemUUID was implemented. Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-05-05 19:29:49 +00:00
git annex dead `[repository ...] [--key somekey ...]`
separated man pages for all the setup commands while at the gate in ATL
2015-03-23 22:20:42 +00:00
# DESCRIPTION
dead --key: Can be used to mark a key as dead.
2015-06-09 18:52:05 +00:00
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.
separated man pages for all the setup commands while at the gate in ATL
2015-03-23 22:20:42 +00:00
dead --key: Can be used to mark a key as dead.
2015-06-09 18:52:05 +00:00
When a repository is specified, indicates that the repository has
info: Added --dead-repositories option I considered a more wide-ranging config option to make other commands also show dead repositories. But it would be difficult to implement that because Remote.keyLocations is used to get locations, filtering out dead repos, and commands like get then try to use those locations. So a config setting would make dead repos sometimes be acted on by commands. Sponsored-by: unqueued on Patreon
2023-08-09 16:43:48 +00:00
been irretrievably lost, so it will not be listed in eg, `git annex whereis`.
separated man pages for all the setup commands while at the gate in ATL
2015-03-23 22:20:42 +00:00
Repositories can be specified using their remote name, their
dead --key: Can be used to mark a key as dead.
2015-06-09 18:52:05 +00:00
description, or their UUID. (To undo, use `git-annex semitrust`.)
When a key is specified, indicates that the content of that key has been
fix reversion on skipping dead keys in --all/bare Fix a reversion that made dead keys not be skipped when operating on all keys via --all or in a bare repo. (Introduced in version 8.20200720) Also, improved the documentation of git-annex-dead, it does not only apply to fsck --all. Also, made git-annex fsck, when run on a file whose key is dead, display that. Before, it displayed that only when run with --all, but with this fix, it skips dead keys with --all. But it can still be run on a file that uses a dead key, and displaying "This key is dead" explains to the user why it does not consider missing content for it to be a problem. Sponsored-by: k0ld on Patreon
2022-09-13 18:38:13 +00:00
irretrievably lost. This makes the key be skipped when operating
on all keys with eg `--all`.
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 16:55:21 +00:00
(To undo, add the key's content back to the repository,
dead --key: Can be used to mark a key as dead.
2015-06-09 18:52:05 +00:00
by using eg, `git-annex reinject`.)
separated man pages for all the setup commands while at the gate in ATL
2015-03-23 22:20:42 +00:00
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
# OPTIONS
* `--key=somekey`
Use to specify a key that is dead.
expire, trust et al, dead, describe: Support --json and --json-error-messages For expire, the normal output is unchanged, but the --json output includes the uuid in machine parseable form. Which could be very useful for this somewhat obscure command. That needed ActionItemUUID to be implemented, which seemed like a lot of work, but then --- I had been going to skip implementing them for trust, untrust, dead, semitrust, and describe, but putting the uuid in the json is useful information, it tells what uuid git-annex picked given the input. It was not hard to support these once ActionItemUUID was implemented. Sponsored-By: the NIH-funded NICEMAN (ReproNim TR&D3) project
2023-05-05 19:29:49 +00:00
* `--json`
Enable JSON output. This is intended to be parsed by programs that use
git-annex. Each line of output is a JSON object.
* `--json-error-messages`
Messages that would normally be output to standard error are included in
the JSON instead.
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 setup commands while at the gate in ATL
2015-03-23 22:20:42 +00:00
# SEE ALSO
[[git-annex]](1)
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-trust]](1)
[[git-annex-semitrust]](1)
[[git-annex-untrust]](1)
added renameremote command
2019-04-15 17:05:44 +00:00
[[git-annex-renameremote]](1)
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-expire]](1)
dead --key: Can be used to mark a key as dead.
2015-06-09 18:52:05 +00:00
[[git-annex-fsck]](1)
[[git-annex-reinject]](1)
separated man pages for all the setup commands while at the gate in ATL
2015-03-23 22:20:42 +00:00
# AUTHOR
Joey Hess <id@joeyh.name>
Warning: Automatically converted into a man page by mdwn2man. Edit with care.
Reference in a new issue Copy permalink