OCaml Changelog

RSS

Read the latest releases and updates from the OCaml ecosystem.

Dune 1.10.0

On behalf of the dune team, I'm pleased to announce the 1.10.0 release of dune. This release is packed with bug fixes, but it also introduces a few interesting features. I'll highlight one important feature that we've introduced and plan to improve in future versions:

Dune allows you to specify package metadata in the dune project file and generate an appropriate opam file. This is advantageous to writing opam files manually as dune will correctly fill in some boilerplate such as the build command:

Here's a snippet from dune's own project file as a demonstration:

(generate_opam_files true) ;; necessary to enbale the generation

(license MIT)
(maintainers "Jane Street Group, LLC <opensource@janestreet.com>")
(authors "Jane Street Group, LLC <opensource@janestreet.com>")
(source (github ocaml/dune))
(documentation "https://dune.readthedocs.io/")

(package
 (name dune)
 (depends
  (ocaml (>= 4.02))
  base-unix
  base-threads)
 (conflicts
  (jbuilder (<> "transition"))
  (odoc (< 1.3.0))
  (dune-release (< 1.3.0)))
 (synopsis "Fast, portable and opinionated build system")
 (description "<redacted>"))

Generating the opam file is done via $ dune build @check (the @install, and @all aliases will also work).

Later, we plan to have dune do some sanity checks on the depends field. In the more distant future, we might even skip the generation step altogether by having opam invoke dune to get the generated opam file directly.

See full changelog
  • Restricted the set of variables available for expansion in the destination filename of install stanza to simplify implementation and avoid dependency cycles. (#2073, @aalekseyev, @jeremiedimino)

  • [menhir] call menhir from context root build_dir (#2067, @ejgallego, review by @jeremiedimino, @rgrinberg)

  • [coq] Add coq.pp stanza to help with pre-processing of grammar files (#2054, @ejgallego, review by @rgrinberg)

  • Add a new more generic form for the promote mode: (promote (until-clean) (into <dir>)) (#2068, @jeremiedimino)

  • Allow to promote only a subset of the targets via (promote (only <pred>)). For instance: (promote (only *.mli)) (#2068, @jeremiedimino)

  • Improve the behavior when a strict subset of the targets of a rule is already in the source tree for projects using the dune language < 1.10 (#2068, fixes #2061, @jeremiedimino)

  • With lang dune >= 1.10, rules in standard mode are no longer allowed to produce targets that are present in the source tree. This has been a warning for long enough (#2068, @jeremiedimino)

  • Allow %{...} variables in pps flags (#2076, @mlasson review by @jeremiedimino and @aalekseyev).

  • Add a 'cookies' option to ppx_rewriter/deriver flags in library stanzas. This allow to specify cookie requests from variables expanded at each invocation of the preprocessor. (#2106, @mlasson @jeremiedimino)

  • Add more opam metadata and use it to generate .opam files. In particular, a package field has been added to specify package specific information. (#2017, #2091, @avsm, @jonludlam, @rgrinberg)

  • Clean up the special support for findlib.dynload. Before, Dune would simply match on the library name. Now, we only match on the findlib package name when the library doesn't come from Dune. Someone writing a library called findlib.dynload with Dune would have to add (special_builtin_support findlib_dynload) to trigger the special behavior. (#2115, @jeremiedimino)

  • Install the future_syntax preprocessor as ocaml-syntax-shims.exe (#2125, @rgrinberg)

  • Hide full command on errors and warnings in development and show them in CI. (detected using the CI environment variable). Commands for which the invocation might be omitted must output an error prefixed with File . Add an --always-show-command-line option to disable this behavior and always show the full command. (#2120, fixes #1733, @rgrinberg)

  • In dune-workspace files, add the ability to choose the host context and to create duplicates of the default context with different settings. (#2098, @TheLortex, review by @jeremiedimino, @rgrinberg and @aalekseyev)

  • Add support for hg in dune subst (#2135, @jeremiedimino)

  • Don't build documentation for implementations of virtual libraries (#2141, fixes #2138, @jonludlam)

  • Fix generation of the -pp flag in .merlin (#2142, @rgrinberg)

  • Make dune subst add a (version ...) field to the dune-project file (#2148, @jeremiedimino)

  • Add the %{os_type} variable, which is a short-hand for %{ocaml-config:os_type} (#1764, @jeremiedimino)

  • Allow enabled_if fields in library stanzas, restricted to the %{os_type}, %{model}, %{architecture}, %{system} variables (#1764, #2164 @jeremiedimino, @rgrinberg)

  • Fix chdir on external and source paths. Dune will also fail gracefully if the external or source path does not exist (#2165, fixes #2158, @rgrinberg)

  • Support the .cc extension fro C++ sources (#2195, fixes #83, @rgrinberg)

  • Run ocamlformat relative to the context root. This improves the locations of errors. (#2196, fixes #1370, @rgrinberg)

  • Fix detection of README, LICENSE, CHANGE, and HISTORY files. These would be undetected whenever the project was nested in another workspace. (#2194, @rgrinberg)

  • Fix generation of .merlin whenever there's more than one stanza with the same ppx preprocessing specification (#2209 ,fixes #2206, @rgrinberg)

  • Fix generation of .merlin in the presence of the copy_files stanza and preprocessing specifications of other stanazs. (#2211, fixes #2206, @rgrinberg)

  • Run refmt from the context's root directory. This improves error messages in case of syntax errors. (#2223, @rgrinberg)

  • In .merlin files, don't pass -dump-ast to the future_syntax preprocessor. Merlin doesn't seem to like it when binary AST is generated by a -pp preprocessor. (#2236, @aalekseyev)

  • dune install will verify that all files mentioned in all .install files exist before trying to install anything. This prevents partial installation of packages (#2230, @rgrinberg)

Special thanks to Rudi Grinberg for helping us in reviewing and merging pull-requests.

See full changelog
  • backend

    • interpret -pp flag
    • backtrack warnings in all versions, not just 4.06
    • silence C compiler warnings (by David Allsopp and Bernhard Schommer)
    • remove sturgeon support
    • allow to select sections to log
    • better error message on ocaml version mismatch
    • locate:
      • handle functors and functor applications
      • do not use the location coming from the environment
    • tweaked caching policy
    • fix environment when a file disappears
    • fix -short-paths handling of classes and class types (by Leo White)
    • don't select deprecated paths in -short-paths (by Leo White)
    • return type info in outline query (by Andrey Popp)
    • properly handle new lines in the lexer
    • better tracking of errors reported by the parser and by preprocessors
    • add support for OCaml 4.08
    • tweaked the recovery strategy in presence of syntax errors
    • timing information in replies now includes wall clock time.
    • dump command can new dump the parsetree post preprocessing
  • editors modes

    • emacs

      • fix merlin-xref.el install (by Emilio Jesus Gallego Arias)
      • keep labels matching the prefix the user has typed rather than dropping them (by Mitchell Plamann)
      • remove unused merlin--overlay function (by Wilfred Hughes)
      • show the number of errors in the modline (by Wilfred Hughes)
      • call a logger on the client side if one is defined
      • allow user to disable completion inside comments and strings
      • show errors and types even when buffer is narrowed (by Wilfred Hughes)
      • make sure PATH is updated when merlin-command is 'opam
    • vim

      • better FindBinary
      • make the log buffer a scratch buffer (by Tom Johnson)
      • execute buffer switching silently (by Fabian)
      • restore view after updating merlin type buffer (by Fabian)
  • testsuite

    • Switched to mdx with cram syntax.
See full changelog
  • Add confirmation prompts in some commands. (#144, #146, @NathanReb)
  • Use github returned archive URL instead of guessing it. Fixes a bug when releasing a version with URL incompatible characters to github. (#143, @NathanReb)
  • Add logs to better describe commands behaviour. (#141, #137, #135, #150, #153, @NathanReb)
  • Fix a bug when publishing documentation to a repo for the first time (#136, @NathanReb)
  • Allow to submit package to a different opam-repository hosted on github. (#140, #152, @NathanReb)
  • Use dune subst for watermarking. (#147, @NathanReb)
  • Fix linting step so it checks for CHANGES, LICENSE and README again

Utop 2.4.0

See full changelog

General

  • Better support for wide and combined glyph (@kandu)
  • Added tips for simpe prompt without fancy features (Marshall Abrams, #279)
  • Correct quoting for Windows command shell (Dmitry Bely, #272)

Additions

  • 4.08 compatibility (#284)
  • module UTop: add get_load_path and set_load_path to manage the include directories (#284)

Breaking

  • module UTop: val load_path : string list ref is removed (#284)

Dune 1.9.2

See full changelog
  • Put back library variants in development mode. We discovered a serious unexpected issue and we might need to adjust the design of this feature before we are ready to commit to a final version. Users will need to write (using library_variants 0.1) in their dune-project file if they want to use it before the design is finalized. (#2116, @diml)

  • Forbid to attach a variant to a library that implements a virtual library outside the current project (#2104, @rgrinberg)

  • Fix a bug where dune install would install man pages to incorrect paths when compared to opam-installer. For example dune now installs (foo.1 as man1/foo.1) correctly and previously that was installed to man1/man1/foo.1. (#2105, @aalekseyev)

  • Do not fail when a findlib directory doesn't exist (#2101, fix #2099, @diml)

  • [coq] Rename (coqlib ...) to (coq.theory ...), support for coqlib will be dropped in the 1.0 version of the Coq language (#2055, @ejgallego)

  • Fix crash when calculating library dependency closure (#2090, fixes #2085, @rgrinberg)

  • Clean up the special support for findlib.dynload. Before, Dune would simply match on the library name. Now, we only match on the findlib package name when the library doesn't come from Dune. Someone writing a library called findlib.dynload with Dune would have to add (special_builton_support findlib_dynload) to trigger the special behavior. (#2115, @diml)

  • Include permissions in the digest of targets and dependencies (#2121, fix #1426, @rgrinberg, @xclerc)

Dune 1.9.3

See full changelog
  • Fix .install files not being generated (#2124, fixes #2123, @rgrinberg)

Dune 1.9.1

See full changelog
  • Fix invocation of odoc to add previously missing include paths, impacting mld files that are not in directories containing libraries (#2016, fixes #2007, @jonludlam)

We are pleased to announce the release of opam 2.0.4.

This new version contains some backported fixes:

Note: To homogenise macOS name on system detection, we decided to keep macos, and convert darwin to macos in opam. For the moment, to not break jobs & CIs, we keep uploading darwin & macos binaries, but from the 2.1.0 release, only macos ones will be kept.


Installation instructions (unchanged):

  1. From binaries: run

    sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)
    

    or download manually from the Github "Releases" page to your PATH. In this case, don't forget to run opam init --reinit -ni to enable sandboxing if you had version 2.0.0~rc manually installed or to update you sandbox script.

  2. From source, using opam:

    opam update; opam install opam-devel
    

    (then copy the opam binary to your PATH as explained, and don't forget to run opam init --reinit -ni to enable sandboxing if you had version 2.0.0~rc manually installed or to update you sandbox script)

  3. From source, manually: see the instructions in the README.

We hope you enjoy this new minor version, and remain open to bug reports and suggestions.

NOTE: this article is cross-posted on opam.ocaml.org and ocamlpro.com. Please head to the latter for the comments!

See full changelog
  • Remove assert false in favor of error message. (#125, @ejgallego)
  • Embed a 'version: "$release-version"' in each opam file of the current directory to get reproducible releases (#128, #129, @hannesm)
  • Generate sha256 and sha512 checksums for release (#131, @hannesm)
  • Grammar fixes (#132, @anmonteiro)
  • Handle doc fields with no trailing slash (#133, @yomimono)

Dune 1.9.0

On behalf of the dune team, I'm pleased to announce the release of Dune 1.9.0. This release introduces a few exciting new features:

  • A tagging mechanism for implementations called variants
  • The ability to build libraries in the Coq proof assistant.
  • A new dune init command to help users quickly generate boilerplate and get start with dune projects (contributed by @shonfeder)

I would like to thank Lucas Pluvinage and @ejgallego for contributing the first two features respectively. They've also collaborated on a blog post to describe these features in detail.

See full changelog
  • Warn when generated .merlin does not reflect the preprocessing specification. This occurs when multiple stanzas in the same directory use different preprocessing specifications. This warning can now be disabled with allow_approx_merlin (#1947, fix #1946, @rgrinberg)

  • Watch mode: display "Success" in green and "Had errors" in red (#1956, @emillon)

  • Fix glob dependencies on installed directories (#1965, @rgrinberg)

  • Add support for library variants and default implementations. (#1900, @TheLortex)

  • Add experimental $ dune init command. This command is used to create or update project boilerplate. (#1448, fixes #159, @shonfeder)

  • Experimental Coq support (fix #1466, @ejgallego)

  • Install .cmi files of private modules in a .private directory (#1983, fix #1973 @rgrinberg)

  • Fix dune subst attempting to substitute on directories. (#2000, fix #1997, @rgrinberg)

  • Do not list private modules in the generated index. (#2009, fix #2008, @rgrinberg)

  • Warn instead of failing if an opam file fails to parse. This opam file can still be used to define scope. (#2023, @rgrinberg)

  • Do not crash if unable to read a directory when traversing to find root (#2024, @rgrinberg)

  • Do not exit dune if some source directories are unreadable. Instead, warn the user that such directories need to be ignored (#2004, fix #310, @rgrinberg)

  • Fix nested (binaries ..) fields in the env stanza. Previously, parent binaries fields would be ignored, but instead they should be combined. (#2029, @rgrinberg)

  • Allow "." in c_names and cxx_names (#2036, fix #2033, @rgrinberg)

  • Format rules: if a dune file uses OCaml syntax, do not format it. (#2014, fix #2012, @emillon)

See full changelog
  • Admin: remove CHANGES.md that was essentially git log (@jberdine)
  • Admin: simplify release procedure (@jberdine)
  • Build: fix ocaml version constraint, need 4.06 (@jberdine)
  • Improve: make gen_version an ocaml script (@hhugo)
  • Improve: fix associativity of Pexp_setfield (#725, @jberdine)
  • Improve: normalize setfield and setinstvar (#720, @gpetiot)
  • Remove: deprecated config file syntax parsing (#715, @jberdine)
  • Improve: put the equal first for ocp-indent-compat (#717, @gpetiot)
  • Fix: parse docstrings once (#713, @gpetiot)
  • Improve: new profiles conventional and ocamlformat (#663, @gpetiot)
  • Revert module indentation (#714, @gpetiot)
  • Fix infix wrap (#691, @gpetiot)
  • Fix doc comments tag only when docstring parsing disabled (#711, @gpetiot)
  • Fix missing space before closing paren around function (#705, @jberdine)
  • Fix documentation of doc-comments-tag-only (#710, @gpetiot)
  • Improve: module-item-spacing=preserve (#538, @gpetiot)
  • Add a space in "Jane Street" (#703, @kevinji)
  • Fix js_source.ml (#702, @gpetiot)
  • Fix space-around-collection-expressions for record/variant definitions (#670, @Julow)
  • Fix extra space ifthenelse (#700, @gpetiot)
  • Improve split attribute in let binding for expect test with uncaught exn (#681, @gpetiot)
  • Fix empty newline before equal (#701, @gpetiot)
  • Fix double cmts (#678, @gpetiot)
  • Fix value binding ocp indent compat (#694, @gpetiot)
  • Fix ast changed when record ident constrained (#697, @gpetiot)
  • Fix incorrect ocaml code (#698, @gpetiot)
  • Fix fmt for CI (#693, @gpetiot)
  • Fix record break (#689, @gpetiot)
  • Fix break before parens no wrap fun args (#690, @gpetiot)
  • Improve: disable conf in files and attributes (#684, @gpetiot)
  • Fix space around tuples (#679, @gpetiot)
  • Improve: break before in for let-module construct, because of ocp-indent (#685, @gpetiot)
  • Improve debugging output (#677, @hhugo)
  • Improve: group open/close of modules and fix indentation (#665, @gpetiot)
  • Fix constrained match in record (#676, @gpetiot)
  • Fix: formatting of end line comments (#662, @gpetiot)
  • Fix cmt in fun when no break infix (#668, @gpetiot)
  • Add the wrap-fun-decl option (#645, @Julow)
  • Improve: break the list of 'with type' module constraints (#639, @gpetiot)
  • Reduce the use of Poly comparisons (#661, @hhugo)
  • Improve: check flag to check whether the input files already are formatted (#657, @gpetiot)
  • Fix cmt placement infix op (#651, @gpetiot)
  • Restore compat with base.v0.11 (@hhugo)
  • Fix: disallow '-' with other inputs (#658, @hhugo)
  • Fix build on OCaml 4.06.1 (#646, @Julow)
  • Fix comments on record fields (#650, @Julow)
  • Fix cmts in list (#654, @gpetiot)
  • Improve: If-then-else = fit-or-vertical mode (#603, @gpetiot)
  • Link to man page from readme (#648, @yawaramin)
  • Fix indent match branches with cmts (#644, @gpetiot)
  • Build: update to base v0.12 (#642, @jberdine)
  • Fit tag-only doc comments (#637, @Julow)
  • Fix try%lwt indent (#638, @gpetiot)
  • Fix type manifest formatting (#616, @gpetiot)
  • Fix: don't include ocamlformat_diff in ocamlformat (#636, @Khady)
  • fix emacs setup (#631, @Khady)
  • tools/update_tests.sh --all (#632, Julow)
  • Fix: don't break line before wrapping comment (#634, @gpetiot)
  • Fix ignored ocamlformat attribute (#615, @gpetiot)
  • Include jsoo in the tests (#618, @hhugo)
  • Fix missing break before comment (#613, @gpetiot)
  • Do not rely on the file-system to format sources (#611, @hhugo)
  • Ignore file in .ocamlformat-ignore (#606, @hhugo)
  • Improve reason support (#608, @hhugo)
  • Fix: fix fmt_ast wrt strings and chars when sources are not available (#607, @hhugo)
  • Fix ocamlformat_reason (#604, @hhugo)
  • Fix missing break for local open record patterns (#602, @gpetiot)
  • Fix regression for variants with docstrings (#601, @gpetiot)
  • Fix extra break in module pack type (#600, @Julow)
  • Add the doc-comments-padding option (#575, @Julow)
  • Improve: externalize Sugar functions from Fmt_ast.ml (#593, @gpetiot)
  • Fix typedecl attribute (#595, @gpetiot)
  • Improve: less linebreaks for break-cases=fit (#536, @gpetiot)
  • fix #590 (#594, @hhugo)
  • Make gen_version.sh use bash. (#592, @hhugo)
  • Implement box debugging (#574, @Julow)
  • Break closing bracket in polymorphic variants (#583, @Julow)
  • Break comment record (#580, @Julow)
  • missing headers (@hhugo)
  • Improve: mishandling of field_space in record exps and patterns (#587, @jberdine)
  • Add empty mli for executable (#591, @hhugo)
  • tests: test ocamlformat when disabled (@hhugo)
  • dont reformat if disabled (@hhugo)
  • remove global ref in Transation_unit (@hhugo)
  • Fix Emacs (>26.1) temporary buffer not killed (#567, @ludwigpacifici)
  • Improve: opam file for ocamlformat_diff to remove the bos dependency (#579, @gpetiot)
  • Fix: Require Octavius version 1.2.0 (#576, @Julow)
  • Improve: record fields with type constraints (#565, @jberdine)
  • Fix: comments attachment (#548, @gpetiot)
  • Improve: parens around constrained any-pattern (#431, @gpetiot)
  • Revise formatting of compact single case matches (#552, @jberdine)
  • Fix typo in help text (#553) (Wilfred Hughes)
  • Improve: calculate length of comment strings using UTF8 (#550, @jberdine)
  • Admin: update travis versions of ocaml and opam (#551, @jberdine)
  • Fix: missing break before ; _ (#549, @jberdine)
  • Improve: module item spacing in sparse mode (#546, @jberdine)
  • Improve: some simplifications (#542, @gpetiot)
  • Improve: remove unnecessary parens when open module (#537, @gpetiot)
  • Improve: not breaking after bind/map operators (#463, @gpetiot)
  • Fix suboptimal docstring formatting (#540, @gpetiot)
  • amend janestreet profile (#524, @mbarbin)
  • Improve: option break-separators (#461, @gpetiot)
  • Fix formatting of types with ocp-indent-compat=true (#525, @gpetiot)
  • Preserve shebang (#533, @gpetiot)
  • Fix: remove indented empty lines between comments (#531, @gpetiot)
  • Improve: remove indented empty lines separating recursive modules (#528, @gpetiot)
  • add update_tests.sh (#529, @gpetiot)
  • Improve: space around collection expressions (#527, @gpetiot)
  • Improve: remove more spaces inside parenthesized multiline constructs (#526, @gpetiot)
  • Disable docstring parsing for external tests (#518, @gpetiot)
  • Fix odoc normalize (#520, @gpetiot)
  • Better docstring error msgs (#519, @gpetiot)
  • Fix odoc seps (#511, @gpetiot)
  • Improve: option 'single-case' (#426, @gpetiot)
  • Add a parens-tuple-patterns configuration option (#498, @NathanReb)
  • Fix: comments should not be parsed for diff (#509, @gpetiot)
  • Fix: odoc refs (#510, @gpetiot)
  • Fix formatting of or-patterns in try expressions (#503, @NathanReb)
  • Test: improve test_branch.sh to allow different config for branch (#496, @jberdine)
  • Improve: option 'parens-ite' (#430, @gpetiot)
  • fix break-struct for toplevel items (not in a struct) (#497, @gpetiot)
  • Fix: breaking of variant types (#486, @gpetiot)
  • Improve: autocompletion of git branch names for test_branch.sh (#485, @gpetiot)
  • Fix: Sanitize docstring check (#481, @gpetiot)
  • Improve the formatting of lists in doc comments (#480, @jeremiedimino)
  • Add PR test script and update contributing guidelines with expected usage (#479, @jberdine)
  • Fix break struct natural (#443, @gpetiot)
  • Fix: disable-outside-detected-project: disable ocamlformat when no .ocamlformat file is found (#475, @gpetiot)
  • Improve: error message when docstrings move (#446, @gpetiot)
  • Improve: print-config prints all options (#465, @gpetiot)
  • Ocamldoc docstrings (#460, @gpetiot)
  • Doc: disable-outside-detected-project (#468, @gpetiot)
  • Improve: shorter output of regtests (#469, @gpetiot)
  • Admin: add code of conduct and copyright headers to build and package system (@jberdine)
  • Improve: add license header for tools/ocamlformat-diff/ocamlformat_diff.ml (#466, @gpetiot)
  • Build: a few simplifications enabled by dune 1.1.1 (#457, @jberdine)
  • Improve: record fields with attributes and docs in type definitions (#458, @jberdine)
  • Fix exception comments (#459, @gpetiot)
  • Ocamlformat diff tool (#450, @gpetiot)

Dune 1.8.2

See full changelog
  • Fix auto-generated index.mld. Use correct headings for the listing. (#1925, @rgrinberg, @aantron)

Dune 1.8.1

See full changelog
  • Correctly write dune-package when version is empty string (#1919, fix #1918, @rgrinberg)

Odoc 1.4.0

We are pleased to announce release 1.4.0 of odoc, the new, Dune-friendly documentation generator for OCaml and ReasonML.

odoc-output|690x444

You can install odoc and generate docs for your Dune project with:

opam update
opam install odoc
dune build @doc

Then, view the docs by opening _build/default/_doc/_html/index.html!

While release 1.4.0 has new features, it is mainly focused on stability and maintainability. See its full changelog here. The previous release, 1.3.0 last October, included a lot of new code. Because of concerns about its stability, we chose not to widely announce 1.3.0. So, this message serves as an announcement for both releases :) The full changelog for 1.3.0 can be found here.

In summary, compared with 1.2.0, odoc now has:

For now, we plan to continue improving the stability of odoc and the quality of its output. In the longer term, odoc has two significant goals:

  • To replace ocamldoc as OCaml's primary documentation generator. At the core of odoc is a powerful cross-referencer, capable of fully handling the complexity of OCaml's module system. Shortcomings in ocamldoc's ability to resolve cross-references in complex projects were one of the original motivations for starting odoc.

  • To create centrally-hosted, cross-referenced, searchable online documentation for all the published packages in opam, a “docs.ocaml.org.”

Thanks to the odoc users and contributors, and happy documenting!

See full changelog

Changes

  • All parsing errors are now recoverable warnings (#238).
  • Page titles are now level-0 headings ({0 ...}), and top-level sections within a page are level-1 headings ({1 ...}) (#217, Rizo Isrof).
  • Don't render definitions of externals (#275, Nik Graf).
  • Disable programming ligatures (#248).
  • Rename --root-uri option to --xref-base-uri (#223, Rizo Isrof).
  • Deprecate redundant reference kind annotations (#246).

Additions

  • Preliminary compatibility with the current 4.08 beta releases (#309, Jon Ludlam).
  • Paragraph headings ({4 ...}) and subparagraph headings ({5 ...}) (#217, Rizo Isrof).
  • odoc support-files-targets command (#232).
  • Recommend bsdoc for using odoc with BuckleScript (#269, Leandro Ostera).

Bugs fixed

  • Improve breadcrumbs on .mld pages (#293, Daniel Buenzli).
  • Display tables of contents in nested module and class pages (#261, Rizo Isrof).
  • Uncaught exception when parsing references to operators with - in them, such as @-> (#178).
  • Incorrect parsing of references to operators with . in them, such as *. (#237).
  • Assertion failure when processing optional arguments in an .ml file with a type annotation, when that type annotation uses an alias of 'a option (#101).
  • Assertion failure when two modules with the same name are found by odoc (#148, Jon Ludlam).
  • Verbatim blocks ({v ... v}) can now only be terminated if the v} is immediately preceded by whitespace (#71, reported Daniel Buenzli).
  • Wrong column numbers for errors reported in comments (#227, #253).
  • Restore parsing of ocamldoc-style reference kind annotations (#244).
  • Ordinary type keyword instead of and rendered in HTML for mutually-recursive types (#105, reported @Fourchaux).
  • nonrec keyword not rendered (#249).
  • and not rendered for mutually-recursive modules, classes, and class types (#251).
  • Outer comment attached to a module rendered when the module is included (#87, Jon Ludlam).
  • Polymorphic variant constructor documentation not rendered (#176, reported @steinuil).
  • Variant constructor and record field documentation styled differently (#260, Jon Ludlam).
  • Sloppy keyword markup in HTML output (#319).
  • Rendering of multiple constraint clauses (#321).
  • Incorrect order of functor arguments (#261, Rizo Isrof).
  • odoc html option -o now creates the output directory if it does not exist #171, #264 Rizo Isrof).
  • odoc html-targets output now includes path prefix given through -o option (#173, Rizo Isrof).
  • Allow -I and -o options to refer to non-existent directories (#32, #170, Daniel Buenzli).
  • Make odoc compile-targets match odoc compile (#273, Daniel Buenzli).
  • odoc compile-deps does not work on .cmt files (#162, Daniel Buenzli).
  • odoc html-deps now scans for .odoc files recursively (#307, Daniel Buenzli).
  • odoc html-targets ignores stop comments (#276, Daniel Buenzli).
  • odoc html-targets and odoc html-deps segfault on .mld pages (#277, #282, Daneil Buenzli).
  • --theme-uri option not propagated to some subpages (#318, Thomas Refis).
  • Binary files not opened in binary mode (#281, Ulrik Strid).

Build and development

  • Always print backtraces for unhandled exceptions (3d10feb).
  • CI on macOS (#216, Leandro Ostera).
  • Test runner improvements (#266, Rizo Isrof).
  • Fix esy builds in Travis (#301, Jon Ludlam).
  • Don't require make in the esy build (#308, Leandro Ostera).
  • Get rid of some large GADTs (#292, Jon Ludlam).
  • Remove dependency on bos (#305, Daniel Buenzli).
  • Remove dependency on rresult (#306, Daniel Buenzli).
  • Remove dependency on bisect_ppx, previously present in development checkouts (#316).

Dune 1.8.0

On behalf of the dune team, I'm pleased to announce release 1.8. The highlight of this release is a standalone preprocessor that allows OCaml programs to use the new let bindings introduced in 1.8 and still be compatible with OCaml versions all the way back to 4.02.

This release includes some important contributions from a new contributor: @aalekseyev. So I would like to use this opportunity to welcome him to the team. Thanks Arseniy!

See full changelog
  • Clean up watch mode polling loop: improves signal handling and error handling during polling (#1912, fix #1907, fix #1671, @aalekseyev)

  • Change status messages during polling to be one-line, so that the messages are correctly erased by ^K. (#1912, @aalekseyev)

  • Add support for .cxx extension for C++ stubs (#1831, @rgrinberg)

  • Add DUNE_WORKSPACE variable. This variable is equivalent to setting --workspace in the command line. (#1711, fix #1503, @rgrinberg)

  • Add c_flags and cxx_flags to env profile settings (#1700 and #1800, @gretay-js)

  • Format dune printenv output (#1867, fix #1862, @emillon)

  • Add the (promote-into <dir>) and `(promote-until-clean-into

    )` modes for `(rule ...)` stanzas, so that files can be promoted in another directory than the current one. For instance, this is used in merlin to promote menhir generated files in a directory that depends on the version of the compiler (#1890, @jeremiedimino)
  • Improve error message when dune subst fails (#1898, fix #1897, @rgrinberg)

  • Add more GC counters to catapult traces (fix908, @rgrinberg)

  • Add a preprocessor shim for the let+ syntax of OCaml 4.08 (#1899, implements #1891, @jeremiedimino)

  • Fix generation of .merlin files on Windows. \ characters needed to be escaped (#1869, @mlasson)

  • Fix 0 error code when $ dune format-dune-file fails. (#1915, fix #1914, @rgrinberg)

  • Configurator: deprecated query_expr and introduced query_expr_err which is the same but with a better error in case it fails. (#1886, @ejgallego)

  • Make sure (menhir (mode promote) ...) stanzas are ignored when using --ignore-promoted-rules or -p (#1917, @jeremiedimino)

Mdx 1.3.0

See full changelog
  • Updated readme file with the new features: dune rules, named environment and ocaml versions, Some grammar correction too (@gpetiot, #101, aantron, #102)
  • Better lexer error messages (@avsm, #103)
  • Added cram syntax parsing (@trefis, #106)
  • Renamed mdx to ocaml-mdx to avoid conflicts/for more precision (@clecat, #110, #115)
  • Fix blank spaces causing parsing errors (@gpetiot, #97)
  • Fix empty lines causing a String.sub (@clecat, #107)

Dune 1.7.3

See full changelog
  • Fix interpretation of META files containing archives with / in the filename. For instance, this was causing llvm to be unusable with dune (#1889, fix #1885, @diml)

  • Make errors about menhir stanzas be located (#1881, fix #1876, @diml)

Dune 1.7.2

See full changelog
  • Add ${corrected-suffix}, ${library-name} and a few other variables to the list of variables to upgrade. This fixes the support for various framework producing corrections (#1840, #1853, @diml)

  • Fix $ dune subst failing because the build directory wasn't set. (#1854, fix #1846, @rgrinberg)

  • Configurator: Add warning to Pkg_config.query when a full package expression is used. Add Pkg_config.query_expr for cases when the full power of pkg-config's querying is needed (#1842, fix #1833, @rgrinberg)

  • Fix unavailable, optional implementations eagerly breaking the build (#1857, fix #1856, @rgrinberg)

Dune 1.7.1

See full changelog
  • Fix the watch mode (#1837, #1839, fix #1836, @diml)

  • Configurator: Fix misquoting when running pkg-config (#1835, fix #1833, @Chris00)

Dune 1.7.0

On behalf of the dune team, I'm pleased to announce the release of dune 1.7.0. This release is the biggest release since 1.0 and I'm excited to present it to you. The change log is quite long so I'll summarize the most noteworthy changes:

  • The jbuilder binary and jbuild files are officially deprecated. But not to worry, we've created a $ dune upgrade command to do the hard work for you.

  • The virtual libraries feature has made it to 1.7.0. I've blogged about it before

  • There's now a mode to disable transitive dependencies. This mode still has some caveats because it lacks proper compiler support. But we welcome user reports regarding its usability.

  • Dune now has a --trace-file to profile slow builds using shiny flame graphs in Chrome.

See full changelog
  • Second step of the deprecation of jbuilder: the jbuilder binary now emits a warning on every startup and both jbuilder and dune emit warnings when encountering jbuild files (#1752, @jeremiedimino)

  • Change the layout of build artifacts inside _build. The new layout enables optimizations that depend on the presence of .cmx files of private modules (#1676, @bobot)

  • Fix merlin handling of private module visibility (#1653 @bobot)

  • unstable-fmt: use boxes to wrap some lists (#1608, fix #1153, @emillon, thanks to @rgrinberg)

  • skip directories when looking up programs in the PATH (#1628, fixes #1616, @jeremiedimino)

  • Use lsof on macOS to implement --stats (#1636, fixes #1634, @xclerc)

  • Generate dune-package files for every package. These files are installed and read instead of META files whenever they are available (#1329, @rgrinberg)

  • Fix preprocessing for libraries with (include_subdirs ..) (#1624, fix #1626, @nojb, @rgrinberg)

  • Do not generate targets for archive that don't match the modes field. (#1632, fix #1617, @rgrinberg)

  • When executing actions, open files lazily and close them as soon as possible in order to reduce the maximum number of file descriptors opened by Dune (#1635, #1643, fixes #1633, @jonludlam, @rgrinberg, @jeremiedimino)

  • Reimplement the core of Dune using a new generic memoization system (#1489, @rudihorn, @jeremiedimino)

  • Replace the broken cycle detection algorithm by a state of the art one from this paper (#1489, @rudihorn)

  • Get the correct environment node for multi project workspaces (#1648, @rgrinberg)

  • Add dune compute to call internal memoized functions (#1528, @rudihorn, @jeremiedimino)

  • Add --trace-file option to trace dune internals (#1639, fix #1180, @emillon)

  • Add --no-print-directory (borrowed from GNU make) to suppress Entering directory messages. (#1668, @dra27)

  • Remove --stats and track fd usage in --trace-file (#1667, @emillon)

  • Add virtual libraries feature and enable it by default (#1430 fixes #921, @rgrinberg)

  • Fix handling of Control+C in watch mode (#1678, fixes #1671, @jeremiedimino)

  • Look for jsoo runtime in the same dir as the js_of_ocaml binary when the ocamlfind package is not available (#1467, @nojb)

  • Make the seq package available for OCaml >= 4.07 (#1714, @rgrinberg)

  • Add locations to error messages where a rule fails to generate targets and rules that require files outside the build/source directory. (#1708, fixes #848, @rgrinberg)

  • Let Configurator handle sizeof (in addition to negative numbers). (#1726, fixes #1723, @Chris00)

  • Fix an issue causing menhir generated parsers to fail to build in some cases. The fix is to systematically use -short-paths when calling ocamlc -i (#1743, fix #1504, @jeremiedimino)

  • Never raise when printing located errors. The code that would print the location excerpts was prone to raising. (#1744, fix #1736, @rgrinberg)

  • Add a dune upgrade command for upgrading jbuilder projects to Dune (#1749, @jeremiedimino)

  • When automatically creating a dune-project file, insert the detected name in it (#1749, @jeremiedimino)

  • Add (implicit_transitive_deps <bool>) mode to dune projects. When this mode is turned off, transitive dependencies are not accessible. Only listed dependencies are directly accessible. (#1734, #430, @rgrinberg, @hnrgrgr)

  • Add toplevel stanza. This stanza is used to define toplevels with libraries already preloaded. (#1713, @rgrinberg)

  • Generate .merlin files that account for normal preprocessors defined using a subset of the action language. (#1768, @rgrinberg)

  • Emit (orig_src_dir <path>) metadata in dune-package for dune packages built with --store-orig-source-dir command line flag (also controlled by DUNE_STORE_ORIG_SOURCE_DIR env variable). This is later used to generate .merlin with S-directives pointed to original source locations and thus allowing merlin to see those. (#1750, @andreypopp)

  • Improve the behavior of dune promote when the files to be promoted have been deleted. (#1775, fixes #1772, @jeremiedimino)

  • unstable-fmt: preserve comments (#1766, @emillon)

  • Pass flags correctly when using staged_pps (#1779, fixes #1774, @jeremiedimino)

  • Fix an issue with the use of (mode promote) in the menhir stanza. It was previously causing intermediate mock files to be promoted (#1783, fixes #1781, @jeremiedimino)

  • unstable-fmt: ignore files using OCaml syntax (#1784, @emillon)

  • Configurator: Add which function to replace the which command line utility in a cross platform way. (#1773, fixes #1705, @Chris00)

  • Make configurator append paths to $PKG_CONFIG_PATH on macOS. Previously it was prepending paths and thus $PKG_CONFIG_PATH set by users could have been overridden by homebrew installed libraries (#1785, @andreypopp)

  • Disallow c/cxx sources that share an object file in the same stubs archive. This means that foo.c and foo.cpp can no longer exist in the same library. (#1788, @rgrinberg)

  • Forbid use of %{targets} (or ${@} in jbuild files) inside preprocessing actions (#1812, fixes #1811, @jeremiedimino)

  • Add DUNE_PROFILE environment variable to easily set the profile. (#1806, @rgrinberg)

  • Deprecate the undocumented (no_keep_locs) field. It was only necessary until virtual libraries were supported (#1822, fix #1816, @jeremiedimino)

  • Rename unstable-fmt to format-dune-file and remove its --inplace option. (#1821, @emillon).

  • Autoformatting: (using fmt 1.1) will also format dune files (#1821, @emillon).

  • Autoformatting: record dependencies on .ocamlformat-ignore files (#1824, fixes #1793, @emillon)

Utop 2.3.0

The new feature in this release is to automatically install printers marked with [@@ocaml.toplevel_printer] (#269 @diml). Adding this annotation to your libraries will remove the need to have a separate top package to install the printers.

For example, in the uri library, the old printing function for Uri.t was:

val pp_hum : Format.formatter -> t -> unit

Just adding this annotation results in Uri.t values being automatically pretty printed in this version of utop.

val pp_hum : Format.formatter -> t -> unit [@@ocaml.toplevel_printer]
See full changelog
  • Add cool screenshot to README (#259 @rizo) and update links (#257 @bobot)
  • Improve robustness by using more tail-recursive functions (#251 @gpetiot)
  • Remove deprecation warnings in newer compilers (#246 @ncihnegn)
  • Minimum OCaml version supported is now 4.03.0 (#254 @XVilka)
  • Publish API documentation online and add doc: entry to opam file (#270 @avsm)
  • Port build to dune from jbuilder (#268 @avsm)
  • Upgrade local opam metadata to opam 2.0 format (#268 @avsm)

We are pleased to announce the release of opam 2.0.3.

This new version contains some backported fixes:

  • Fix manpage remaining $ (OPAMBESTEFFORT)
  • Fix OPAMROOTISOK handling
  • Regenerate missing environment file

Installation instructions (unchanged):

  1. From binaries: run

    sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)
    

    or download manually from the Github "Releases" page to your PATH. In this case, don't forget to run opam init --reinit -ni to enable sandboxing if you had version 2.0.0~rc manually installed or to update you sandbox script.

  2. From source, using opam:

    opam update; opam install opam-devel
    

    (then copy the opam binary to your PATH as explained, and don't forget to run opam init --reinit -ni to enable sandboxing if you had version 2.0.0~rc manually installed or to update you sandbox script)

  3. From source, manually: see the instructions in the README.

We hope you enjoy this new major version, and remain open to bug reports and suggestions.

NOTE: this article is cross-posted on opam.ocaml.org and ocamlpro.com. Please head to the latter for the comments!

Mdx 1.2.0

See full changelog
  • Support end-of-line ellipsis (@dra27, #85)
  • Support OCaml 4.02.3 (@gpetiot, #86)
  • Support version=.., version<=.. and version>=.. keywords to run a code-block depending on the currently installed OCaml version (@gpetiot, #87, #90)
  • Upgrade Travis tests to use opam 2.0.2 (@avsm, #89)
  • Do not depend on ppx_tools for toplevel (@avsm, #89)
  • Fix embedding in a larger Dune project with a cppo override (@avsm, #89)
  • mdx output: escape HTML entities in code blocks (#91, @samoht)
  • Add a mechanism to promote files to blocks and blocks to file (@gpetiot, #37)
  • Support multiple toplevel environments (@gpetiot, #38)
  • Use ocaml-migrate-parsetree to compile in 4.06.1 & 4.07.0 (@gpetiot, #41)
  • Add a mdx rule command to generate dune rules (@gpetiot, #44)
  • Add a mdx output command to generate an HTML document (@samoht, #45)
  • Support empty code blocks (@samoht, #46)
  • Fix detection of OCaml code/toplevel (@samoht, #47)
  • Better handling of multi-line shell scripts (@samoht, #48)
  • Fix regression in toplevel blocks when creating newtype (@samoht, #49)
  • Fix evaluation of non-determinitic test (@samoht, #50)
  • Improve mdx rules to take into account more precise dependencies (@samoht, #51)
  • Fix promotion of blocks to complete ML files (@samoht, #52)
  • mdx does not use the cppo library, just the binary (@samoht, #53)
  • fix ellipsis in code blocks (@samoht, #57)
  • Fix relative paths for promoted blocks to files (@samoht, #58)
  • Fix location of errors for multi-line commands (@samoht, #60)
  • improve the parser for shell blocks (@samoht, #61)
  • Allow to load preludes in specific environments (@samoht, #63)
  • Fix evaluation of code after directives in prelude (@samoht, #64)
  • Improve promotion to ml files (@samoht, #66)
  • mdx rule: generates (source_tree) dependencies for directory metadata (@samoht, #67)
  • Fix handling of 'module type' in multiple toplevel environment (@samoht, #68)
  • Add an eval=false label to skip the evaluation of a code block (@samoht, #69)
  • Fix parsing of shell blocks with multiple exit codes (@samoht, #71)
  • Support source-tree as extra block metadata (@samoht, #72)
  • Better formatting of non-compiling promoted contents (@samoht, #73)
  • Be sure to remove the .corrected files if the promotion to ML file works (mdx74)
  • Add missing dependency in test/dune (@samoht, #75)
  • Support dir=.. labels in ml code blocks (@samoht, #76)
  • Allow to promote to mli files too (@samoht, #77)
  • Support multi-line strings (@samoht, #78)
  • fail (and exit 1) if prelude and ml blocks cannot be evaluated properly (@samoht, #80, @samoht, #83)
  • Allow to pass --root to mdx rule (@samoht, #81)
  • mdx rule: do not add (package mdx) in the dependencies (@samoht, #82)

Dune 1.6.3

The dune team is pleased to announce the bug fix release of Dune 1.6.3. Normally, we don't bother announcing all bug fix releases, but this one contains quite a few fixes. I'd like to take this opportunity to encourage everyone to upgrade. Cheers.

See full changelog
  • Fix merlin handling of private module visibility (#1653 @bobot)

  • skip directories when looking up programs in the PATH (#1628, fixes #1616, @jeremiedimino)

  • Fix preprocessing for libraries with (include_subdirs ..) (#1624, fix #1626, @nojb, @rgrinberg)

  • Do not generate targets for archive that don't match the modes field. (#1632, fix #1617, @rgrinberg)

  • When executing actions, open files lazily and close them as soon as possible in order to reduce the maximum number of file descriptors opened by Dune (#1635, #1643, fixes #1633, @jonludlam, @rgrinberg, @jeremiedimino)

  • Do not generate targets for archive that don't match the modes field. (#1632, fix #1617, @rgrinberg)

  • Get the correct environment node for multi project workspaces (#1648, @rgrinberg)

  • Fix an issue causing menhir generated parsers to fail to build in some cases. The fix is to systematically use -short-paths when calling ocamlc -i (#1743, fix #1504, @jeremiedimino)

We are pleased to announce the release of opam 2.0.2.

As sandbox scripts have been updated, don't forget to run opam init --reinit -ni to update yours.

This new version contains mainly backported fixes:

  • Doc:
    • update man page
    • add message for deprecated options
    • reinsert removed ones to print a deprecated message instead of fail (e.g. --alias-of)
    • deprecate no-aspcud
  • Pin:
    • on pinning, rebuild updated pin-depends packages reliably
    • include descr & url files on pinning 1.2 opam files
  • Sandbox:
    • handle symlinks in bubblewrap for system directories such as /bin or /lib (#3661). Fixes sandboxing on some distributions such as CentOS 7 and Arch Linux.
    • allow use of unix domain sockets on macOS (#3659)
    • change one-line conditional to if statement which was incompatible with set -e
    • make /var readonly instead of empty and rw
  • Path: resolve default opam root path
  • System: suffix .out for read_command_output stdout files
  • Locked: check consistency with opam file when reading lock file to suggest regeneration message
  • Show: remove pin depends messages
  • Cudf: Fix closure computation in the presence of cycles to have a complete graph if a cycle is present in the graph (typically ocaml-base-compilerocaml)
  • List: Fix some cases of listing coinstallable packages
  • Format upgrade: extract archived source files of version-pinned packages
  • Core: add is_archive in OpamSystem and OpamFilename
  • Init: don't fail if empty compiler given
  • Lint: fix light_uninstall flag for error 52
  • Build: partial port to dune
  • Update cold compiler to 4.07.1

Installation instructions (unchanged):

  1. From binaries: run

    sh <(curl -sL https://raw.githubusercontent.com/ocaml/opam/master/shell/install.sh)
    

    or download manually from the Github "Releases" page to your PATH. In this case, don't forget to run opam init --reinit -ni to enable sandboxing if you had version 2.0.0~rc manually installed or to update your sandbox script.

  2. From source, using opam:

    opam update; opam install opam-devel
    

    (then copy the opam binary to your PATH as explained, and don't forget to run opam init --reinit -ni to enable sandboxing if you had version 2.0.0~rc manually installed or to update you sandbox script)

  3. From source, manually: see the instructions in the README.

We hope you enjoy this new minor version, and remain open to bug reports and suggestions.

NOTE: this article is cross-posted on opam.ocaml.org and ocamlpro.com. Please head to the latter for the comments!

Dune 1.6.2

See full changelog
  • Fix regression introduced by #1554 reported in: https://github.com/ocaml/dune/issues/734#issuecomment-444177134 (#1612, @rgrinberg)

  • Fix dune external-lib-deps when preprocessors are not installed (#1607, @diml)

Dune 1.6.1

See full changelog
  • Fix hash collision for on-demand ppx rewriters once and for all (#1602, fixes #1524, @diml)

  • Add dune external-lib-deps --sexp --unstable-by-dir so that the output can be easily processed by a machine (#1599, @diml)

Dune 1.6.0

The dune team is pleased to announce the release of Dune 1.6.0. This release does not contain any notable features or bug fixes that need to be specifically pointed out. Nevertheless, I expect that this will be a quality of life improvement to power users who have experienced dune's sharper corners.

Happy hacking!

See full changelog
  • Expand variables in install stanzas (#1354, @mseri)

  • Add predicate language support for specifying sub directories. This allows the use globs, set operations, and special values in specifying the sub directories used for the build. For example: (dirs :standard \ lib*) will use all directories except those that start with lib. (#1517, #1568, @rgrinberg)

  • Add binaries field to the (env ..) stanza. This field sets and overrides binaries for rules defined in a directory. (#1521, @rgrinberg)

  • Fix a crash caused by using an extension in a project without dune-project file (#1535, fix #1529, @jeremiedimino)

  • Allow %{bin:..}, %{exe:..}, and other static expansions in the deps field. (#1155, fix #1531, @rgrinberg)

  • Fix bad interaction between on-demand ppx rewriters and using multiple build contexts (#1545, @jeremiedimino)

  • Fix handling of installed .dune files when the backend is declared via a dune file (#1551, fixes #1549, @jeremiedimino)

  • Add a --stats command line option to record resource usage (#1543, @jeremiedimino)

  • Fix dune build @doc deleting highlight.pack.js on rebuilds, after the first build (#1557, @aantron).

  • Allow targets to be directories, which Dune will treat opaquely (#1547, @jordwalke)

  • Support for OCaml 4.08: List.t is now provided by OCaml (#1561, @ejgallego)

  • Exclude the local esy directory (_esy) from the list of watched directories (#1578, @andreypopp)

  • Fix the output of dune external-lib-deps (#1594, @jeremiedimino)

  • Introduce data_only_dirs to replace ignored_subdirs. ignored_subdirs is deprecated since 1.6. (#1590, @rgrinberg)

  • Add dune external-lib-deps --sexp --unstable-by-dir so that the output can be easily processed by a machine (#1599, @jeremiedimino)

See full changelog
  • lots of small fixes
  • better handling of attributes and extension points
  • better handling of GADT definitions
  • fixed a stack-overflow on extremely large files
  • indent the same (1 step) after let f = fun x -> and let f =\n fun x ->
  • build using dune

Dune 1.5.1

See full changelog
  • Fix dune utop <dir> when invoked from a sub-directory of the project (#1520, fix #1518, @diml)

  • Fix bad interaction between on-demand ppx rewriters and polling mode (#1525, fix #1524, @diml)

If you want to contribute to a new release announcement, check out the Contributing Guide on GitHub.