OCaml Changelog

Fixed

• Stop re-running cram tests after promotion when it's not necessary (#11994, @rgrinberg)

• fix: $ dune subst should not fail when adding the version field in opam files (#11801, fixes #11045, @btjorge)

• Kill all processes in the process group after the main process has terminated; in particular this avoids background processes in cram tests to stick around after the test finished (#11841, fixes #11820, @Alizter, @Leonidas-from-XIV)

Added

• (tests) stanzas now generate aliases with the test name. To run (test (name a)) you can do dune build @runtest-a. (#11558, grants part of #10239, @Alizter)

• Inline test libraries now produce aliases runtest-name_of_lib allowing users to run specific inline tests as dune build @runtest-name_of_lib. (#11109, partially fixes #10239, @Alizter)

• feature: $ dune subst use version from dune-project when no version control repository has been detected (#11801, @btjorge)

• Allow dune exec to run concurrently with another instance of dune in watch mode (#11840, @gridbugs)

• Introduce %{os}, %{os_version}, %{os_distribution}, and %{os_family} percent forms. These have the same values as their opam counterparts. (#11863, @rgrinberg)

• Introduce option (implicit_transitive_deps false-if-hidden-includes-supported) that is equivalent to (implicit_transitive_deps false) when -H is supported by the compiler (OCaml >= 5.2) and equivalent to (implicit_transitive_deps true) otherwise. (#11866, fixes #11212, @nojb)

• Add dune describe location for printing the path to the executable that would be run (#11905, @gridbugs)

• dune runtest can now understand absolute paths as well as run tests in specific build contexts (#11936, @Alizter).

• Added 'empty' alias which contains no targets. (#11556 #11952 #11955 #11956, grants #4161, @Alizter and @rgrinberg)

• Allow dune promote to properly run while a watch mode server is running (#12010, @ElectreAAS)

• Add --alias and --alias-rec flags as an alternative to the @@ and @ syntax in the command line (#12043, fixes #5775, @rgrinberg)

• Added a (timeout <float>) field to the (cram) stanza to specify per-test time limits. Tests exceeding the timeout are terminated with an error. (#12041, @Alizter)

Changed

• Format long lists in s-expressions to fill the line instead of formatting them in a vertical way (#10892, fixes #10860, @nojb)

• Switch from MD5 to BLAKE3 for digesting targets and rules. BLAKE3 is both more performant and difficult to break than MD5 (#11735, @rgrinberg, @Alizter)

• Print a warning when dune build runs over RPC (#11833, @gridbugs)

• Stop emitting empty module group wrapper .js file in melange.emit (#11987, fixes #11986, @anmonteiro)

Differences Between alpha0 and alpha1:

Added in alpha1:

• Added a (timeout <float>) field to the (cram) stanza to specify per-test
  time limits. Tests exceeding the timeout are terminated with an error.
  (#12041, @Alizter)

Reference Changes:

• RPC warning entry changed from referencing issue #11836 in alpha0 to pull request #11833 in alpha1

Fixed

• Stop re-running cram tests after promotion when it's not necessary (#11994,
  @rgrinberg)

• fix: $ dune subst should not fail when adding the version field in opam
  files (#11801, fixes #11045, @btjorge)

• Kill all processes in the process group after the main process has
  terminated; in particular this avoids background processes in cram tests to
  stick around after the test finished (#11841, fixes #11820, @Alizter,
  @Leonidas-from-XIV)

Added

• (tests) stanzas now generate aliases with the test name. To run
  (test (name a)) you can do dune build @runtest-a. (#11558, grants part of #10239,
  @Alizter)

• Inline test libraries now produce aliases runtest-name_of_lib
  allowing users to run specific inline tests as dune build @runtest-name_of_lib. (#11109, partially fixes #10239, @Alizter)

• feature: $ dune subst use version from dune-project when no version
  control repository has been detected (#11801, @btjorge)

• Allow dune exec to run concurrently with another instance of dune in watch
  mode (#11840, @gridbugs)

• Introduce %{os}, %{os_version}, %{os_distribution}, and %{os_family}
  percent forms. These have the same values as their opam counterparts.
  (#11863, @rgrinberg)

• Introduce option (implicit_transitive_deps false-if-hidden-includes-supported)
  that is equivalent to (implicit_transitive_deps false) when -H is
  supported by the compiler (OCaml >= 5.2) and equivalent to
  (implicit_transitive_deps true) otherwise. (#11866, fixes #11212, @nojb)

• Add dune describe location for printing the path to the executable that
  would be run (#11905, @gridbugs)

• dune runtest can now understand absolute paths as well as run tests in
  specific build contexts (#11936, @Alizter).

• Added 'empty' alias which contains no targets. (#11556 #11952 #11955 #11956,
  grants #4161, @Alizter and @rgrinberg)

• Allow dune promote to properly run while a watch mode server is running
  (#12010, @ElectreAAS)

• Add --alias and --alias-rec flags as an alternative to the @ and @@
  syntax in the command line (#12043, fixes #5775, @rgrinberg)

Changed

• Format long lists in s-expressions to fill the line instead of
  formatting them in a vertical way (#10892, fixes #10860, @nojb)

• Switch from MD5 to BLAKE3 for digesting targets and rules. BLAKE3 is both more
  performant and difficult to break than MD5 (#11735, @rgrinberg, @Alizter)

• Print a warning when dune build runs over RPC (#11836, @gridbugs)

• Stop emitting empty module group wrapper .js file in melange.emit
  (#11987, fixes #11986, @anmonteiro)

• Add support for OCaml 5.4 (#500, @Octachron, @anmonteiro)
• restore backtrace (#503, fixes #501, @ysalmon)
• support camlp$n preprocessor (#486, fixes #485, @aqjune)
• utop configuration and state files (utoprc, utop-history) are now always in the relevant utop subdirectory (#484, fixes #478, #481 and #499, @tuohy).
• fix emacs completion for qualified paths (Module.M.some\_name) (#497, fix #455, @juergenhoetzel, @bbatsov)
• implicit bindings for emacs mode (#465, fix #412, @bencef)

### Added

• Exposed sherlodoc libraries for use in other projects (@jonludlam, #1349)
• OCaml 5.4.0 support (@Octachron, #1355)
• New arguments to LaTeX generator, --shorten-beyond-depth and
  --remove-functor-arg-link (@Octachron, #1337)
• New experimental markdown generator (@davesnx, #1341)

Changed

• Remove cmdliner compatibility layer, no longer needed (@dbuenzli, #1328)
• Drop support for OCaml < 4.08 (@jonludlam, #1300)
• Allow referencing libraries from package added in odoc-config.sexp
  (@panglesd, #1343)
• Use full path in heading labels in LaTeX backend (@Octachron, #1332)
• Separate page from anchor in LaTeX labels to prevent collisions (@Octachron,
  #1337)

Fixed

• Fix bug in parsing META files when there are no dependencies (@jonludlam, #1352)
• Fix #1335 - incorrect rendering when on medium screen size with no global
  sidebar (@lukemaurer, #1361)
• Fixed generation of occurrences for docs CI (@jonludlam, #1362)
• Partial fix for #1369 - ensure that we never create a link to a hidden page
  (@jonludlam, #1370)

• Fix ppxlib driver's AST to source printer. Our copy of pprintast was not properly updated which resulted in incorrect printing of value bindings' constraints (#585, @NathanReb)

Changes

• Fix opam switch create <version> when all compilers of that version are flagged with avoid-version [#6571 @rjbou - fix #6563]
• Opam update performance: No longer copy VCS directories when adding or updating local non-VCS repositories [#6575 @kit-ty-kate - fix #6560]
• Do not remove the generated patch file during updates when debug-mode is on [#6575 @kit-ty-kate]

Release script

• Switch the host of qemu-base-images from gitlab to github [#6510 @kit-ty-kate]
• Speedup the initial clone of qemu-base-images when missing [#6510 @kit-ty-kate]
• Update some of the platforms the prebuilt binaries are built on to Alpine 2.21, FreeBSD 14.3, OpenBSD 7.7 and NetBSD 10.1 [#6510 @kit-ty-kate]

Build changes

• Use coreutils' sha512sum instead of perl's shasum utility when using ./configure --with-cygwin-setup [#6566 @kit-ty-kate - fix #6557]
• Upgrade the download-if-missing dependencies to dune 3.19.1, opam-file-format 2.2.0, spdx_licenses 1.4.0 and patch 3.0.0 [#6580 @kit-ty-kate]

Testing and documentation

• Improve and extend the testsuite [#6473 #6571 @rjbou @kit-ty-kate]
• Improve and extend the test infrastructure [#6575 @kit-ty-kate]

API updates

opam-format

• OpamLocal: fetch_repo_update no longer copies vcs directories [#6575 @kit-ty-kate]

opam-core

• OpamSystem: Add copy_dir_except_vcs [#6575 @kit-ty-kate]
• OpamSystem: Add get_files_except_vcs [#6575 @kit-ty-kate]

Features

• Make inlay-hint for function parameters configurable (#1515)
• Add custom ocamllsp/jumpToTypedHole to navigate through typed holes (#1516)
• Add a code-action for combining pattern cases (just relaying on regex) (#1514)
• Allow (by configuration) shortening of diagnostics (just highlighting the first line) (#1513)
• Fix yojson_of_t for Nullable_option: serialize None as Null instead of asserting false (#1525 fixes #1524)

Fixes

• Support for class, class type, method and property for DocumentSymbol query (#1487 fixes #1449)
• Fix inlay-hint for function parameters (#1515)
• More precise diagnostics in the event of a failed identifier search (Definition_query) (#1518)
• Remove ocamlformat application after destruct (that remove some useful parenthesis) (#1519)

• merlin library
  • Expose utilities to manipulate typed-holes in Merlin_analysis.Typed_hole
    (#1888)
  • locate can now disambiguate between files with identical names and contents
    (#1882)
  • occurrences now reports stale files (#1885)
  • inlay-hints fix inlay hints on function parameters (#1923)
  • Fix issues with ident validation and Lid comparison for occurrences (#1924)
  • Handle class type in outline (#1932)
  • Handle locally defined value in outline (#1936)
  • Fix a typer issue triggering assertions in the short-paths graph (#1935,
    fixes #1913)
  • Downstreamed a typer fix from 5.3.X that would trigger assertions linked
    to scopes bit masks when backtracking the typer cache (#1935)
  • Add a new selection field to outline results that contains the location of
    the symbol itself. (#1942)
  • Fix destruct hanging when printing patterns with (::). (#1944, fixes
    ocaml/ocaml-lsp#1489)
  • Reproduce and fix a handful of jump-to-definition (locate) issues (#1930,
    fixes #1580 and #1588, workaround for #1934)
• ocaml-index
  • Improve the granularity of index reading by segmenting the marshalization
    of the involved data-structures. (#1889)
• test suite
  • Add a test case illustrating wrong open order proposed in issue #1900. (#1901)

Features

• Make inlay-hint for function parameters configurable (#1515)

• Add custom ocamllsp/jumpToTypedHole to navigate through typed holes (#1516)

• Add a code-action for combining pattern cases (just relaying on regex) (#1514)

• Allow (by configuration) shortening of diagnostics (just highlighting the first line) (#1513)

• Fix yojson_of_t for Nullable_option: serialize None as Null instead of asserting false (#1525 fixes #1524)

Fixes

• Support for class, class type, method and property for DocumentSymbol query (#1487 fixes #1449)

• Fix inlay-hint for function parameters (#1515)

• More precise diagnostics in the event of a failed identifier search (Definition_query) (#1518)

• Remove ocamlformat application after destruct (that remove some useful parenthesis) (#1519)

• Add a new server option standardHover, that can be used by clients to
  disable the default hover provider. When standardHover = false
textDocument/hover requests always returns with empty result. (#1416)

• merlin library
  • Expose utilities to manipulate typed-holes in Merlin_analysis.Typed_hole
    (#1888)
  • inlay-hints fix inlay hints on function parameters (#1923)
  • Handle class type in outline (#1932)
  • Handle locally defined value in outline (#1936)
• vim plugin
  • Added support for search-by-type (#1846)
    This is exposed through the existing :MerlinSearch command, that
    switches between search-by-type and polarity search depending on the
    first character of the query.

New option/command/subcommand are prefixed with ◈.

Changes

Install of dependencies --deps-only

Behaviour

• ◈ Change the behaviour of --deps-only, where it no longer requires unicity of package version between the request and the installed packages. In other words, if you have pkg.1 installed, installing dependencies of pkg.2 no longer removes pkg.1. This also allows to install dependencies of conflicting packages when their dependencies are compliant. [#6520 @rjbou]

Fixes

Fixed some bugs in opam install --deps-only (and other commands simulating package pins, such as --depext-only) more visible in 2.4:

• When a package pkg is already installed and opam install ./pkg --deps is called, if there is a conflict between the installed pkg dependencies and the definition of the local pkg, the conflict was not seen and the already installed pkg was kept [#6530 @rjbou - fix #6529]
• No longer fetch and write the sources when simulating packages that were already pinned [#6533 @rjbou - fix #6532]
• opam was triggering the reinstall of the package based on the already pinned packages instead of the expected newly simulated pinned packages [#6522 @rjbou - partial fix #6501]
• opam was using the opam description of the wrong package in some cases [#6544 @kit-ty-kate - fix #6535]

Reinstall

• Fix a regression where the internal sources directory was removed unexpectedly on reinstall actions, making opam re-fetch the package [#6550 @rjbou - fix #6551]

Update

Fixed a couple of regressions in opam update:

• An unexpected stack overflow exception was raised when updating repositories with large files when opam is compiled with OCaml < 5.1 [#6527 @kit-ty-kate - fix #6513]
• Updating a repository where a line was added at the end of a file without final newline character was making the update fail [#6527 @kit-ty-kate - fix hannesm/patch#28]

Windows

• Improve the prebuilt Windows binaries by including Cygwin's setup-x86_64.exe in the binary itself as fallback, in case cygwin.com is inaccessible [#6538 @kit-ty-kate]

Build changes

• Bump the downloaded-if-missing dune to 3.19.0, cppo to 1.8.0, ocamlgraph to 2.2.0, uutf to 1.0.4 and patch to 3.0.0~beta1 [#6527 @kit-ty-kate]
• Allows ./configure --without-dune to build with OCaml 5.4 [#6527 @kit-ty-kate]
• Add a --with-cygwin-setup option to the configure script, only available on Windows and disabled by default, which includes the optionally given setup-x86_64.exe binary inside the opam binary. If the option is given without a filename, the file with be fetched from cygwin.com [#6526 @kit-ty-kate @dra27 @rjbou - fix #6498]

Testing and documentation

• Improve and extend the testsuite [#6530 #6533 #6539 #6544 #6550 #6520 @rjbou @kit-ty-kate]
• Improve and extend the test infrastructure [#6524 #6553 #6549 @kit-ty-kate @rjbou]

API updates

opam-client

• OpamAction.cleanup_artefacts: no longer removes the internal sources directory if the package is installed but not pinned [#6550 @rjbou]

Fixed

• Revert changes in dune exec behaviour introduced in 3.19.0. (#11879, fixes #11870, #11867 and #11881, @Alizter)

Fixed

• Fixed a bug that was causing cram tests attached to multiple aliases to be run multiple times. (#11547, @Alizter)

• Fix: pass pkg-config (extra) args in all pkgconfig invocations. A missing --personality flag would result in pkgconf not finding libraries in some contexts. (#11619, @MisterDA)

• Fix: Evaluate enabled_if when computing the stubs for stanzas such as foreign_library (#11707, @Alizter, @rgrinberg)

• Fix $ dune describe pp for libraries in the presence of (include_subdirs unqualified) (#11729, fixes #10999, @rgrinberg)

• Fix $ dune subst in sub directories of a git repository (#11760, fixes #11045, @Richard-Degenne)

• Fix a crash involving Path.drop_prefix when using Melange on Windows (#11767, @nojb)

Added

• Added detection and warning for common typos in package dependency constraints (#11600, fixes #11575, @kemsguy7)

• Added (extra_objects) field to (foreign_library) stanza with (:include) support. (#11683, @Alizter)

Changed

• Allow build RPC messages to be handled by dune's RPC server in eager watch mode (#11622, @gridbugs)

• Allow concurrent build with RPC server (#11712, @gridbugs)

Fixed

• Fixed a bug that was causing cram tests attached to multiple aliases to be run multiple
  times. (#11547, @Alizter)

• Fix: pass pkg-config (extra) args in all pkgconfig invocations. A missing --personality
  flag would result in pkgconf not finding libraries in some contexts. (#11619, @MisterDA)

• Fix: Evaluate enabled_if when computing the stubs for stanzas such as
  foreign_library (#11707, @Alizter, @rgrinberg)

• Fix $ dune describe pp for libraries in the presence of (include_subdirs unqualified) (#11729, fixes #10999, @rgrinberg)

• Fix $ dune subst in sub directories of a git repository (#11760, fixes
  #11045, @Richard-Degenne)

• Fix a crash involving Path.drop_prefix when using Melange on Windows
  (#11767, @nojb)

Added

• Added detection and warning for common typos in package dependency
  constraints (#11600, fixes #11575, @kemsguy7)

• Added (extra_objects) field to (foreign_library) stanza with (:include) support.
  (#11683, @Alizter)

Changed

• Allow build RPC messages to be handled by dune's RPC server in eager watch
  mode (#11622, @gridbugs)

• Allow concurrent build with RPC server (#11712, @gridbugs)

Changes

• Do not include compiler packages flagged with avoid-version/deprecated in the generated invariant when calling opam switch create [name] <version> [#6494 @kit-ty-kate]
• Cygwin: Fallback to the existing setup-x86_64.exe if its upgrade failed to be fetched [#6482 @kit-ty-kate - fix #6495, partial fix #6474]
• Fix a memory leak happening when running large numbers of commands or opening large number of opam files [#6485 @hannesm - fix #6484]
• Remove handling of the OPAMSTATS environment variable [#6485 @hannesm]

Regression fixes from 2.4.0~alpha1

• Fix a crash when updating a repository that is deleting or adding empty files [#6490 @kit-ty-kate]
• Fix an extreme performance issue (takes several hours) when applying a large repository update [#6490 @kit-ty-kate]
• Fix a crash when updating a git repository that moved a file to a new directory [#6490 @kit-ty-kate]

Build changes

• Update the requirement for the patch library to 3.0.0~alpha2 [#6490 @kit-ty-kate]
• Upgrade the downloaded-if-missing patch library to 3.0.0~alpha2 [#6490 @kit-ty-kate]

Testing and documentation

• Improve and extend the testsuite [#6490 #6494 @rjbou @kit-ty-kate]
• Improve and extend the test infrastructure [#6277 @rjbou @kit-ty-kate]

API updates

opam-core

• OpamArg.environment_variable: make STATS as removed from cli 2.3 [#6485 @rjbou]
• OpamClientConfig: remove STATS variant and related print_stats field in config record [#6485 @hannesm]

opam-format

• OpamFile: remove Stats module [#6485 @hannesm]

opam-core

• OpamSystem: remove print_stats function [#6485 @hannesm]
• OpamSystem: add the rmdir_cleanup function [#6490 @kit-ty-kate]
• OpamSystem.dir_is_empty: Speedup and change its type to handle unreachable directories better [#6490 @kit-ty-kate]
• OpamSystem.internal_patch: remove parent directories when all of their content has been moved somewhere else [#6490 @kit-ty-kate]
• OpamSystem.internal_patch: fix moving files to new directories when receiving a git diff [#6490 @kit-ty-kate]

Fixed

• fix compatibility with ocaml.5.4.0 by avoiding shadowing sigwinch (@nojb, #11639)

• Upgrade to opam 2.4.0 and OCaml 4.08 [#169 @kit-ty-kate]

Possibly scripts breaking changes are prefixed with ✘.
New option/command/subcommand are prefixed with ◈.

Major changes

Init

• Remove ocaml-system from the list of default compilers chosen at opam init time [#6307 @kit-ty-kate - fix #3509]

Patch: update & install

• Patches are now applied using the patch OCaml library instead of GNU Patch [#5892 @kit-ty-kate - fix #6019 #6052 #3782 ocaml/setup-ocaml#933]
  • Context diffs are not supported anymore, only Unified diffs are (including its git extensions)
  • Stop support of file permission changes via git extension to the unified diff specification
  • GNU patch and the diff command are no longer runtime dependencies

Depexts

• Support providing external dependencies with Nix by adding support for stateless depexts systems [#5982 @RyanGibb @rjbou @kit-ty-kate - fix #5124]

Show

• opam show now displays the version number of packages flagged with avoid-version/deprecated gray [#6358 @kit-ty-kate - fix #6354]

Install

• Fix opam install <local_dir> not updating or storing pinned packages' metadata [#6209 @kit-ty-kate - fix #5567]
• Fix opam install --deps-only/--show-action <local_dir> not updating (without storing) pinned packages' metadata [#6209 @kit-ty-kate - fix #5567]

Pin

• ✘ Fail when trying to pin a package whose definition could not be found instead of forcing interactive edition (e.g. this could happen when making a typo in the package name of a pin-depends) [#6319 @kit-ty-kate - fix #6322]
• ◈ opam pin/opam pin list now displays the current revision of a pinned repository in a new column [#6274 @desumn - fix #5533]

Admin

• ◈ Add opam admin compare-versions to compare package versions for sanity checks [#6197 @mbarbin]
• ◈ Add opam admin migrate-extrafiles which moves all extra-files of an existing opam repository into extra-sources [#5960 @hannesm @rjbou @kit-ty-kate]
• ✘ The -i/--ignore-test-doc argument has been removed from opam admin check [#6335 @kit-ty-kate]
• ✘ opam admin check now sets with-test and with-doc to false instead of true [#6335 @kit-ty-kate]

Miscellaneous changes

Global CLI

• Add --cli/OPAMCLI version 2.4 [#6268 @mbarbin @rjbou]

Install

• Remove the build directories of pinned packages after successful builds [#6436 @kit-ty-kate]

UI

• Improve the messages when a package is not up-to-date on opam upgrade [#6272 @kit-ty-kate - fix #6270]
• Use a non-underline uppercase character to denote the default when asking a question [#6289 @hannesm @kit-ty-kate - fix #6288]
• Do not pre-write the answer to questions with the default anwser [#6376 @kit-ty-kate]
• Display Windows NTSTATUS exit codes in hex [#6401 @dra27 @MisterDA]

Switch

• Fix opam switch remove <dir> failure when it is a linked switch [#6276 @btjorge - fix #6275]
• Fix opam switch list-available when given several arguments [#6318 @kit-ty-kate]
• Correctly handle pkg.version pattern in opam switch list-available [#6186 @arozovyk - fix #6152]

Upgrade

• Do not show the not-up-to-date message with packages tagged with avoid-version/deprecated [#6273 @kit-ty-kate - fix #6271]
• Fix a regression on opam upgrade <package> upgrading unrelated packages [#6373 @AltGr]
• Fix a regression on opam upgrade --all <uninstalled-pkg> not upgrading the whole switch [#6373 @kit-ty-kate]

Source

• ◈ Add options --require-checksums and --no-checksums to harmonise with opam install [#5563 @rjbou]

Lint

• ◈ Add W74 to opam lint to detect pin-depends packages that are neither present in the depends no depopts field [#6317 @rjbou - fix #5795]
• ◈ Add E63 to opam lint to check for availability guard in case an opam file contains a subpath field [#6438 @rjbou @kit-ty-kate]

Lock

• Fix pin-depends for with-* dependencies when creating a lock file [#5471 @rjbou - fix #5428]
• ◈ Add opam lock --keep-local to keep local pins url in pin-depends field [#6411 @rjbou - fix #4897]

Env

• Add the OPAMSOLVERTOLERANCE environment variable to allow users to fix solver timeouts for good [#5510 @kit-ty-kate - fix #3230]
• Don't write empty environment update segments to variables.sh (FOO += "" no longer adds FOO='':"$FOO"; export FOO;) [#6198 @dra27]

Sandbox

• Respect the DUNE_CACHE_ROOT environment variable if it exists [#6326 @smorimoto]
• Fix sandboxing support in NixOS [#6333 @kit-ty-kate]

Software Heritage

• Rework Software heritage fallback to have a more correct archive retrieval and more fine grained error handling [#6036 @rjbou - fix #5721]
• Fix Software Heritage liveness check [#6036 @rjbou - fix #5721]
• Update the Software Heritage API requests [#6036 @rjbou]
• Remove wget support for Software Heritage fallback [#6036 @rjbou - fix #5721]

Repository

• Fix curl download command selection when loaded from global config file [#6302 @rjbou]
• Check that the repositories given to opam repository remove actually exist [#5014 @kit-ty-kate - fixes #5012]
• ✘ Symlinks in repositories are no longer supported [#5892 @kit-ty-kate]
• Fix subpath handling in opam files defining a local archive [#6439 @rjbou]

Init

• Fix the detection of ZDOTDIR when using zsh [#6299 @acasta-yhliu - fix #6281]

External dependencies (depexts)

• ◈ Add apt-rpm/ALTLinux family support for depexts [#6207 @RiderALT]
• Fix the detection of installed external packages on OpenBSD to not just consider manually installed packages [#6362 @semarie]
• Speedup the detection of available system packages with pacman and brew [#6324 @kit-ty-kate]
• Change probing tool for SUSE-based distributions from zypper to rpm [#6464 @kit-ty-kate]
• Disable the detection of available system packages on SUSE-based distributions [#6464 @kit-ty-kate]
• Add support for stateless depexts systems, by keeping synchronised already installed systems dependencies with switch state [#5982 @RyanGibb @rjbou @kit-ty-kate]

Pin

• Don't ask confirmation when pinning an unknown package (absent from repositories) [#6309 @kit-ty-kate @rjbou - fix #3199]
• Do not ask to install pin-depends twice [#6375 @kit-ty-kate - fix #6374]
• Ensure the right version (the pinned one) of packages are used when simulating pinning [#6256 @rjbou @kit-ty-kate - fix #6248 #6379]
• No longer double pin of packages located in ./opam/opam [#6343 @kit-ty-kate - fix #6342]

Build changes

• Simplify the making of stripped binaries by introducing the make opam-stripped target [#6208 @kit-ty-kate]
• Fix compilation on macOS with OCaml 5.3 by bumping the downloaded-if-missing mccs to 1.1+19 [#6192 @kit-ty-kate]
• Upgrade the downloaded-if-missing opam-file-format to 2.2.0~alpha1, spdx_licenses to 1.3.0 and dune to 3.16.1 [#6321 #6370 #6192 @kit-ty-kate - fix #6369]
• menhir is now part of the transitive dependency of opam (via opam-file-format) [#6321 @kit-ty-kate]

Admin

• Fix opam admin check in the presence of the with-dev-setup variable [#6331 @kit-ty-kate - fix #6329]

Download

• Add fetch on DragonFlyBSD and ftp on NetBSD to the list of download tools to use, if available [#6304 #6305 @kit-ty-kate]
• Prefer curl over any other download tools on every systems, if available [#6305 @kit-ty-kate]
• Avoid issues when using wget2 as download-tool where the requested url might return an HTML page instead of the expected content [#6303 @kit-ty-kate]

Internal

• Allow running some opam commands on machines with limited amount of memory by running Gc.compact while the main process is waiting for the children processes [#5396 @kkeundotnet]
• Use a C stub to call the uname function from the C standard library instead of calling the uname POSIX command [#6217 @kit-ty-kate]
• Only download Cygwin's setup.exe when the command is actually going to be displayed or used [#6467 @kit-ty-kate]

Testing and documentation

• Improve and extend the tests [#5892 #6276 #6331 #6343 #6378 #6273 #6380 #6373 #6307 #6256 #6412 #6438 #6439 #6436 #6166 #6209 #6198 #6319 #6467 #5643 #5982 @rjbou @kit-ty-kate @btjorge]
• Improve and extend the benchmarks [#6212 #6443 @kit-ty-kate]
• Improve and extend the test infrastructure [#5349 #6296 #6274 #6313 #6363 #6192 #5663 #6383 #6444 #6447 #6471 #6469 #5982 @kit-ty-kate @rjbou @RyanGibb]
• Improve and extend the documentation [#6226 #6231 #6252 #6150 #6267 #6251 #6306 #6315 #5659 #6320 #6338 #6361 #6358 #5627 #6372 #6470 @kit-ty-kate @rjbou @RyanGibb @gridbugs @fccm2 @shym @hannesm @tobil4sk @juergenhoetzel @MisterDA]

API updates

opam-client

• OpamAction.prepare_package_build: now returns exn option instead of exn option OpamProcess.job and no longer calls the system GNU Patch [#5892 @kit-ty-kate]
• OpamArg.InvalidCLI: export exception [#6150 @rjbou]
• OpamArg.hash_kinds: was added [#5960 @kit-ty-kate]
• OpamArg: export require_checksums and no_checksums, that are shared with build_options [#5563 @rjbou]
• OpamAuxCommands.{simulate_autopin,autopin ~simulate:true}: now updates the reinstall field of the returned switch_state if necessary [#6209 @kit-ty-kate]
• OpamLockCommand.lock_opam: add ~keep_local argument to add local pins to pin-depends (and not resolve them) [#6411 @rjbou]
• OpamLockCommand.lock_opam: make the ?only_direct argument non-optional [#6411 @kit-ty-kate]
• OpamRepositoryCommand.switch_repos: expose the function [#5014 @kit-ty-kate]
• OpamSolution.install_depexts: instead of the package set of new package to install, now takes 2 labelled arguments pkg_to_install and pkg_installed to be able to keep synchronised stateless depext systems [#5982 @rjbou @RyanGibb @kit-ty-kate]
• OpamSolution.install_sys_packages: no longer takes set of package to install but OpamSysPkg.to_install [#5982 @rjbou @RyanGibb @kit-ty-kate]
• OpamSolution.print_depext_msg: takes now an OpamSysPkg.status instead of sets [#5982 @kit-ty-kate @RyanGibb]

opam-repository

• OpamDownload.download: more fine grained HTTP request error code detection for curl [#6036 @rjbou]
• OpamDownload.get_output: fix wget option for POST requests [#6036 @rjbou]
• OpamDownload.get_output: use long form for curl POST request option [#6036 @rjbou]
• OpamLocal.pull_url: fix subpath handling when the url is a local archive [#6439 @rjbou]
• OpamRepository.revision: now returns a string instead of a version [#6409 @kit-ty-kate]
• OpamRepositoryBackend.S.revision: now returns a string instead of a version [#6409 @kit-ty-kate]
• OpamRepositoryBackend.get_diff: now raises Stdlib.Failure if an unsupported file type or comparison is detected [#5892 @kit-ty-kate]
• OpamRepositoryBackend.get_diff: now returns exn option instead of exn option OpamProcess.job and no longer calls the system diff utility [#5892 @kit-ty-kate]

opam-state

• OpamStateConfig: Make the ?lock_kind parameters non-optional to avoid breaking the library users after they upgrade their opam root [#5488 @kit-ty-kate]
• OpamSwitchState.load_selections: Make the ?lock_kind parameter non-optional to avoid breaking the library users after they upgrade their opam root [#5488 @kit-ty-kate]
• OpamSysInteract.Cygwin.check_setup: unexpose the function [#6467 @kit-ty-kate]
• OpamSysInteract.package_manager_name: no longer build the command, or run an action to retrieve system package manager name [#5982 @rjbou]
• OpamSysInteract.package_status: SUSE-based distributions now uses rpm instead of zypper and no longer return an available set of system packages [#6464 @kit-ty-kate]
• OpamSysInteract.packages_status: returns now a OpamSysPkg.status instead of sets [#5982 @kit-ty-kate @RyanGib]
• OpamSysInteract.{install_packages_commands,install}: no longer takes set of package to install but OpamSysPkg.to_install` [#5982 @rjbou @RyanGibb @kit-ty-kate]
• OpamSysInteract.{install_packages_commands,install}: takes a new argument, a switch stat option, for stateless systems that need to write on switch [#5982 @RyanGibb @rjbou]
• OpamSysInteract: add stateless_install that return if system package manager is stateless one (per switch) [#5982 @rjbou]

opam-format

• OpamFile.OPAM.{*read*,write*}: Stop modifying the available field when handling the builtin x-* fields [#6438 @kit-ty-kate]
• OpamFile.Repos_config.t: change the type to not allow repositories without an URL [#6249 @kit-ty-kate]
• OpamFormula.all_relop: a list of all operators [#6197 @mbarbin]
• OpamFormula.string_of_relop: export function [#6197 @mbarbin]
• OpamPath: add nix_env inner switch path for nix environment [#5982 @RyanGibb]
• OpamSysPkg; add new type to_install to store system package to install information, newly requested ones and already installed required ones ; and its empty recode to_install_empty and display function string_of_to_install [#5982 @rjbou]

opam-core

• OpamConsole.pause: Ensure the function always prints a newline character at the end [#6376 @kit-ty-kate]
• OpamConsole: Replace black text style (unused and not very readable) by gray [#6358 @kit-ty-kate]
• OpamFilename.patch: a named-parameter ~allow_unclean was added [#5892 @kit-ty-kate]
• OpamFilename.patch: now returns exn option instead of exn option OpamProcess.job and no longer calls the system GNU Patch [#5892 @kit-ty-kate]
• OpamHash.all_kinds: was added, which returns the list of all possible values of OpamHash.kind [#5960 @kit-ty-kate]
• OpamParallel.*.{map,reduce,iter}: Run Gc.compact when the main process is waiting for the children processes for the first time [#5396 @kkeundotnet]
• OpamStd.List.split: Improve performance [#6210 @kit-ty-kate]
• OpamStd.Option.equal_some: was added, which tests equality of an option with a value [#6381 @kit-ty-kate]
• OpamStd.Sys.get_freebsd_version: was added, which returns the output of the uname -U command [#6217 @kit-ty-kate]
• OpamStd.Sys.get_long_bit: was added, which returns the output of the getconf LONG_BIT command [#6217 @kit-ty-kate]
• OpamStd.Sys.getconf: was removed, replaced by get_long_bit [#6217 @kit-ty-kate]
• OpamStd.Sys.uname: now returns the memoized result of the uname function from the C standard library [#6217 @kit-ty-kate]
• OpamSystem.get_files: was exposed which returns the list of files (without prefix) inside the given directory [#5892 @kit-ty-kate]
• OpamSystem.patch: a named-parameter ~allow_unclean was added [#5892 @kit-ty-kate]
• OpamSystem.patch: do not remove the original patch file if called with ~preprocess:false [#5892 @kit-ty-kate]
• OpamSystem.patch: now returns exn option instead of exn option OpamProcess.job and no longer calls the system GNU Patch [#5892 @kit-ty-kate]
• OpamSystem.remove_dir: do not fail with an exception when directory is a symbolic link [#6276 @btjorge @rjbou - fix #6275]
• OpamSystem, OpamFilename: add with_tmp_file and with_tmp_file_job function, that create a file name in temporary directory and removes it at the end of the call [#6036 @rjbou]

Fixed

• fix: pass pkg-config (extra) args in all pkgconfig invocations. A missing --personality flag would result in pkgconf not finding libraries in some contexts. (#11619, @MisterDA)

Fixed

• Support HaikuOS: don't call execve since it's not allowed if other pthreads have been created. The fact that Haiku can't call execve from other threads than the principal thread of a process (a team in haiku jargon), is a discrepancy to POSIX and hence there is a bug about it. (@Sylvain78, #10953)

• Fix flag ordering in generated Merlin configurations (#11503, @voodoos, fixes ocaml/merlin#1900, reported by @vouillon)

Added

• Add (format-dune-file <src> <dst>) action. It provides a replacement to dune format-dune-file command. (#11166, @nojb)

• Allow the --prefix flag when configuring dune with ocaml configure.ml. This allows to set the prefix just like $ dune install --prefix. (#11172, @rgrinberg)

• Allow arguments starting with + in preprocessing definitions (starting with (lang dune 3.18)). (@amonteiro, #11234)

• Support for opam (maintenance_intent ...) in dune-project (#11274, @art-w)

• Validate opam maintenance_intent (#11308, @art-w)

• Support not in package dependencies constraints (#11404, @art-w, reported by @hannesm)

Changed

• Warn when failing to discover root due to reads failing. The previous behavior was to abort. (@KoviRobi, #11173)

• Use shorter path for inline-tests artifacts. (@hhugo, #11307)

• Allow dash in dune init project name (#11402, @art-w, reported by @saroupille)

• On Windows, under heavy load, file delete operations can sometimes fail due to AV programs, etc. Guard against it by retrying the operation up to 30x with a 1s waiting gap (#11437, fixes #11425, @MSoegtropIMC)

• Cache: we now only store the executable permission bit for files (#11541, fixes #11533, @ElectreAAS)

• Display negative error codes on Windows in hex which is the more customary way to display NTSTATUS codes (#11504, @MisterDA)

Added

• Add png, pdf and jpeg image support to the latex backend by Octachron · Pull Request #1297 · ocaml/odoc · GitHub
• Add header field to the json output by panglesd · Pull Request #1314 · ocaml/odoc · GitHub
• Extract code blocks by name by panglesd · Pull Request #1326 · ocaml/odoc · GitHub

Changed

• Fix suppress_warnings parameter by jonludlam · Pull Request #1304 · ocaml/odoc · GitHub
• Fix suppress_warnings parameter by jonludlam · Pull Request #1304 · ocaml/odoc · GitHub
• Disable warnings coming from linking implementations by jonludlam · Pull Request #1319 · ocaml/odoc · GitHub
• Driver compile warnings by jonludlam · Pull Request #1323 · ocaml/odoc · GitHub
• Fix "box model" for code blocks by panglesd · Pull Request #1317 · ocaml/odoc · GitHub
• Store raw content of code blocks in parser's AST by panglesd · Pull Request #1325 · ocaml/odoc · GitHub

Fixed

• Fix suppress_warnings parameter by jonludlam · Pull Request #1304 · ocaml/odoc · GitHub
• Don't backtrace on invalid input in compile-deps by jonludlam · Pull Request #1313 · ocaml/odoc · GitHub
• Fix indentation bug with verbatim in tags by jonludlam · Pull Request #1312 · ocaml/odoc · GitHub
• Driver: Check for missing/unknown opam packages by jonludlam · Pull Request #1311 · ocaml/odoc · GitHub
• Fix suppress_warnings parameter by jonludlam · Pull Request #1304 · ocaml/odoc · GitHub
• Further fixes for virtual libraries by jonludlam · Pull Request #1309 · ocaml/odoc · GitHub
• Fix issue #610 - odoc html-fragment not producing headings correctly by jonludlam · Pull Request #1306 · ocaml/odoc · GitHub
• Fix classify when there are archives sharing modules by jonludlam · Pull Request #1310 · ocaml/odoc · GitHub

• Change Location.none to match the compiler's Location.none as of OCaml 4.08. This fixes a bug in loc_of_attribute (#540, @ncik-roberts, @patricoferris)

• Bump ppxlib's AST to 5.2.0 (#514, @patricoferris)

• Add the [@@@expand_inline] transformation and support for floating attribute context free transformations. (#560, @jaymody)

• Add a -raise-embedded-errors flag to the driver. Setting this flag raises the first ocaml.error embedded in the final AST.

• Export Ast_pattern.fail. (#563, @ceastlund)

• Make Ast_traverse.sexp_of more concise, and add a test. (#561, @ceastlund)

• Allow use of effect syntax in preprocessed files without causing migration failures. (#552, @hhugo, @NathanReb)

• Remove support for compilers older than 4.08 (#556, @NathanReb)

• Add a --use-compiler-pp flag to the standalone driver. This flag can be set when the driver outputs source code to make it use the compiler's Pprintast instead of ppxlib's. (#555, @NathanReb)

Added

• Add dune-release delegate-info version to show the current version as infered by the tool (#495, @samoht)
• Add --dev-repo to dune-release and dune-release publish to overwrite the dev-repo field specified in the opam file (#494, @samoht)

Changed

• Use the 'user' option as the fork owner, only attempt to decode the remote URL if the user option is not set. (#480, @Julow)

Fixed

• Make dune-release not fail in the presence of ~/.dune/bin/dune (which is present when using dune package management)

Removed

• dune-release no longer publishes docs to github pages. Instead, we rely on the docs published under ocaml.org/packages (#499 #500, @v-gb @samoht)

Highlight

• Hierarchical documentation (@jonludlam, @panglesd, @Julow)
  Pages can now be organized in a directory tree structure.
  Relative and absolute references are added:
  {!./other_page.label}, {!//other_page}.

• Improved sidebar and breadcrumbs navigation (@panglesd, @gpetiot)
  The documentation pages and the libraries of the entire package are shown on
  the left sidebar.

• Added support for images, videos, audio and other assets
  The syntax is {image!/reference/to/asset} or {image:URL} for images.
  The syntax for {video...} and {audio...} is the same.
  (@panglesd, @EmileTrotignon, #1170, #1171, #1184, #1185)

• Search using Sherlodoc (@panglesd, @EmileTrotignon, @Julow)
  A new search bar that supports full-text and type-based search.

Added

• Experimental driver (@jonludlam, @panglesd)
  The driver builds the documentation for a collection of Opam packages using
  the newer Odoc features. It supports linking external packages to ocaml.org
  and markdown files.
  This is experimental and will break in the future.

• Cross-package references (@panglesd, @Julow)
  Pages and modules from other packages can be referenced:
  {!/otherpackage/page}, {!/otherpackage/Module.t}.

• Option to remap links to other packages to ocaml.org or other site.
  See the --remap option of the driver or the --remap-file option of odoc html-generate.
  (@jonludlam, #1189, #1248)

• Option to compute occurrences of use of each identifiers
  The commands aggregate-occurrences and count-occurrences are added.
  (@panglesd, #976, #1076, #1206)

• Added the odoc classify command (@jonludlam, #1121)
  Helps driver detecting which modules belong to which libraries.

• Added --suppress-warnings to the CLI to remove warnings from a unit, even
  if they end up being raised in another unit through expansion
  (@jonludlam, #1260)

• Add clock emoji before @since tag (@yawaramin, #1089)

• Navigation for the search bar : use '/' to enter search, up and down arrows to
  select a result, and enter to follow the selected link. (@EmileTrotignon, #1088)

• Fix a big gap between the preamble and the content of a page (@EmileTrotignon, #1147)

• Add a marshalled search index consumable by sherlodoc (@EmileTrotignon, @panglesd, #1084)

• Allow referencing of polymorphic constructors in polymorphic variant type
  aliases (@panglesd, #1115)

• Added a home icon in the breacrumbs (@panglesd, #1251)
  It can be disabled with a CLI option.

• Add a frontmatter syntax for mld pages (@panglesd, #1187, #1193, #1243, #1246, #1251)
  Allows to specify the title of a page, the order of sub-pages and other
  behaviors in the sidebar.

• Added odoc-md to process standalone Markdown pages (@jonludlam, #1234)

Changed

• The command line interface changed to support the new features.

  • Packages and libraries: odoc link must now be aware of packages and
    libraries with the -L libname:path and -P pkgname:path options. The
    module search path should still be passed with the -I option.
    The current package should be specified with --current-package=pkgname.
  • Hierarchy: odoc compile now outputs .odoc in the directory tree
    specified with --output-dir=DIR and the parent identifier must be
    specified with --parent-id=PARENT.
    The option --source-parent-file is removed.
  • Source code: Implementations are compiled with compile-impl instead of
    with compile. The options --cmt=.. and --source-name=.. are removed.
    Source code pages are generated with html-generate-source.
  • Assets: The commands compile-asset, html-generate-asset are added.
    The option html-generate --asset is removed.
  • Sidebar: The index is built using compile-index. The sidebar data is
    extracted from the index with sidebar-generate and passed to
    html-generate --sidebar=...

• The syntax for @tag is now delimited (@panglesd, #1239)
  A @tag can now be followed by a paragraph or other elements.

• Updated colors for code fragments (@EmileTrotignon, #1023)

• Fixed complexity of looking up .odoc files (@panglesd, #1075)

• Normalize whitespaces in codespans (@gpetiot, #1085)
  A newline followed by any whitespaces is normalized as one space character.

• Reduce size of Odoc_html_frontend when compiled to javascript
  (@EmileTrotignon, #1072)

• Overhaul of module-type-of expansions and shadowing code (@jonludlam, #1081)

• Output file paths and labels in the man and latex backends changed to avoid
  name clashes (@Julow, #1191)

Fixed

• Fix variant constructors being hidden if they contain hidden types
  (@jonludlam, #1105)
• Fix rare assertion failure due to optional parameters
  (@jonludlam, #1272, issue #1001)
• Fix resolution of module synopses in {!modules} lists that require --open
  (@jonludlam, #1104}
• Fix top comment not being taken from includes often enough (@panglesd, #1117)
• Fixed 404 links from search results (@panglesd, #1108)
• Fixed title content not being picked up across pages when rendering references
  (#1116, @panglesd)
• Fix wrong links to standalone comments in search results (#1118, @panglesd)
• Remove duplicated or unwanted comments with inline includes (@Julow, #1133)
• Fix bug where source rendering would cause odoc to fail completely if it
  encounters invalid syntax (@jonludlam #1208)
• Add missing parentheses in 'val (let*) : ...' (@Julow, #1268)
• Fix syntax highlighting not working for very large files
  (@jonludlam, @Julow, #1277)

Fixed

• Fix a crash in the Melange rules that would prevent compiling public library implementations of virtual libraries. (@anmonteiro, #11248)
• Pass melange.emit's compile_flags to the JS emission phase. (@anmonteiro, #11252)
• Disallow private implementations of public virtual libs in melange mode. (@anmonteiro, #11253)
• Wasm_of_ocaml: fix the execution of tests in a sandbox. (#11304, @vouillon)

• ocaml-index
  • Bump magic number after index file format change (#1886)

Features

• Enable experimental project-wide renaming of identifiers (#1431)

• merlin binary
  • Support for OCaml 5.3
  • Use new 5.3 features to improve locate behavior in some cases. Merlin no
    longer confuses uids from interfaces and implementations. (#1857)
  • Perform less merges in the indexer (#1881)
  • Add initial support for project-wide renaming: occurrences can now return
    all usages of all related definitions. (#1877)
• vim plugin
  • Added support for search-by-type (#1846)
    This is exposed through the existing :MerlinSearch command, that
    switches between search-by-type and polarity search depending on the
    first character of the query.

Features

• Add a new server option standardHover, that can be used by clients to
  disable the default hover provider. When standardHover = false
textDocument/hover requests always returns with empty result. (#1416)

• Add initial OCaml 5.3 support (#487, @NathanReb, @hhugo, @nojb)

• Initialise OCaml 5.3's lexer with the keywords setting from OCAMLPARAM or the new -keywords driver's CLI option to allow the standalone ppx driver to process old packages using effect as an identifier (#535, @dra27, @NathanReb)

• Add Pprintast.binding, longident and payload (#542, @mattiasdrp)

• Fix deriving_inline round-trip check so that it works with 5.01 <-> 5.02 migrations (#519, @NathanReb)

• Add ppxlib's AST pretty-printing utilities in Ppxlib.Pp_ast and a ppxlib-pp-ast executable in a new separate ppxlib-tools package (#517, #525, #537, @NathanReb)

• Change -dparsetree from a sexp output to a pretty printed AST, closer to what the compiler's -dparsetree is. (#530, @NathanReb)

• Add Parsetree documentation comments to Ast_builder functions (#518, @patricoferris)

• Support class type declarations in derivers with the new, optional arguments {str,sig}_class_type_decl in Deriving.add (#538, @patricoferris)

Features

• Add custom ocamllsp/typeSearch request (#1369)
• Make MerlinJump code action configurable (#1376)
• Add custom ocamllsp/jump request (#1374)

Fixes

• Deactivate the jump code actions by default. Clients can enable them with the merlinJumpCodeActions configuration option. Alternatively, a custom request is provided for ad hoc use of the feature. (#1411)
• Fix FD leak in running external processes for preprocessing (#1349)
• Fix prefix parsing for completion of object methods (#1363, fixes #1358)
• Remove some duplicates in the selectionRange answers (#1368)

• merlin binary

  • Respect the EXCLUDE_QUERY_DIR configuration directive when looking for cmt files #1854
  • Fix exception in polarity search (#1858 fixes #1113)
  • Fix type-enclosing results instability. This reverts some overly aggressive deduplication that should be done on the client side. #1864

• merlin binary (only in 5.3-502)

  • Fix occurrences bug in which relative paths in index files are resolved against the PWD rather than the SOURCE_ROOT #1855
  • Fix jump to fun targets not working (#1863, fixes #1862)
  • Fix occurrences not working when the definition comes from a hidden source file #1865

Fixed

• When a library declares (no_dynlink), then the .cmxs file for it is no longer built. (#11176, @nojb)

• Fix bug that could result in corrupted file copies by Dune, for example when using the copy_files# stanza or the copy# action. (@nojb, #11194, fixes #11193)

• Remove useless error message when running $ dune subst in empty projects. (@rgrinberg, #11204, fixes #11200)

• Add a new --pre-release argument adding the necessary flags and availibility formula for pre-releases [#164 @kit-ty-kate]

Added

• OCaml 5.3.0 compatibility (@Julow, #1202, #1254)

Highlight

• * Support OCaml 5.2 syntax (#2519, #2544, #2590, #2596, #2621, #2628, @Julow, @EmileTrotignon, @hhugo) This includes local open in types, raw identifiers, and the new representation for functions. This might change the formatting of some functions due to the formatting code being completely rewritten.

• Support OCaml 5.3 syntax (#2609, #2610, #2611, #2622, #2623, #2562, #2624, #2625, #2627, @Julow, @Zeta611) This adds support for effect patterns, short functor type arguments and utf8 identifiers. To format code using the new effect syntax, add this option to your .ocamlformat:

  ocaml-version = 5.3
  

• Documentation comments are now formatted by default (#2390, @Julow) Use the option parse-docstrings = false to restore the previous behavior.

• * Consistent indentation of polymorphic variant arguments (#2427, @Julow) Increases the indentation by one to make the formatting consistent with normal variants. For example:

    ...
    (* before *)
      (`Msg
        (foo bar))
    (* after *)
      (`Msg
         (foo bar))
  

• Build on OCaml 5.3 (#2603, @adamchol, @Julow)

Added

• Improve the emacs plugin (#2577, #2600, @gridbugs, @thibautbenjamin) Allow a custom command to be used to run ocamlformat and add compatibility with emacs ocaml tree-sitter modes.

• Added option let-binding-deindent-fun (#2521, @henrytill) to control the indentation of the fun in:

  let f =
   fun foo ->
    bar
  

• Added back the flag --disable-outside-detected-project (#2439, @gpetiot) It was removed in version 0.22.

• Support newer Odoc syntax (#2631, #2632, #2633, @Julow)

Changed

• * Consistent formatting of comments (#2371, #2550, @Julow) This is mostly an internal change but some comments might be formatted differently.

• * Improve formatting of type constraints with type variables (#2437, @gpetiot) For example:

  let f : type a b c.
      a -> b -> c =
    ...
  

• * Improve formatting of functor arguments (#2505, @Julow) This also reduce the indentation of functor arguments with long signatures.

• Improvements to the Janestreet profile (#2445, #2314, #2460, #2593, #2612, @Julow, @tdelvecchio-jsc)

• * Undo let-bindings and methods normalizations (#2523, #2529, @gpetiot) This remove the rewriting of some forms of let-bindings and methods:

  • let f x = (x : int) is no longer rewritten into let f x : int = x
  • let f (type a) (type b) ... is no longer rewritten into let f (type a b) ...
  • let f = fun x -> ... is no longer rewritten into let f x = ...

• * The break-colon option is now taken into account for method type constraints (#2529, @gpetiot)

• * Force a break around comments following an infix operator (fix non-stabilizing comments) (#2478, @gpetiot) This adds a line break:

    a
    ||
    (* this comment is now on its own line *)
    b
  

Fixed

• Fix placement of comments in some cases (#2471, #2503, #2506, #2540, #2541, #2592, #2617, @gpetiot, @Julow) Some comments were being moved or causing OCamlformat to crash. OCamlformat refuses to format if a comment would be missing in its output, to avoid loosing code.
• Fix attributes being dropped or moved (#2247, #2459, #2551, #2564, #2602, @EmileTrotignon, @tdelvecchio-jsc, @Julow) OCamlformat refuses to format if the formatted code has a different meaning than the original code, for example, if an attribute is removed. We also try to avoid moving attributes even if that doesn't change the original code, for example we no longer format open[@attr] M as open M [@@attr].
• Remove trailing space inside a wrapping empty signature (#2443, @Julow)
• Fix extension-point spacing in structures (#2450, @Julow)
• * Consistent break after string constant argument (#2453, @Julow)
• * Fix cinaps comment formatting to not change multiline string contents (#2463, @tdelvecchio-jsc)
• * Fix the indentation of tuples in attributes and extensions (#2488, @Julow)
• * Fix weird indentation and line breaks after comments (#2507, #2589, #2606, @Julow)
• * Fix unwanted alignment in if-then-else (#2511, @Julow)
• Fix missing parentheses around constraint expressions with attributes (#2513, @alanechang)
• Fix formatting of type vars in GADT constructors (#2518, @Julow)
• Fix [@ocamlformat "disable"] in some cases (#2242, #2525, @EmileTrotignon) This caused a bug inside class type constructs and when attached to a let ... in
• Display a##b instead of a ## b and similarly for operators that start with # (#2580, @v-gb)
• * Fix arrow type indentation with break-separators=before (#2598, @Julow)
• Fix missing parentheses around a let in class expressions (#2599, @Julow)
• Fix formatting of paragraphs in lists in documentation (#2607, @Julow)
• Avoid unwanted space in references and links text in documentation (#2608, @Julow)
• * Improve the indentation of attributes in patterns (#2613, @Julow)
• * Avoid large indentation in patterns after let%ext (#2615, @Julow)

Fixed

• Show the context name for errors happening in non-default contexts. (#10414, fixes #10378, @jchavarri)

• Correctly declare dependencies of indexes so that they are rebuilt when needed. (#10623, @voodoos)

• Don't depend on coq-stdlib being installed when expanding variables of the coq.version family (#10631, fixes #10629, @gares)

• Error out if no files are found when using copy_files. (#10649, @jchavarri)

• Re_export dune-section private library in the dune-site library stanza, in order to avoid failure when generating and building sites modules with implicit_transitive_deps = false. (#10650, fixes #9661, @MA0100)

• Expect test fixes: support multiple modes and fix dependencies when there is a custom runner (#10671, @vouillon)

• In a (library) stanza with (extra_objects) and (foreign_stubs), avoid double linking the extra object files in the final executable. (#10783, fixes #10785, @nojb)

• Map (re_export) library dependencies to the exports field in META files, and vice-versa. This field was proposed in to https://discuss.ocaml.org/t/proposal-a-new-exports-field-in-findlib-meta-files/13947. The field is included in Dune-generated META files only when the Dune lang version is >= 3.17. (#10831, fixes #10830, @nojb)

• Fix staged pps preprocessors on Windows (which were not working at all previously) (#10869, fixes #10867, @nojb)

• Fix dune describe when an executable is disabled with enabled_if. (#10881, fixes #10779, @moyodiallo)

• Fix an issue where C stubs would be rebuilt whenever the stderr of Dune was redirected. (#10883, fixes #10882, @nojb)

• Fix the URL opened by the command dune ocaml doc. (#10897, @gridbugs)

• Fix the file referred to in the error/warning message displayed due to the dune configuration version not supporting a particular configuration stanza in use. (#10923, @H-ANSEN)

• Fix enabled_if when it uses env variable. (#10936, fixes #10905, @moyodiallo)

• Fix exec -w for relative paths with --root argument (#10982, @gridbugs)

• Do not ignore the (locks ..) field in the test and tests stanza (#11081, @rgrinberg)

• Tolerate files without extension when generating merlin rules. (#11128, @anmonteiro)

Added

• Make Merlin/OCaml-LSP aware of "hidden" dependencies used by (implicit_transitive_deps false) via the -H compiler flag. (#10535, @voodoos)

• Add support for the -H flag (introduced in OCaml compiler 5.2) in dune (requires lang versions 3.17). This adaptation gives the correct semantics for (implicit_transitive_deps false). (#10644, fixes #9333, ocsigen/tyxml#274, #2733, #4963, @MA0100)

• Add support for specifying Gitlab organization repositories in source stanzas (#10766, fixes #6723, @H-ANSEN)

• New option to control jsoo sourcemap generation in env and executable stanza (#10777, fixes #10673, @hhugo)

• One can now control jsoo compilation_mode inside an executable stanza (#10777, fixes #10673, @hhugo)

• Add support for specifying default values of the authors, maintainers, and license stanzas of the dune-project file via the dune config file. Default values are set using the (project_defaults) stanza (#10835, @H-ANSEN)

• Add names to source tree events in performance traces (#10884, @jchavarri)

• Add codeberg as an option for defining project sources in dune-project files. For example, (source (codeberg user/repo)). (#10904, @nlordell)

• dune runtest can now run individual tests with dune runtest mytest.t (#11041, @Alizter).

• Wasm_of_ocaml support (#11093, @vouillon)

• Add a coqdep_flags field to the coq field of the env stanza, and to the coq.theory stanza, allowing to configure coqdep flags. (#11094, @rlepigre)

Changed

• Remove all remnants of the experimental patch-back-source-tree. (#10771, @rgrinberg)

• Change the preset value for author and maintainer fields in the dune-project file to encourage including emails. (#10848, @punchagan)

• Tweak the preset value for tags in the dune-project file to hint at topics not having a special meaning. (#10849, @punchagan)

• Change some colors to improve readability in light-mode terminals (#10890, @gridbugs)

• Forward the linkall flag to jsoo in whole program compilation as well (#10935, @hhugo)

• Configurator uses pkgconf as pkg-config implementation when available and forwards it the target of ocamlc -config. (#10937, @pirbo)

• Enable Dune cache by default. Add a new Dune cache setting enabled-except-user-rules, which enables the Dune cache, but excludes user-written rules from it. This is a conservative choice that can avoid breaking rules whose dependencies are not correctly specified. This is the current default. (#10944, #10710, @nojb, @ElectreAAS)

• Do not add dune dependency in dune-project when creating projects with dune init proj. The Dune dependency is implicitely added when generating opam files (#11129, @Leonidas-from-XIV)

Fixed

• Call the C++ compiler with -std=gnu++11 when using OCaml >= 5.0 (#10962, @kit-ty-kate)

  Added