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.
This commit is contained in:
Alyssa Ross 2023-05-27 12:47:41 +00:00
parent 540fbf720f
commit caa0a24ab0

View file

@ -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.