mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

move unimplemented option to todo

Browse source
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
Download patch file Download diff file Expand all files Collapse all files

12
doc/special_remotes/borg.mdwn
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

12
doc/todo/borg_special_remote_add_subdir_config.mdwn Normal file
View file

@ -0,0 +1,12 @@
Sometimes a borg backup contains several git-annex repos. Then pointing
git-annex at the whole thing will find objects not belonging to the current
repo. To avoid this, add this option:
* `subdir` - A subdirectory within the borg repository where git-annex
should look 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. The default is to look through the
whole repository.
This is useful to avoid finding object files in the borg repository
that belong to unrelated git-annex repositories.