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

update documentation for new, neutered key-value backends

Browse source 
Backends are now only used to generate keys (and check them); they
are not arbitrary key-value stores for data, because it turned out such
a store is better modeled as a special remote. Updated docs to not
imply backends do more than they do now.

Sometimes I'm tempted to rename "backend" to "keytype" or something,
which would really be more clear. But it would be an annoying transition
for users, with annex.backends etc.
This commit is contained in:
Joey Hess 2011-08-28 16:28:38 -04:00
parent 999d5df90b
commit bbba6c19bd
5 changed files with 29 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

10
doc/walkthrough/fsck:_verifying_your_data.mdwn
View file

@ -1,8 +1,8 @@
You can use the fsck subcommand to check for problems in your data.
What can be checked depends on the [[backend|backends]] you've used to store
the data. For example, when you use the SHA1 backend, fsck will verify that
the checksums of your files are good. Fsck also checks that the annex.numcopies
setting is satisfied for all files.
You can use the fsck subcommand to check for problems in your data. What
can be checked depends on the key-value [[backend|backends]] you've used
for the data. For example, when you use the SHA1 backend, fsck will verify
that the checksums of your files are good. Fsck also checks that the
annex.numcopies setting is satisfied for all files.
# git annex fsck
fsck some_file (checksum...) ok

2
doc/walkthrough/unused_data.mdwn
View file

@ -2,7 +2,7 @@ It's possible for data to accumulate in the annex that no files point to
anymore. One way it can happen is if you `git rm` a file without
first calling `git annex drop`. And, when you modify an annexed file, the old
content of the file remains in the annex. Another way is when migrating
between backends.
between key-value [[backends|backend]].
This might be historical data you want to preserve, so git-annex defaults to
preserving it. So from time to time, you may want to check for such data and