Commit c7d3f1cb authored by Ralf Jung's avatar Ralf Jung
Browse files

update docs

parent 822ab697
......@@ -85,8 +85,14 @@ use a lot of CI time.
See [buildjob](buildjob) for a list of available configuration variables. Some
of them require a secret or a key to be configured for the project; these are
passed in as "Environment variables" setup in the GitLab UI. Below, we describe
some of the things that are common amongst Iris build jobs.
passed in as "Environment variables" setup in the GitLab UI.
The most versatile variable is `OPAM_PINS`, which configures the packages to pin
before installing dependencies: Each package can be:
- a group of three list elements: `PACKAGE KIND TARGET`.
- a single element denoting a git repository, starting with `git+https://`.
Below, we describe some of the things that are common amongst Iris build jobs.
## Nightly builds
......
......@@ -6,8 +6,10 @@ set -eo pipefail
## This runs a default build job. The following variables are noteworthy:
## - $OCAML: The OCaml version to use. Defaults to `ocaml-system`. This MUST
## start with a package name, e.g. `ocaml-base-compiler.4.07.0`.
## - $OPAM_PINS: Space-separated list of packages to pin in opam, in the format
## "PACKAGE KIND TARGET PACKAGE KIND TARGET ..."
## - $OPAM_PINS: Space-separated list of packages to pin in opam.
## Each package can be:
## - a group of three list elements: `PACKAGE KIND TARGET`.
## - a single element denoting a git repository, starting with `git+https://`.
## - $MAKE_TARGET: Overwrite the target built by CI. Defaults to `all`.
## - $CI_COQCHK: If non-empty, run `coqchk` via `make validate`
## - $MANGLE_NAMES: If non-empty, add `-mangle-names` parameter to Coq
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment