1515 *
1616 *)
1717
18- (* * Run Opam commands across a matrix of Docker containers.
19- Each of these containers represents a different version of
20- OCaml, Opam and an OS distribution (such as Debian or Alpine).
21- *)
18+ (* * Run Opam commands across a matrix of Docker containers. Each of these
19+ containers represents a different version of OCaml, Opam and an OS
20+ distribution (such as Debian or Alpine). *)
2221
2322(* * {2 Known distributions and OCaml variants} *)
2423
@@ -41,7 +40,8 @@ type distro =
4140 | `V3_17
4241 | `V3_18
4342 | `V3_19
44- | `V3_20 ]
43+ | `V3_20
44+ | `V3_21 ]
4545 | `Archlinux of [ `Latest ]
4646 | `CentOS of [ `V6 | `V7 | `V8 ]
4747 | `Debian of [ `V12 | `V11 | `V10 | `V9 | `V8 | `V7 | `Testing | `Unstable ]
@@ -128,6 +128,7 @@ type t =
128128 | `V3_18
129129 | `V3_19
130130 | `V3_20
131+ | `V3_21
131132 | `Latest ]
132133 | `Archlinux of [ `Latest ]
133134 | `CentOS of [ `V6 | `V7 | `V8 | `Latest ]
@@ -207,20 +208,19 @@ val os_family_of_distro : t -> os_family
207208(* * [os_family_of_distro t] returns the OS family of the distro. *)
208209
209210val os_family_to_string : os_family -> string
210- (* * [os_family_to_string os] returns a string representing the OS
211- family. *)
211+ (* * [os_family_to_string os] returns a string representing the OS family. *)
212212
213213val opam_repository : os_family -> string
214- (* * [opam_repository os_family] returns the git URL to the default
215- Opam repository. *)
214+ (* * [opam_repository os_family] returns the git URL to the default Opam
215+ repository. *)
216216
217217val personality : os_family -> Ocaml_version .arch -> string option
218- (* * [personality os_family arch] returns the personality associated to
219- the architecture, if [os_family] is [`Linux]. *)
218+ (* * [personality os_family arch] returns the personality associated to the
219+ architecture, if [os_family] is [`Linux]. *)
220220
221221val is_same_distro : t -> t -> bool
222- (* * [is_same_distro d1 d2] returns whether [d1] is the same distro as
223- [d2], regardless of their respective versions. *)
222+ (* * [is_same_distro d1 d2] returns whether [d1] is the same distro as [d2],
223+ regardless of their respective versions. *)
224224
225225val compare : t -> t -> int
226226(* * [compare a b] is a lexical comparison function for {!t}. *)
@@ -236,21 +236,20 @@ val latest_distros : t list
236236(* * Enumeration of the latest stable (ideally LTS) supported distributions. *)
237237
238238val master_distro : t
239- (* * The distribution that is the top-level alias for the [latest] tag
240- in the [ocaml/opam2] Docker Hub build. *)
239+ (* * The distribution that is the top-level alias for the [latest] tag in the
240+ [ocaml/opam2] Docker Hub build. *)
241241
242242val builtin_ocaml_of_distro : t -> string option
243- (* * [builtin_ocaml_of_distro t] will return the OCaml version
244- supplied with the distribution packaging, and [None] if there
245- is no supported version. *)
243+ (* * [builtin_ocaml_of_distro t] will return the OCaml version supplied with the
244+ distribution packaging, and [None] if there is no supported version. *)
246245
247246val human_readable_string_of_distro : t -> string
248- (* * [human_readable_string_of_distro t] returns a human readable
249- version of the distribution tag, including version information. *)
247+ (* * [human_readable_string_of_distro t] returns a human readable version of the
248+ distribution tag, including version information. *)
250249
251250val human_readable_short_string_of_distro : t -> string
252- (* * [human_readable_short_string_of_distro t] returns a human readable
253- short version of the distribution tag, excluding version information. *)
251+ (* * [human_readable_short_string_of_distro t] returns a human readable short
252+ version of the distribution tag, excluding version information. *)
254253
255254type package_manager =
256255 [ `Apk (* * Alpine Apk *)
@@ -278,59 +277,56 @@ val tag_of_distro : t -> string
278277(* * [tag_of_distro t] convert a distribution [t] to a Docker Hub tag. *)
279278
280279val distro_of_tag : string -> t option
281- (* * [distro_of_tag s] parses [s] into a {!t} distribution, and
282- [None] otherwise. *)
280+ (* * [distro_of_tag s] parses [s] into a {!t} distribution, and [None] otherwise.
281+ *)
283282
284283val latest_tag_of_distro : t -> string
285- (* * [latest_tag_of_distro distro] will generate a Docker Hub
286- tag that is a convenient short form for the latest stable
287- release of a particular distribution. This tag will be
288- regularly rewritten to point to any new releases of the
289- distribution. *)
284+ (* * [latest_tag_of_distro distro] will generate a Docker Hub tag that is a
285+ convenient short form for the latest stable release of a particular
286+ distribution. This tag will be regularly rewritten to point to any new
287+ releases of the distribution. *)
290288
291289val base_distro_tag : ?arch : Ocaml_version .arch -> t -> string * string
292290(* * [base_distro_tag ?arch t] will return a tuple of a Docker Hub
293- user/repository and tag for which the base image of a distribution
294- can be found (e.g. [opensuse/leap],[15.0] which maps to [opensuse/leap:15.0]
295- on the Docker Hub). This base image is in turn can be used to generate opam
296- and other OCaml tool Dockerfiles. [arch] defaults to [x86_64] and can vary
297- the base user/repository since some architecture are built elsewhere. *)
291+ user/repository and tag for which the base image of a distribution can be
292+ found (e.g. [opensuse/leap],[15.0] which maps to [opensuse/leap:15.0] on the
293+ Docker Hub). This base image is in turn can be used to generate opam and
294+ other OCaml tool Dockerfiles. [arch] defaults to [x86_64] and can vary the
295+ base user/repository since some architecture are built elsewhere. *)
298296
299297(* * {2 CPU architectures} *)
300298
301299val distro_arches : Ocaml_version .t -> t -> Ocaml_version .arch list
302- (* * [distro_arches ov t] returns the list of architectures that
303- distribution [t] is supported on for OCaml compiler version [ov] *)
300+ (* * [distro_arches ov t] returns the list of architectures that distribution [t]
301+ is supported on for OCaml compiler version [ov] *)
304302
305303val distro_supported_on : Ocaml_version .arch -> Ocaml_version .t -> t -> bool
306- (* * [distro_supported_on arch ov distro] returns [true] if the
307- combination of CPU [arch], compiler version [ov] is available
308- on the distribution [distro]. *)
304+ (* * [distro_supported_on arch ov distro] returns [true] if the combination of
305+ CPU [arch], compiler version [ov] is available on the distribution [distro].
306+ *)
309307
310308(* * {2 Opam build infrastructure support} *)
311309
312310val active_distros : Ocaml_version .arch -> t list
313- (* * [active_distros arch] returns the list of currently supported
314- distributions in the opam build infrastructure. Distributions
315- that are end-of-life upstream will rotate out of this list
316- regularly. *)
311+ (* * [active_distros arch] returns the list of currently supported distributions
312+ in the opam build infrastructure. Distributions that are end-of-life
313+ upstream will rotate out of this list regularly. *)
317314
318315val active_tier1_distros : Ocaml_version .arch -> t list
319- (* * Tier 1 distributions are those supported for the full matrix
320- of compiler versions in the opam build infrastructure.
321- The {{:https://github.com/ocurrent/docker-base-images}Docker base images}
322- will compile a base image for every OCaml version, so this
323- list should be added to sparingly. *)
316+ (* * Tier 1 distributions are those supported for the full matrix of compiler
317+ versions in the opam build infrastructure. The
318+ {{:https://github.com/ocurrent/docker-base-images}Docker base images} will
319+ compile a base image for every OCaml version, so this list should be added
320+ to sparingly. *)
324321
325322val active_tier2_distros : Ocaml_version .arch -> t list
326- (* * Tier 2 distributions are those supported for a limited set
327- of compiler versions in the opam build infrastructure. The
328- distros in this list are also tested for packages in the
329- opam repository. *)
323+ (* * Tier 2 distributions are those supported for a limited set of compiler
324+ versions in the opam build infrastructure. The distros in this list are also
325+ tested for packages in the opam repository. *)
330326
331327val active_tier3_distros : Ocaml_version .arch -> t list
332- (* * Tier 3 distributions are those supported for a limited set
333- of compiler versions in the opam build infrastructure. While
334- these distros will have base images compiled for them, they
335- are not widely tested. Distros maybe here as they are on the
336- way to being deprecated, or new and still experimental. *)
328+ (* * Tier 3 distributions are those supported for a limited set of compiler
329+ versions in the opam build infrastructure. While these distros will have
330+ base images compiled for them, they are not widely tested. Distros maybe
331+ here as they are on the way to being deprecated, or new and still
332+ experimental. *)
0 commit comments