Welcome to dune’s documentation!

• Quickstart
  • Building a hello world program
  • Building a hello world program using Lwt
  • Building a hello world program using Core and Jane Street PPXs
  • Defining a library using Lwt and ocaml-re
  • Setting the OCaml compilation flags globally
  • Using cppo
    • Using the .cppo.ml style like the ocamlbuild plugin
  • Defining a library with C stubs
  • Defining a library with C stubs using pkg-config
  • Using a custom code generator
  • Defining tests
  • Building a custom toplevel
• Overview
• Terminology
• Project Layout and Metadata Specification
  • Metadata format
    • Comments
    • Atoms
    • Strings
    • End of line strings
    • Lists
    • Variables
  • dune-project files
    • name
    • version
  • <package>.opam files
    • Scopes
    • Package version
    • Odig conventions
  • jbuild-ignore (deprecated)
• dune files
  • Stanzas
    • jbuild_version
    • library
    • executable
    • executables
    • rule
    • ocamllex
    • ocamlyacc
    • menhir
    • alias
    • install
    • copy_files
    • include
    • tests
    • test
    • env
    • dirs (since 1.6)
    • data_only_dirs (since 1.6)
    • ignored_subdirs (deprecated in 1.6)
    • include_subdirs
    • toplevel
  • Common items
    • Ordered set language
    • Boolean Language
    • Variables expansion
    • Library dependencies
    • Preprocessing specification
    • Dependency specification
    • OCaml flags
    • js_of_ocaml
    • User actions
    • Locks
    • Diffing and promotion
  • OCaml syntax
• Writing and running tests
  • Running tests
  • Inline tests
    • Inline expectation tests
    • Specifying inline test dependencies
    • Passing special arguments to the test runner
    • Using additional libraries in the test runner
    • Defining your own inline test backend
  • Custom tests
    • Diffing the result
• Dealing with foreign libraries
  • Adding C/C++ stubs to an OCaml library
    • Header files
    • Installing header files
  • Foreign build sandboxing
    • Limitations
    • Real example
• Generating Documentation
  • Prerequisites
  • Writing Documentation
  • Building Documentation
  • Documentation Stanza
    • Examples
• Usage
  • Initializing components
  • Finding the root
    • dune-workspace
    • Current directory
    • Forcing the root (for scripts)
  • Interpretation of targets
    • Resolution
    • Aliases
    • Default alias
    • Built-in Aliases
  • Finding external libraries
  • Running tests
  • Watch mode
  • Launching the Toplevel (REPL)
    • Requirements & Limitations
  • Restricting the set of packages
  • Invocation from opam
  • Tests
  • Installation
    • Destination
  • Workspace configuration
    • dune-workspace
  • Distributing Projects
  • Watermarking
  • dune subst
  • Custom Build Directory
• Advanced topics
  • META file generation
  • Findlib integration and limitations
  • Dynamic loading of packages
  • Cross Compilation
    • How does it work?
  • Classical ppx
  • Profiling dune
  • Implicit Transitive Deps
• Configurator
  • Usage
  • Upgrading from the old Configurator
• Menhir
  • Basic Usage
  • Modular Menhir
  • Flags
  • --infer mode
  • cmly targets
• js_of_ocaml
  • Compiling to JS
  • js_of_ocaml field
  • Separate Compilation
• opam
  • Generating opam files
    • Opam Template
• Virtual Libraries & Variants
  • Virtual Library
  • Implementation
  • Variants
  • Default implementation
  • Limitations
• Automatic formatting
  • Enabling automatic formatting
  • Formatting a project
  • Only enabling it for certain languages
  • Version history
    • 1.1
    • 1.0
• Coq
  • Basic Usage
  • Preprocessing with coqpp
  • Recursive Qualification of Modules
  • Limitations
• FAQ
  • Why do many dune projects contain a Makefile?
  • How to add a configure step to a dune project?
  • Can I use topkg with dune?
  • How do I publish my packages with dune?
  • Where can I find some examples of projects using dune?
  • What is Jenga?
  • How to make warnings non-fatal?
• Known Issues
  • mli only modules
• Migration
  • Timeline
    • July 2018: release of Dune 1.0.0
    • January 2019: deprecation of Jbuilder
    • July 2019: support for Jbuilder is dropped
    • January 2020: the jbuilder binary goes away
    • Distant future
  • Check List
    • New configuration files
    • dune-project files
    • dune files
    • dune-workspace
    • Variable Syntax
    • (files_recursively_in ..) is removed
    • Escape Sequences
    • Comments Syntax
    • Renamed Variables
    • Removed Variables
    • # JBUILDER_GEN renamed