diff options
author | Alyssa Ross <hi@alyssa.is> | 2023-05-27 12:47:41 +0000 |
---|---|---|
committer | Alyssa Ross <hi@alyssa.is> | 2023-05-30 10:27:44 +0000 |
commit | caa0a24ab0c913ea250808ddfeef486ac2ac9f70 (patch) | |
tree | 7bc65df26536006d46a10e6fdbf8f9b8c06edddd /doc/stdenv | |
parent | 540fbf720f7d841bf518f29c3da3d2ad3c6eeeaf (diff) |
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.
Diffstat (limited to 'doc/stdenv')
-rw-r--r-- | doc/stdenv/meta.chapter.md | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/doc/stdenv/meta.chapter.md b/doc/stdenv/meta.chapter.md index 2e0cae67d50d5..a21dfd0821af5 100644 --- a/doc/stdenv/meta.chapter.md +++ b/doc/stdenv/meta.chapter.md @@ -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. |