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 (22)

Authors

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

Maintainers

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

Sources

dune-3.24.2.tbz
sha256=472798691b0216daf538709f0f4703b3617ef24ad0866c9096068baaba4d762a
sha512=13082a66a28e940d4b3c9f78b556f6c1455987cd522355ba4502e01e60a3d002d3101b51284726ae21aa87494efa2dc54d016173f05b616bbc5dad714d5714a3

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

Added to opam-repository:

README

Dune

A Composable Build System for OCaml

Main Workflow Release License Contributors

Dune is a build system for OCaml. It provides a consistent experience and takes care of the low-level details of OCaml compilation. You need only to provide a description of your project, and Dune will do the rest.

Dune implements a scheme that's 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, meaning it's highly tested and productive.

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

The example directory contains examples of projects using Dune.

How does it work?

Dune reads project metadata from dune files, which are static files with a simple S-expression syntax. 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 little overhead, and supports parallel builds on all platforms. It has no system dependencies. OCaml is all you need to build Dune and packages using Dune.

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

Dune is composable, meaning that multiple Dune projects can be arranged together, leading to a single build that Dune knows how to execute. This allows for monorepos of projects.

Dune makes simultaneous development on multiple packages a trivial task.

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

Build Against Several Configurations at Once

Dune can 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.

Installation

Requirements

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

Installation

We recommended installing Dune 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 boot/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 installed by Dune, such as the man pages, and the last simply installs all of that on the system.

Please note: 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

Issues Discussions Discuss OCaml Discord

If you have questions or issues about Dune, you can ask in our GitHub discussions page or open a ticket on GitHub.

Dependencies (4)

  1. csexp >= "1.5.0"
  2. base-unix
  3. ocaml >= "4.14"
  4. dune >= "3.24"

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

Conflicts

None