document describe command

This commit is contained in:
Joey Hess 2011-03-03 16:58:52 -04:00
parent b5b78f26ec
commit 1de12a2918
3 changed files with 46 additions and 17 deletions

View file

@ -0,0 +1,18 @@
So you lost a thumb drive containing a git-annex repository. Or a hard
drive died or some other misfortune has befallen your data.
Unless you configured backups, git-annex can't get your data back. But it
can help you deal with the loss.
First, go somewhere that knows about the lost repository, and mark it as
untrusted.
# git annex untrust usbdrive
To remind yourself later what happened, you can change its description, too:
# git annex describe usbdrive "USB drive lost in Timbuktu. Probably gone forever."
This retains the [[location_tracking]] information for the repository.
Maybe you'll find the drive later. Maybe that's impossible. Either way,
this lets git-annex tell you why a file is no longer accessible.