summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorThéo Zimmermann <theo.zimmermann@inria.fr>2021-09-07 14:44:40 +0200
committerVincent Laporte <vbgl@users.noreply.github.com>2021-09-20 11:10:23 +0200
commit20291381c1e79eda0d5efbf3470440f270a7dee6 (patch)
tree59b042dc0641a39f259a8db2771bf3cfcdafd00b /doc
parente331c30a724090818bb8d8976c746b38ca57cbfa (diff)
downloadnixpkgs-20291381c1e79eda0d5efbf3470440f270a7dee6.tar
nixpkgs-20291381c1e79eda0d5efbf3470440f270a7dee6.tar.gz
nixpkgs-20291381c1e79eda0d5efbf3470440f270a7dee6.tar.bz2
nixpkgs-20291381c1e79eda0d5efbf3470440f270a7dee6.tar.lz
nixpkgs-20291381c1e79eda0d5efbf3470440f270a7dee6.tar.xz
nixpkgs-20291381c1e79eda0d5efbf3470440f270a7dee6.tar.zst
nixpkgs-20291381c1e79eda0d5efbf3470440f270a7dee6.zip
coqPackages.mkCoqDerivation: rely on namePrefix to compute default opam-name
As suggested by Cyril Cohen in https://github.com/NixOS/nixpkgs/pull/134362#discussion_r698379405.
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/coq.section.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/languages-frameworks/coq.section.md b/doc/languages-frameworks/coq.section.md
index 39b60d83ac7..a5155aedaf5 100644
--- a/doc/languages-frameworks/coq.section.md
+++ b/doc/languages-frameworks/coq.section.md
@@ -28,12 +28,12 @@ The recommended way of defining a derivation for a Coq library, is to use the `c
 * `domain` (optional, defaults to `"github.com"`), domains including the strings `"github"` or `"gitlab"` in their names are automatically supported, otherwise, one must change the `fetcher` argument to support them (cf `pkgs/development/coq-modules/heq/default.nix` for an example),
 * `releaseRev` (optional, defaults to `(v: v)`), provides a default mapping from release names to revision hashes/branch names/tags,
 * `displayVersion` (optional), provides a way to alter the computation of `name` from `pname`, by explaining how to display version numbers,
-* `namePrefix` (optional), provides a way to alter the computation of `name` from `pname`, by explaining which dependencies must occur in `name`,
+* `namePrefix` (optional, defaults to `[ "coq" ]`), provides a way to alter the computation of `name` from `pname`, by explaining which dependencies must occur in `name`,
 * `extraBuildInputs` (optional), by default `buildInputs` just contains `coq`, this allows to add more build inputs,
 * `mlPlugin` (optional, defaults to `false`). Some extensions (plugins) might require OCaml and sometimes other OCaml packages. Standard dependencies can be added by setting the current option to `true`. For a finer grain control, the `coq.ocamlPackages` attribute can be used in `extraBuildInputs` to depend on the same package set Coq was built against.
 * `useDune2ifVersion` (optional, default to `(x: false)` uses Dune2 to build the package if the provided predicate evaluates to true on the version, e.g. `useDune2if = versions.isGe "1.1"`  will use dune if the version of the package is greater or equal to `"1.1"`,
 * `useDune2` (optional, defaults to `false`) uses Dune2 to build the package if set to true, the presence of this attribute overrides the behavior of the previous one.
-* `opam-name` (optional, defaults to `coq-` followed by the value of `pname`), name of the Dune package to build.
+* `opam-name` (optional, defaults to concatenating with a dash separator the components of `namePrefix` and `pname`), name of the Dune package to build.
 * `enableParallelBuilding` (optional, defaults to `true`), since it is activated by default, we provide a way to disable it.
 * `extraInstallFlags` (optional), allows to extend `installFlags` which initializes the variable `COQMF_COQLIB` so as to install in the proper subdirectory. Indeed Coq libraries should be installed in `$(out)/lib/coq/${coq.coq-version}/user-contrib/`. Such directories are automatically added to the `$COQPATH` environment variable by the hook defined in the Coq derivation.
 * `setCOQBIN` (optional, defaults to `true`), by default, the environment variable `$COQBIN` is set to the current Coq's binary, but one can disable this behavior by setting it to `false`,