move unimplemented option to todo

This commit is contained in:
Joey Hess 2020-12-22 16:28:13 -04:00
parent cd4c68924b
commit a2fe994ebb
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
2 changed files with 13 additions and 11 deletions

View file

@ -14,19 +14,9 @@ remote:
* `borgrepo` - The location of a borg repository, eg a path, or
`user@host:path` for ssh access.
* `scan` - The path, within the borg repository, to scan for
annex object files. This can be the path to a git-annex repository,
or perhaps a non-encrypted special remote, or a path that contains
several repositories.
Information about all annex objects in the path will be
added to the git-annex branch when syncing with the borg repository.
So, it's best to avoid a path that contains object files for unrelated
git-annex repositories.
## setup example
# borg init --encryption=keyfile /path/to/borgrepo
# git annex initremote borg type=borg borgrepo=/path/to/borgrepo scan=`pwd`
# git annex initremote borg type=borg borgrepo=/path/to/borgrepo
# borg create /path/to/borgrepo `pwd`::{now}
# git annex sync borg