aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorEelco Dolstra <edolstra@gmail.com>2023-06-16 16:48:37 +0200
committerGitHub <noreply@github.com>2023-06-16 16:48:37 +0200
commitb1ed9b4b0cc037a8b14dcc37fd32f6a5a16e7ba3 (patch)
tree388460a1503f57ac7965f063248d9cc08846ce80 /doc
parentcab03fb7794f6e20e02dc1460a78201ab3955c18 (diff)
Apply suggestions from code review
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/manual/src/protocols/tarball-fetcher.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/doc/manual/src/protocols/tarball-fetcher.md b/doc/manual/src/protocols/tarball-fetcher.md
index 1c6c92000..0d3212303 100644
--- a/doc/manual/src/protocols/tarball-fetcher.md
+++ b/doc/manual/src/protocols/tarball-fetcher.md
@@ -1,15 +1,17 @@
-# Serving Tarball Flakes
+# Lockable HTTP Tarball Protocol
-Tarball flakes are served as regular tarballs via HTTP or the file
-system (for `file://` URLs).
+Tarball flakes can be served as regular tarballs via HTTP or the file
+system (for `file://` URLs). Unless the server implements the Lockable
+HTTP Tarball protocol, it is the responsibility of the user to make sure that
+the URL always produces the same tarball contents.
-An HTTP server can return an "immutable" flakeref appropriate for lock
+An HTTP server can return an "immutable" HTTP URL appropriate for lock
files. This allows users to specify a tarball flake input in
`flake.nix` that requests the latest version of a flake
(e.g. `https://example.org/hello/latest.tar.gz`), while `flake.lock`
will record a URL whose contents will not change
(e.g. `https://example.org/hello/<revision>.tar.gz`). To do so, the
-server must return a `Link` header with the `rel` attribute set to
+server must return an [HTTP `Link` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Link) with the `rel` attribute set to
`immutable`, as follows:
```