<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Welcome to dune’s documentation! — dune documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Quickstart" href="quick-start.html" />
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="#" class="icon icon-home"> dune
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="quick-start.html">Quickstart</a></li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="project-layout-specification.html">Project Layout and Metadata Specification</a></li>
<li class="toctree-l1"><a class="reference internal" href="dune-files.html">dune files</a></li>
<li class="toctree-l1"><a class="reference internal" href="tests.html">Writing and running tests</a></li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Generating Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="advanced-topics.html">Advanced topics</a></li>
<li class="toctree-l1"><a class="reference internal" href="configurator.html">Configurator</a></li>
<li class="toctree-l1"><a class="reference internal" href="menhir.html">Menhir</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a></li>
<li class="toctree-l1"><a class="reference internal" href="known-issues.html">Known Issues</a></li>
<li class="toctree-l1"><a class="reference internal" href="migration.html">Migration</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">dune</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="#">Docs</a> »</li>
<li>Welcome to dune’s documentation!</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="welcome-to-dune-s-documentation">
<h1>Welcome to dune’s documentation!<a class="headerlink" href="#welcome-to-dune-s-documentation" title="Permalink to this headline">¶</a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="quick-start.html">Quickstart</a><ul>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#building-a-hello-world-program">Building a hello world program</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#building-a-hello-world-program-using-lwt">Building a hello world program using Lwt</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#building-a-hello-world-program-using-core-and-jane-street-ppxs">Building a hello world program using Core and Jane Street PPXs</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#defining-a-library-using-lwt-and-ocaml-re">Defining a library using Lwt and ocaml-re</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#setting-the-ocaml-compilation-flags-globally">Setting the OCaml compilation flags globally</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#using-cppo">Using cppo</a><ul>
<li class="toctree-l3"><a class="reference internal" href="quick-start.html#using-the-cppo-ml-style-like-the-ocamlbuild-plugin">Using the .cppo.ml style like the ocamlbuild plugin</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#defining-a-library-with-c-stubs">Defining a library with C stubs</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#defining-a-library-with-c-stubs-using-pkg-config">Defining a library with C stubs using pkg-config</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#using-a-custom-code-generator">Using a custom code generator</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#defining-tests">Defining tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="quick-start.html#building-a-custom-toplevel">Building a custom toplevel</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="terminology.html">Terminology</a></li>
<li class="toctree-l1"><a class="reference internal" href="project-layout-specification.html">Project Layout and Metadata Specification</a><ul>
<li class="toctree-l2"><a class="reference internal" href="project-layout-specification.html#metadata-format">Metadata format</a><ul>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#comments">Comments</a></li>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#atoms">Atoms</a></li>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#strings">Strings</a></li>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#end-of-line-strings">End of line strings</a></li>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#lists">Lists</a></li>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#variables">Variables</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="project-layout-specification.html#dune-project-files">dune-project files</a><ul>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#name">name</a></li>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#version">version</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="project-layout-specification.html#package-opam-files"><package>.opam files</a><ul>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#scopes">Scopes</a></li>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#package-version">Package version</a></li>
<li class="toctree-l3"><a class="reference internal" href="project-layout-specification.html#odig-conventions">Odig conventions</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="project-layout-specification.html#jbuild-ignore-deprecated">jbuild-ignore (deprecated)</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="dune-files.html">dune files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="dune-files.html#stanzas">Stanzas</a><ul>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#jbuild-version">jbuild_version</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#library">library</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#executable">executable</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#executables">executables</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#rule">rule</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#ocamllex">ocamllex</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#ocamlyacc">ocamlyacc</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#menhir">menhir</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#alias">alias</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#install">install</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#copy-files">copy_files</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#include">include</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#tests">tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#test">test</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#env">env</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#ignored-subdirs">ignored_subdirs</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="dune-files.html#common-items">Common items</a><ul>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#ordered-set-language">Ordered set language</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#variables-expansion">Variables expansion</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#library-dependencies">Library dependencies</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#preprocessing-specification">Preprocessing specification</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#dependency-specification">Dependency specification</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#ocaml-flags">OCaml flags</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#js-of-ocaml">js_of_ocaml</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#user-actions">User actions</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#locks">Locks</a></li>
<li class="toctree-l3"><a class="reference internal" href="dune-files.html#diffing-and-promotion">Diffing and promotion</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="dune-files.html#id4">OCaml syntax</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tests.html">Writing and running tests</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tests.html#running-tests">Running tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="tests.html#inline-tests">Inline tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tests.html#inline-expectation-tests">Inline expectation tests</a></li>
<li class="toctree-l3"><a class="reference internal" href="tests.html#specifying-inline-test-dependencies">Specifying inline test dependencies</a></li>
<li class="toctree-l3"><a class="reference internal" href="tests.html#passing-special-arguments-to-the-test-runner">Passing special arguments to the test runner</a></li>
<li class="toctree-l3"><a class="reference internal" href="tests.html#using-additional-libraries-in-the-test-runner">Using additional libraries in the test runner</a></li>
<li class="toctree-l3"><a class="reference internal" href="tests.html#defining-your-own-inline-test-backend">Defining your own inline test backend</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="tests.html#custom-tests">Custom tests</a><ul>
<li class="toctree-l3"><a class="reference internal" href="tests.html#diffing-the-result">Diffing the result</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="documentation.html">Generating Documentation</a><ul>
<li class="toctree-l2"><a class="reference internal" href="documentation.html#prerequisites">Prerequisites</a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation.html#writing-documentation">Writing Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation.html#building-documentation">Building Documentation</a></li>
<li class="toctree-l2"><a class="reference internal" href="documentation.html#documentation-stanza">Documentation Stanza</a><ul>
<li class="toctree-l3"><a class="reference internal" href="documentation.html#examples">Examples</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">Usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#finding-the-root">Finding the root</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#dune-workspace">dune-workspace</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#current-directory">Current directory</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#forcing-the-root-for-scripts">Forcing the root (for scripts)</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#interpretation-of-targets">Interpretation of targets</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#resolution">Resolution</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#aliases">Aliases</a></li>
<li class="toctree-l3"><a class="reference internal" href="usage.html#default-alias">Default alias</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#finding-external-libraries">Finding external libraries</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#running-tests">Running tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#launching-the-toplevel-repl">Launching the Toplevel (REPL)</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#requirements-limitations">Requirements & Limitations</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#restricting-the-set-of-packages">Restricting the set of packages</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#invocation-from-opam">Invocation from opam</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#tests">Tests</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#installation">Installation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#destination">Destination</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#workspace-configuration">Workspace configuration</a><ul>
<li class="toctree-l3"><a class="reference internal" href="usage.html#id4">dune-workspace</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#building-javascript-with-js-of-ocaml">Building JavaScript with js_of_ocaml</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#distributing-projects">Distributing Projects</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#watermarking">Watermarking</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#dune-subst">dune subst</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#custom-build-directory">Custom Build Directory</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="advanced-topics.html">Advanced topics</a><ul>
<li class="toctree-l2"><a class="reference internal" href="advanced-topics.html#meta-file-generation">META file generation</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-topics.html#findlib-integration-and-limitations">Findlib integration and limitations</a></li>
<li class="toctree-l2"><a class="reference internal" href="advanced-topics.html#cross-compilation">Cross Compilation</a><ul>
<li class="toctree-l3"><a class="reference internal" href="advanced-topics.html#how-does-it-work">How does it work?</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="advanced-topics.html#classical-ppx">Classical ppx</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="configurator.html">Configurator</a><ul>
<li class="toctree-l2"><a class="reference internal" href="configurator.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="configurator.html#upgrading-from-the-old-configurator">Upgrading from the old Configurator</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="menhir.html">Menhir</a></li>
<li class="toctree-l1"><a class="reference internal" href="faq.html">FAQ</a><ul>
<li class="toctree-l2"><a class="reference internal" href="faq.html#why-do-many-dune-projects-contain-a-makefile">Why do many dune projects contain a Makefile?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-to-add-a-configure-step-to-a-dune-project">How to add a configure step to a dune project?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#can-i-use-topkg-with-dune">Can I use topkg with dune?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#how-do-i-publish-my-packages-with-dune">How do I publish my packages with dune?</a></li>
<li class="toctree-l2"><a class="reference internal" href="faq.html#here-can-i-find-some-examples-of-projects-using-dune">here can I find some examples of projects using dune?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="known-issues.html">Known Issues</a><ul>
<li class="toctree-l2"><a class="reference internal" href="known-issues.html#mli-only-modules">mli only modules</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="migration.html">Migration</a><ul>
<li class="toctree-l2"><a class="reference internal" href="migration.html#timeline">Timeline</a><ul>
<li class="toctree-l3"><a class="reference internal" href="migration.html#july-2018-release-of-dune-1-0-0">July 2018: release of Dune 1.0.0</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#january-2019-deprecation-of-jbuilder">January 2019: deprecation of Jbuilder</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#july-2019-support-for-jbuilder-is-dropped">July 2019: support for Jbuilder is dropped</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#january-2020-the-jbuilder-binary-goes-away">January 2020: the jbuilder binary goes away</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#distant-future">Distant future</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="migration.html#check-list">Check List</a><ul>
<li class="toctree-l3"><a class="reference internal" href="migration.html#new-configuration-files">New configuration files</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#dune-project-files">dune-project files</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#dune-files">dune files</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#dune-workspace">dune-workspace</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#variable-syntax">Variable Syntax</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#files-recursively-in-is-removed"><code class="docutils literal notranslate"><span class="pre">(files_recursively_in</span> <span class="pre">..)</span></code> is removed</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#escape-sequences">Escape Sequences</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#comments-syntax">Comments Syntax</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#renamed-variables">Renamed Variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#removed-variables">Removed Variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="migration.html#jbuilder-gen-renamed"><code class="docutils literal notranslate"><span class="pre">#</span> <span class="pre">JBUILDER_GEN</span></code> renamed</a></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="quick-start.html" class="btn btn-neutral float-right" title="Quickstart" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017, Jérémie Dimino
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>
distrib
>
Mageia
>
7
>
armv7hl
>
media
>
core-release
>
by-pkgid
>
f068986ecc5d051850d4ea04085e7314
>
files
>
83
