Commit 701cdfea authored by Alyssa Ross's avatar Alyssa Ross Committed by github-actions[bot]
Browse files

doc: clarify that meta.timeout is only for Hydra

I read this and expected it to be a timeout that was always applied
when building the derivation, but it's actually a Hydra-specific
thing.

(cherry picked from commit c64d9a3878535fc0bff2c430e43d881bb7776cbd)
parent 7c3e7b33
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -182,7 +182,7 @@ runCommand "my-package-test" {

### `timeout` {#var-meta-timeout}

A timeout (in seconds) for building the derivation. If the derivation takes longer than this time to build, it can fail due to breaking the timeout. However, all computers do not have the same computing power, hence some builders may decide to apply a multiplicative factor to this value. When filling this value in, try to keep it approximately consistent with other values already present in `nixpkgs`.
A timeout (in seconds) for building the derivation. If the derivation takes longer than this time to build, Hydra will fail it due to breaking the timeout. However, all computers do not have the same computing power, hence some builders may decide to apply a multiplicative factor to this value. When filling this value in, try to keep it approximately consistent with other values already present in `nixpkgs`.

`meta` attributes are not stored in the instantiated derivation.
Therefore, this setting may be lost when the package is used as a dependency.