package jbuilder

You can search for identifiers within the package.

in-package search v0.2.0

Fast, portable and opinionated build system

Install

Dune Dependency

github.com Readme Changelog Apache-2.0 License Edit opam file Versions (3)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

jbuilder-1.0+beta20.1.tbz

sha256=5af70da8fe53d9199a6b48e30ac2f1041f30a27f8bd52282575fdcfeb8f8ba83

md5=a15fbc90091002e7970d49914a984ce2

Description

jbuilder is a build system that was designed to simplify the release of Jane Street packages. It reads metadata from "jbuild" files following a very simple s-expression syntax.

jbuilder is fast, it has very low-overhead and support parallel builds on all platforms. It has no system dependencies, all you need to build jbuilder and packages using jbuilder is OCaml. You don't need or make or bash as long as the packages themselves don't use bash explicitely.

jbuilder supports multi-package development by simply dropping multiple repositories into the same directory.

It also supports multi-context builds, such as building against several opam roots/switches simultaneously. This helps maintaining packages across several versions of OCaml and gives cross-compilation for free.

Published: 02 Dec 2019

README

Dune (Jbuilder) - A composable build system

Jbuilder has been renamed to Dune. A full renaming of the documentation and the tool will be done as part of the 1.0 release.

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

Jbuilder 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 jbuilder.

Overview

Jbuilder reads project metadata from jbuild 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...

Jbuilder itself is fast, has very low overhead and supports parallel builds on all platforms. It has no system dependencies: all you need to build jbuilder and packages using jbuilder 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 Jbuilder and packages using Jbuilder.

Strengths

Composable

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

This make simultaneous development on multiple packages trivial.

Gracefully handles multi-package repositories

Jbuilder 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:

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

Building against several configurations at once

Jbuilder 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 tests them all at once without hassle.

This feature should make cross-compilation easy, see details in the roadmap.

This feature requires opam.

Jenga bridge

Jenga is another build system for OCaml that has more advanced features such as polling or much better editor integration. Jenga is more powerful and more complex and as a result has many more dependencies. It is planned to implement a small bridge between the two so that a Jbuilder project can build with Jenga using this bridge.

Requirements

Jbuilder requires OCaml version 4.02.3 or greater.

installation

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

$ opam install jbuilder

You can also build it manually with:

$ make release
$ make install

Note however that make install requires the opam-installer tool. Running simply make will build jbuilder using the development settings.

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

$ ocaml bootstrap.ml
$ ./boot.exe
$ ./_build/default/bin/main.exe install

Support

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

Status

Dune is now fairly stable and is used by the majority of packages on opam. The package is still in beta version as we are waiting for the renaming from Jbuilder to Dune before releasing version 1.0.0. Note that Dune will have backward compatiblity with Jbuilder, in particular existing Jbuilder projects will continue to be buildable with Dune. Additionally, Dune will be able to automatically convert a Jbuilder project into a Dune project.

Dependencies (1)

ocaml >= "4.02.3" & < "5.0"

Dev Dependencies

None

ANSITerminal = "0.8"
ago >= "0.4"
aifad < "2.2.1"
amqp-client >= "1.1.0" & < "2.0.3"
angstrom < "0.11.1"
angstrom-async < "0.11.1"
angstrom-lwt-unix < "0.11.1"
angstrom-unix < "0.11.1"
ascii85 >= "0.4"
asl >= "0.11"
atd >= "1.2.1" & < "2.2.1"
atdgen >= "1.10.2" & < "2.2.1"
atdgen-runtime < "2.2.1"
atdj < "2.2.1"
balancer
base64 = "2.2.0"
benchmark = "1.5"
bigstring < "0.3"
bigstringaf < "0.5.0"
binbin
biniou < "1.2.1"
bip32
bisect_ppx < "1.4.0"
bisect_ppx-ocamlbuild
bitstring < "3.1.1"
bst < "6.0.0"
build_path_prefix_map < "0.3"
bun < "0.3.3"
calculon < "0.4"
camlimages < "5.0.2"
camlon < "3.0.0"
camomile < "1.0.2"
capnp < "3.3.0"
caqti < "1.0.0"
caqti-async < "1.0.0"
caqti-driver-postgresql < "1.0.0"
caqti-driver-sqlite3 < "1.0.0"
caqti-dynload < "1.0.0"
caqti-lwt < "1.0.0"
caqti-type-calendar < "1.0.0"
cdrom = "0.9.3"
cfg < "2.2.0"
cfstream < "1.3.1"
checkseum < "0.0.3"
cinaps < "v0.12.0"
cmdtui >= "0.4.3"
cmdtui-lambda-term
cohttp < "1.1.1"
coin < "0.1.1"
color < "0.2.0"
configurator
cow = "2.3.0"
cowabloga < "0.5.0"
cpm = "4.0.0"
cppo < "1.6.6"
cppo_ocamlbuild < "1.6.6"
craml
crc = "2.0.0"
crlibm < "0.3"
crowbar < "0.2"
cryptodbm
csv = "2.0"
csv-lwt < "2.1"
cuid < "0.2"
curly < "0.2.0"
datakit-server < "0.12.2"
datakit-server-9p < "0.12.2"
decoders < "0.1.2"
decoders-ezjsonm < "0.1.2"
decoders-yojson < "0.1.2"
decompress < "0.8.1"
diet < "0.2"
digestif = "0.6.1"
dispatch = "0.4.0"
distributed < "0.6.0"
distributed-lwt < "0.2.0"
distributed-uwt < "0.2.0"
dlm < "0.3.1"
dns-forward
dns-forward-lwt-unix
dnssd
dockerfile-opam < "8.2.7"
dokeysto < "3.0.0"
dokeysto_lz4 < "3.0.0"
dryunit
dtoa >= "0.3.0" & < "0.3.2"
duff < "0.2"
dune-release < "1.0.0"
easy-format >= "1.3.0" & < "1.3.2"
emile < "0.4"
encore < "0.2"
eqaf < "0.2"
exenum >= "0.82.0" & < "0.86"
ezgzip < "0.2.3"
ezjsonm < "1.0.0"
ezxmlm < "1.1.0"
facile >= "1.1.4"
faraday >= "0.3.0" & < "0.7.1"
faraday-async < "0.7.1"
faraday-lwt < "0.7.1"
faraday-lwt-unix < "0.7.1"
fat-filesystem < "0.13.0"
fd-send-recv < "2.0.1"
febusy
fftw3 < "0.8.2"
findlib_top
freetds >= "0.5.2" & < "0.7"
gammu >= "0.9.4"
gdal >= "0.10.0"
gdbprofiler < "0.4"
gen = "0.5.1"
genspio < "0.0.3"
get_line = "4.0.0"
github < "4.0.0"
github-hooks-unix < "0.5.0"
github-jsoo < "4.1.0"
github-unix < "4.0.0"
gnuplot < "0.6"
gpr < "1.4.0"
graphql < "0.8.0"
graphql-async < "0.8.0"
graphql-cohttp < "0.9.0"
graphql-lwt < "0.8.0"
graphql_parser < "0.9.0"
grenier = "0.7"
gsl >= "1.20.0" & < "1.24.0"
hashids < "1.0.1"
hex < "1.3.0"
hidapi < "1.1"
hiredis >= "0.8"
hiredis-value
httpaf < "0.6.0"
httpaf-async < "0.6.0"
hvsock < "2.0.0"
integration1d < "0.5.1"
interval = "1.4"
inuit >= "0.4.1"
ipaddr < "2.9.0"
ipv6-multicast
ipv6-multicast-lwt
irc-client >= "0.6.0" & < "0.6.2"
irc-client-lwt < "0.6.2"
irc-client-tls < "0.6.2"
irc-client-unix < "0.6.2"
jane-street-headers < "v0.12.0"
js_of_ocaml-camlp4
js_of_ocaml-ocamlbuild < "3.5.0"
json-derivers
json_of_jsonm
junit >= "1.0" & < "2.0.1"
junit_alcotest < "2.0.1"
junit_ounit < "2.0.1"
kafka < "0.5"
kicadsch < "0.4.0"
kubecaml
kyotocabinet
lacaml >= "10.0.1" & < "11.0.2"
lambda-term < "2.0"
lambdasoup >= "0.6.2" & < "0.6.4"
lbfgs < "0.9.1"
ldap < "2.4.1"
lens >= "1.2.1" & < "1.2.3"
levenshtein
libsvm = "0.9.4"
linenoise = "1.1.0"
llopt
lwt_camlp4
lwt_glib = "1.1.0"
lwt_log < "1.1.1"
lwt_ppx < "1.2.2"
lwt_react >= "1.1.0" & < "1.1.2"
lwt_ssl < "1.1.3"
magic-mime >= "1.0.1" & < "1.1.1"
markup >= "0.7.6" & < "0.8.0"
mastodon-archive-viewer < "0.2"
mccs < "1.1+5"
mecab
mesh >= "0.8.9" & < "0.9.5"
mesh-display
mesh-easymesh < "0.9.5"
mesh-graphics < "0.9.5"
mesh-triangle < "0.9.5"
milter >= "1.0.4"
minimal
mirage-channel = "3.1.0"
mirage-kv = "1.1.1"
mirage-kv-lwt = "1.1.0"
mirage-net-macosx = "1.4.0"
mock < "0.1.1"
mock-ounit < "0.1.1"
modular-arithmetic
monomorphic = "1.5"
moss < "0.1.1"
msgpck >= "1.3" & < "1.5"
mstruct
multipart-form-data < "0.3.0"
mvar
nonstd >= "0.0.3"
notty_async < "v0.12.0"
npy < "0.0.8"
numalib
obi
oc45
ocal >= "0.1.3" & < "0.2.2"
ocaml-basics >= "0.5.0"
ocaml-compiler-libs < "v0.12.0"
ocaml-logicalform
ocaml-monadic = "0.4.0"
ocaml-r < "0.1.1"
ocaml-top < "1.2.0"
ocaml-version < "3.5.0"
ocp-browser >= "1.1.7" & < "1.1.9"
ocp-index < "1.1.9"
octavius >= "1.1.0" & < "1.2.2"
opaca
opam-ci
opam-client < "2.0.2"
opam-core < "2.0.2"
opam-devel < "2.0.2"
opam-format < "2.0.2"
opam-installer < "2.0.2"
opam-lock
opam-package-upgrade < "0.2"
opam-publish >= "2.0.0" & < "2.0.2"
opam-repository < "2.0.2"
opam-solver < "2.0.2"
opam-state < "2.0.2"
open < "0.2.2"
opium_kernel < "0.17.0"
optimization1d < "0.6.1"
orandforest
oranger < "2.0.1"
orec < "1.0.1"
orsvm_e1071 < "3.0.2"
orxgboost < "1.1.0"
osbx
oseq < "0.2"
owl < "0.4.0"
owl-base < "0.4.0"
owl-top < "0.4.0"
owl-zoo < "0.4.0"
parsexp < "v0.12.0"
partition_map
passmaker
passmakercmd
pcre >= "7.3.0" & < "7.3.5"
pds-reachability = "0.2.2"
pecu < "0.2"
pgx < "1.0"
phantom-algebra < "1.0.1"
phashtbl
pla = "1.2"
postgresql >= "4.1.0" & < "4.4.1"
ppx_blob >= "0.3.0" & < "0.6.0"
ppx_compose < "0.1.0"
ppx_defer = "0.3.0"
ppx_derivers < "1.2.1"
ppx_deriving_madcast < "0.2"
ppx_gen_rec < "1.1.0"
ppx_nanocaml
ppx_pipebang < "v0.12.0"
ppx_regexp < "0.4.0"
ppx_traverse_builtins
ppx_type_conv
ppxfind < "1.3"
prometheus >= "0.2" & < "0.6"
prometheus-app < "0.6"
protocol-9p < "1.0.0"
protocol-9p-tool < "1.0.0"
protocol-9p-unix < "1.0.0"
pumping
qcow < "0.11.0"
qcow-tool < "0.11.0"
qtest = "2.9"
radare2 < "0.0.3"
re >= "1.7.2" & < "1.9.0"
redis < "0.4"
redis-lwt < "0.4"
redis-sync < "0.4"
reed-solomon-erasure < "1.0.2"
res = "5.0.0"
resp-server < "0.9"
rfc1951 < "0.8.1"
root1d = "0.5"
rope < "0.6.2"
safepass = "3.0"
sanddb < "0.2"
secp256k1 >= "0.2.5" & < "0.4.1"
session = "0.4.0"
session-cohttp < "0.4.1"
session-cohttp-async < "0.4.1"
session-cohttp-lwt < "0.4.1"
session-postgresql < "0.4.1"
session-redis-lwt < "0.4.1"
session-webmachine < "0.4.1"
sexplib < "v0.12.0"
sexplib0 < "v0.12.0"
sha = "1.12"
spawn >= "v0.9.0" & < "v0.13.0"
spf
spotlib < "4.1.0"
sqlite3 >= "4.2.0" & < "4.4.1"
srs
ssh-agent < "0.2.0"
sslconf
stdint = "0.5.1"
stringext = "1.5.0"
sugar
swagger < "0.2.0"
telegraml
tiny_json
topkg-jbuilder
touist >= "3.5.0"
traildb
trax < "0.4.0"
treeprint = "2.2.0"
tube < "4.4.0"
tyre >= "0.4" & < "0.5"
unmagic
uri < "2.2.1"
uuuu < "0.1.1"
varint
vcardgen < "1.2"
vecosek
vecosek-engine
vecosek-scene
vhd-format < "0.12.0"
vlq < "0.2.1"
vpnkit
vpt < "5.0.0"
wall < "0.4"
wamp >= "1.2"
wamp-msgpck
wamp-yojson
wcs-api
wcs-lib
weberizer < "0.8"
webmachine >= "0.5.0" & < "0.6.2"
websocket < "2.12"
win-error = "0.3"
win-eventlog = "0.2"
wtf8 < "1.0.2"
xenstore_transport < "1.1.0"
yaml < "1.0.0"
yara < "0.2"
yojson < "1.5.0"
yuscii < "0.2.0"
zed < "2.0.6"
zmq = "5.0.0"
zmq-async < "5.1.0"
zmq-lwt < "5.1.0"

Conflicts