package dune-configurator

  1. Overview
  2. Docs
Helper library for gathering system configuration

Install 

dune-project
 Dependency

github.com Readme Changelog MIT License Edit opam file Versions (14)

Authors

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Sources

dune-site-2.9.3.tbz
sha256=3e65ec73ab2c80d50d4ffd6c46cbfb22eacd0e5587a4be8af8ae69547d5f88d6
sha512=04b48501ac16c3608e3b6bfbdbabf810df0fb844ea3b7d25ba50f03b9d6cb1d2c933cf747d694029d82a9777a774e48e5c38ab010fe53ce1eae367da0ed04d6d

Description

dune-configurator is a small library that helps writing OCaml scripts that test features available on the system, in order to generate config.h files for instance. Among other things, dune-configurator allows one to:

  • test if a C program compiles
  • query pkg-config
  • import #define from OCaml header files
  • generate config.h file

Published: 28 Jan 2022

README

Dune - A composable build system

Dune is a build system designed for OCaml/Reason projects only. It focuses on providing the user with a consistent experience and takes care of most of the low-level details of OCaml compilation. All you have to do is provide a description of your project and dune will do the rest.

The scheme it implements is inspired from the one used inside Jane Street and adapted to the open source world. It has matured over a long time and is used daily by hundreds of developers, which means that it is highly tested and productive.

Dune comes with a manual. If you want to get started without reading too much, you can look at the quick start guide or watch this introduction video.

The example directory contains examples of projects using dune.

Travis status AppVeyor status Release

Overview

Dune reads project metadata from dune files, which are either static files in a simple S-expression syntax or OCaml scripts. It uses this information to setup build rules, generate configuration files for development tools such as merlin, handle installation, etc...

Dune itself is fast, has very low overhead and supports parallel builds on all platforms. It has no system dependencies: all you need to build dune and packages using dune is OCaml. You don't need make or bash as long as the packages themselves don't use bash explicitly.

In particular, one can install OCaml on Windows with a binary installer and then use only the Windows Console to build dune and packages using dune.

Strengths

Composable

Take n repositories that use dune, arrange them in any way on the file system and the result is still a single repository that dune knows how to build at once.

This make simultaneous development on multiple packages trivial.

Gracefully handles multi-package repositories

Dune knows how to handle repositories containing several packages. When building via opam, it is able to correctly use libraries that were previously installed even if they are already present in the source tree.

The magic invocation is:

$ dune build --only-packages <package-name> @install

Building against several configurations at once

Dune is able to build a given source code repository against several configurations simultaneously. This helps maintaining packages across several versions of OCaml as you can test them all at once without hassle.

In particular, this makes it easy to handle cross-compilation.

This feature requires opam.

Requirements

Dune requires OCaml version 4.08.0 to build itself and can build OCaml projects using ocaml 4.02.3 or greater.

Installation

The recommended way to install dune is via the opam package manager:

$ opam install dune

If you are new to opam, make sure to run eval $(opam config env) to make dune available in your PATH. The dune binary is self contained and relocatable, so you can safely copy it somewhere else to make it permanently available.

You can also build it manually with:

$ make release
$ make install

If you do not have make, you can do the following:

$ ocaml bootstrap.ml
$ ./dune.exe build -p dune --profile dune-bootstrap
$ ./dune.exe install dune

The first command builds the dune.exe binary. The second builds the additional files that are installed by dune, such as the man pages, and the last simply installs all of that on the system.

Note that unless you ran the optional ./configure script, you can simply copy dune.exe anywhere and it will just work. dune is fully relocatable and discovers its environment at runtime rather than hard-coding it at compilation time.

Support

If you have questions about dune, you can send an email to ocaml-core@googlegroups.com or open a ticket on GitHub.

Migration from jbuilder

Dune was formerly known as jbuilder. Migration from jbuilder to dune is described in the manual.

Status

Dune is now fairly stable and is used by the majority of packages on opam. Note that dune retains backward compatibility with Jbuilder, and in particular existing Jbuilder projects will continue to be buildable with dune.

Dependencies (4)

  1. csexp >= "1.3.0"
  2. result
  3. ocaml >= "4.03.0"
  4. dune >= "2.9"

Dev Dependencies (1)

  1. odoc with-doc

  1. ahrocksdb
  2. albatross
  3. alsa >= "0.3.0"
  4. alt-ergo-free >= "2.4.3"
  5. alt-ergo-lib >= "2.4.0" & < "2.5.1"
  6. antic >= "0.2.3" & < "0.4.0"
  7. ao >= "0.2.2"
  8. arb >= "0.2.3" & < "0.4.0"
  9. argon2 >= "1.0.2"
  10. async_ssl
  11. bancos
  12. bank
  13. base
  14. base64 >= "3.3.0" & < "3.5.0"
  15. binaryen >= "0.8.1" & < "0.20.0"
  16. bjack >= "0.1.6"
  17. bls12-381 < "0.4.1"
  18. bls12-381-js-gen
  19. bls12-381-legacy
  20. bls12-381-unix
  21. bwrap
  22. cairo2 >= "0.6"
  23. calcium >= "0.2.3" & < "0.4.0"
  24. camlimages >= "5.0.3"
  25. checkseum >= "0.2.0"
  26. class_group_vdf >= "0.0.4"
  27. containers
  28. containers-thread
  29. crlibm >= "0.3"
  30. crypt >= "2.0"
  31. cryptokit >= "1.16.1"
  32. ctypes >= "0.21.1"
  33. ctypes-foreign >= "0.21.1"
  34. ctypes-zarith
  35. curses >= "1.0.9"
  36. dkml-c-probe
  37. dssi >= "0.1.3"
  38. eigen >= "0.3.2"
  39. extunix >= "0.3.1" & < "0.4.4"
  40. faad >= "0.5.0"
  41. fdkaac >= "0.3.2"
  42. ffmpeg-av
  43. ffmpeg-avcodec
  44. ffmpeg-avdevice
  45. ffmpeg-avfilter
  46. ffmpeg-avutil
  47. ffmpeg-swresample
  48. ffmpeg-swscale
  49. fftw3 >= "0.8.2"
  50. fiat-p256
  51. flac
  52. flint >= "0.2.3"
  53. frama-c >= "26.0~beta"
  54. freetds >= "0.7"
  55. frei0r >= "0.1.2"
  56. GT >= "0.5.4"
  57. gd >= "1.1"
  58. gen >= "0.5.3" & < "1.1"
  59. gettext-stub < "0.5.0"
  60. glfw-ocaml >= "3.2.1-1"
  61. goblint-cil >= "2.0.0"
  62. graphics >= "5.1.2"
  63. gsl = "1.24.0" | >= "1.24.2"
  64. gstreamer >= "0.3.1"
  65. guile
  66. hdf5 >= "0.1.5"
  67. hidapi >= "1.1"
  68. hugin >= "1.0.0~alpha1"
  69. hxd >= "0.2.0"
  70. interval_base
  71. interval_crlibm < "1.6"
  72. io-page < "2.4.0"
  73. iomux
  74. iter < "1.7"
  75. jst-config
  76. kaun-board
  77. krb
  78. lablgtk3 >= "3.0.beta4" & < "3.0.beta7"
  79. lablqml >= "0.7"
  80. lacaml >= "11.0.2"
  81. ladspa >= "0.2.0"
  82. lame >= "0.3.4"
  83. lbfgs >= "0.9.1" & < "0.9.5"
  84. libbinaryen < "110.0.0"
  85. lilv
  86. links < "0.9.1"
  87. links-postgresql < "0.9.1"
  88. links-sqlite3 < "0.9.1"
  89. llama
  90. llama-cpp-ocaml
  91. lmdb >= "1.0"
  92. lo >= "0.2.0"
  93. lwt >= "4.3.0"
  94. lz4 >= "1.3.0"
  95. lzo >= "0.0.3"
  96. mad >= "0.5.0"
  97. mariadb >= "1.2.0"
  98. memtrace_viewer < "v0.15.0"
  99. mesh >= "0.9.5"
  100. mesh-easymesh >= "0.9.5"
  101. mindstorm >= "0.8"
  102. mindstorm-lwt
  103. miou >= "0.5.0"
  104. mirage-clock < "4.2.0"
  105. mirage-clock-lwt
  106. mirage-clock-unix >= "4.2.0"
  107. mirage-crypto
  108. mirage-crypto-ec
  109. mirage-crypto-rng
  110. mirage-crypto-rng-async
  111. mlmpfr >= "4.2.0"
  112. mm >= "0.7.0"
  113. mosaique
  114. mpg123
  115. mssql < "2.0.3"
  116. mysql8
  117. nx
  118. OCanren
  119. OCanren-ppx
  120. ocaml-canvas
  121. ocaml-protoc-plugin >= "6.1.0"
  122. ocaml_intrinsics
  123. ocamlfuse
  124. odepack >= "0.6.9"
  125. ogg >= "1.0.0"
  126. oniguruma >= "0.1.1"
  127. opus
  128. ortools_solvers < "9.15.0"
  129. otaglibc
  130. owl >= "0.5.0"
  131. owl-base >= "0.5.0" & < "0.7.0"
  132. parmap >= "1.1.1"
  133. pcre >= "7.3.5" & < "7.4.2" | >= "7.4.4"
  134. pcre2
  135. plplot >= "5.11.0-1"
  136. poll
  137. portaudio >= "0.2.2"
  138. posix-getopt >= "2.0.0"
  139. posix-socket >= "3.0.0"
  140. postgresql >= "4.4.1" & < "4.5.1" | >= "4.6.0"
  141. ppx_cstubs < "0.4.1"
  142. ppx_monad >= "0.2.0"
  143. pulseaudio >= "0.1.4"
  144. qcaml
  145. qrencode
  146. raygui < "1.5.1"
  147. raylib >= "0.2.2"
  148. rowex
  149. rune >= "1.0.0~alpha1"
  150. samplerate >= "0.1.6"
  151. secp256k1 >= "0.4.1"
  152. secp256k1-internal >= "0.2.0"
  153. shine >= "0.2.2"
  154. soundtouch >= "0.1.9"
  155. speex
  156. sqlite3 >= "4.4.1"
  157. srt
  158. ssl >= "0.5.6"
  159. swipl
  160. taglib >= "0.3.7"
  161. tensorflow
  162. theora
  163. torch
  164. trexio
  165. tsdl-image >= "0.3.2"
  166. tsdl-mixer >= "0.3.2"
  167. tsdl-ttf >= "0.3.2"
  168. uring
  169. vorbis
  170. wasmtime
  171. waylaunch
  172. yaml >= "1.0.0"
  173. zmq >= "5.1.0"

Conflicts

None