package dune-configurator

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

Install

Dune Dependency

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

Authors

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

Maintainers

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

Sources

dune-3.3.1.tbz
sha256=840c80491bfe12bab5f2b99d49e163f3e4c4d2fc4b4a3e6fb16c24dccd5502e1
sha512=b5d7639336b5df8cf37b8aac45906c6d0ff7e38b1a4a2c6ddb616ea81cdc5a8ff36cecf3d4ee4ff9282c835ed2958d4702ae1b3dd1f048c4269f5e7fedbe50d5

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: 21 Jun 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 low-level details of OCaml compilations. It's merely necessary to provide a description of your project, and Dune will do the rest.

It 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.

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. OCaml is all you need to build Dune and packages using Dune. 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 and arrange them in any way on the file system. 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 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.

Requirements

Dune requires OCaml version 4.08.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 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

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 fairly stable and 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.5.0"
  2. base-unix
  3. ocaml >= "4.04.0"
  4. dune >= "3.3"

Dev Dependencies (1)

  1. odoc with-doc

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

Conflicts

None