diff options
author | DwarfMaster <luc@dwarfmaster.net> | 2022-07-13 12:29:55 +0200 |
---|---|---|
committer | DwarfMaster <luc@dwarfmaster.net> | 2022-07-13 12:29:55 +0200 |
commit | 3d1205de9120ea72392b28d89fc5d0ec9ba04e7e (patch) | |
tree | cb38f57ef161b51dcaf264bacc991384fb9ff07c | |
parent | 3c1447f807864888ee102a37e12e7089d9457fca (diff) | |
download | nixpkgs-3d1205de9120ea72392b28d89fc5d0ec9ba04e7e.tar nixpkgs-3d1205de9120ea72392b28d89fc5d0ec9ba04e7e.tar.gz nixpkgs-3d1205de9120ea72392b28d89fc5d0ec9ba04e7e.tar.bz2 nixpkgs-3d1205de9120ea72392b28d89fc5d0ec9ba04e7e.tar.lz nixpkgs-3d1205de9120ea72392b28d89fc5d0ec9ba04e7e.tar.xz nixpkgs-3d1205de9120ea72392b28d89fc5d0ec9ba04e7e.tar.zst nixpkgs-3d1205de9120ea72392b28d89fc5d0ec9ba04e7e.zip |
doc: clarify coq override
-rw-r--r-- | doc/languages-frameworks/coq.section.md | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/languages-frameworks/coq.section.md b/doc/languages-frameworks/coq.section.md index 80d8566f804..4d9dc3552bb 100644 --- a/doc/languages-frameworks/coq.section.md +++ b/doc/languages-frameworks/coq.section.md @@ -5,9 +5,11 @@ The Coq derivation is overridable through the `coq.override overrides`, where overrides is an attribute set which contains the arguments to override. We recommend overriding either of the following * `version` (optional, defaults to the latest version of Coq selected for nixpkgs, see `pkgs/top-level/coq-packages` to witness this choice), which follows the conventions explained in the `coqPackages` section below, -* `customOCamlPackage` (optional, defaults to `null`, which lets Coq choose a version automatically), which can be set to any of the ocaml packages attribute of `ocaml-ng` (such as `ocaml-ng.ocamlPackages_4_10` which is the default for Coq 8.11 for example). +* `customOCamlPackages` (optional, defaults to `null`, which lets Coq choose a version automatically), which can be set to any of the ocaml packages attribute of `ocaml-ng` (such as `ocaml-ng.ocamlPackages_4_10` which is the default for Coq 8.11 for example). * `coq-version` (optional, defaults to the short version e.g. "8.10"), is a version number of the form "x.y" that indicates which Coq's version build behavior to mimic when using a source which is not a release. E.g. `coq.override { version = "d370a9d1328a4e1cdb9d02ee032f605a9d94ec7a"; coq-version = "8.10"; }`. +The associated package set can be optained using `mkCoqPackages coq`, where `coq` is the `coq` derivation to use. + ## Coq packages attribute sets: `coqPackages` {#coq-packages-attribute-sets-coqpackages} The recommended way of defining a derivation for a Coq library, is to use the `coqPackages.mkCoqDerivation` function, which is essentially a specialization of `mkDerivation` taking into account most of the specifics of Coq libraries. The following attributes are supported: |