Address review feedback

… by explaining the distinction between the various types of
flake reference updates
This commit is contained in:
Gabriella Gonzalez 2023-11-21 08:59:26 -08:00
parent f11d2f106b
commit 2a943de4be

View File

@ -627,13 +627,27 @@ public:
Nix caches tarballs in `$XDG_CACHE_HOME/nix/tarballs`.
Files fetched via `NIX_PATH`, `fetchGit`, `fetchMercurial`,
`fetchTarball`, and `fetchurl` respect this TTL.
This option affects:
This option also affects how often the global flake registry is
updated. For example, a flake URI like `nixpkgs#hello` will trigger
a new download of Nixpkgs if the last download is older than the
`tarball-ttl`.
- files fetched via `NIX_PATH`, `fetchGit`, `fetchMercurial`,
`fetchTarball`, and `fetchurl`
- how often the global flake registry is updated (i.e. how often
indirect flake references are updated)
- how often unpinned flake references (e.g. `github:NixOS/nixpkgs`)
are updated
For example, for a flake reference like `nixpkgs#hello` this option
affects how that flake resolves in two separate ways:
- It affects how often the `nixpkgs` indirect flake reference is
updated (which is rare: it usually resolves to
`github:NixOS/nixpkgs/nixpkgs-unstable`).
- It affects how often the `github:NixOS/nixpkgs/nixpkgs-unstable`
flake reference is updated (which is common: the `nixpkgs-unstable`
branch of the repository changes frequently).
)"};
Setting<bool> requireSigs{