download: Update docstring.

* guix/download.scm (url-fetch): Update docstring to match what's in the
manual.
This commit is contained in:
Ludovic Courtès 2020-10-20 09:32:05 +02:00
parent 6ea61b4818
commit d154462bd8
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5

View file

@ -463,17 +463,17 @@ (define* (url-fetch url hash-algo hash
#:key (system (%current-system)) #:key (system (%current-system))
(guile (default-guile)) (guile (default-guile))
executable?) executable?)
"Return a fixed-output derivation that fetches URL (a string, or a list of "Return a fixed-output derivation that fetches data from URL (a string, or a
strings denoting alternate URLs), which is expected to have hash HASH of type list of strings denoting alternate URLs), which is expected to have hash HASH
HASH-ALGO (a symbol). By default, the file name is the base name of URL; of type HASH-ALGO (a symbol). By default, the file name is the base name of
optionally, NAME can specify a different file name. When EXECUTABLE? is true, URL; optionally, NAME can specify a different file name. When EXECUTABLE? is
make the downloaded file executable. true, make the downloaded file executable.
When one of the URL starts with mirror://, then its host part is When one of the URL starts with mirror://, then its host part is
interpreted as the name of a mirror scheme, taken from %MIRROR-FILE. interpreted as the name of a mirror scheme, taken from %MIRROR-FILE.
Alternately, when URL starts with file://, return the corresponding file name Alternatively, when URL starts with file://, return the corresponding file
in the store." name in the store."
(define file-name (define file-name
(match url (match url
((head _ ...) ((head _ ...)