added details about the URL backend

This commit is contained in:
Ilya_Shlyakhter 2018-10-12 20:28:25 +00:00 committed by admin
parent 99731fd3d1
commit 209184a798

View file

@ -46,7 +46,12 @@ content of an annexed file remains unchanged.
files or slow systems.
* `URL` -- This is a key that is generated from the url to a file.
It's generated when using eg, `git annex addurl --fast`, when the file
content is not available for hashing.
content is not available for hashing. The key may not contain the full
URL; for long URLs, part of the URL may be represented by a checksum.
The URL key may contain `&` characters; be sure to quote the key if
passing it to a shell script. The URL-backend key is distinct from URLs/URIs
that may be attached to a key (from any backend) indicating the key's location
on the web or in one of [[special_remotes]].
If you want to be able to prove that you're working with the same file
contents that were checked into a repository earlier, you should avoid
@ -75,3 +80,5 @@ in `.gitattributes`:
* annex.backend=WORM
*.mp3 annex.backend=SHA256E
*.ogg annex.backend=SHA256E
See also: [[git-annex-examinekey]]