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

Maintainers

  1. J
    Jane Street Group, LLC

Sources

dune-2.0.1.tbz
sha256=e04090c846f005f1cc02c390e963a7efe74c653ce2c5c7fd2e7e30a06ceadcb7
sha512=8c973ccfa1de0ff7173e17dac74ea850446a057866d47c7a100b271c7e440d5e607f1bfaa8fa5b756e0439492276e8c6615fac30cbff9ea900dc8e891f7ba4d3

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: 19 Dec 2019

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.

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.

Especially, 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.02.3 or greater.

Installation

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

$ opam install dune

You can also build it manually with:

$ make
$ 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 --build-dir _boot

The first command build 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 works. 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 (2)

  1. dune-private-libs = version
  2. dune >= "2.0"

Dev Dependencies

None

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

Conflicts

None