diff options
| author |  Joey Hess <joey@kitenet.net> | 2011-08-28 16:28:38 -0400 |
|---|---|---|
| committer | Joey Hess <joey@kitenet.net> | 2011-08-28 16:28:38 -0400 |
| commit | bbba6c19bd03f2b4a4ce8a38a2423c794826b1c5 (patch) | |
| tree | 56f50f9c23018f5c4479a0503e1e6c9dcd57c83e /doc/git-annex.mdwn | |
| parent | 999d5df90b013a7cc8a390c940785118400faf8a (diff) | |
update documentation for new, neutered key-value backends
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.
Diffstat (limited to 'doc/git-annex.mdwn')
| -rw-r--r-- | doc/git-annex.mdwn | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn index a262d465f..52599611e 100644 --- a/doc/git-annex.mdwn +++ b/doc/git-annex.mdwn @@ -72,15 +72,15 @@ Many git-annex commands will stage changes for later `git commit` by you. * get [path ...] - Makes the content of annexed files available in this repository. Depending - on the backend used, this will involve copying them from another repository, - or downloading them, or transferring them from some kind of key-value store. + Makes the content of annexed files available in this repository. This + will involve copying them from another repository, or downloading them, + or transferring them from some kind of key-value store. * drop [path ...] Drops the content of annexed files from this repository. - git-annex may refuse to drop content if the backend does not think + git-annex may refuse to drop content if it does not think it is safe to do so, typically because of the setting of annex.numcopies. * move [path ...] @@ -207,14 +207,14 @@ Many git-annex commands will stage changes for later `git commit` by you. * migrate [path ...] - Changes the specified annexed files to store their content in the - default backend (or the one specified with --backend). Only files whose - content is currently available are migrated. + Changes the specified annexed files to use the default key-value backend + (or the one specified with --backend). Only files whose content + is currently available are migrated. - Note that the content is not removed from the backend it was previously in. - Use `git annex unused` to find and remove such content. + Note that the content is also still available using the old key after + migration. Use `git annex unused` to find and remove the old key. - Normally, nothing will be done to files already in the backend. + Normally, nothing will be done to files already using the new backend. However, if a backend changes the information it uses to construct a key, this can also be used to migrate files to use the new key format. @@ -293,7 +293,7 @@ Many git-annex commands will stage changes for later `git commit` by you. * fromkey file This plumbing-level command can be used to manually set up a file - to link to a specified key in the key-value backend. + in the git repository to link to a specified key. * dropkey [key ...] @@ -500,8 +500,8 @@ Here are all the supported configuration settings. # CONFIGURATION VIA .gitattributes -The backend used when adding a new file to the annex can be configured -on a per-file-type basis via `.gitattributes` files. In the file, +The key-value backend used when adding a new file to the annex can be +configured on a per-file-type basis via `.gitattributes` files. In the file, the `annex.backend` attribute can be set to the name of the backend to use. For example, this here's how to use the WORM backend by default, but the SHA1 backend for ogg files: |