DUNE-UPGRADE(1)

📦
version 3.24.1 · 15 versions
, in ubuntu stonking

✨ DUNE-UPGRADE(1) ✨

okay bestie so this is dune-upgrade from the Dune Manual, section 1 of the manual pages. it's giving "glow up your whole project" energy and honestly? iconic. 🦋

💖 NAME 💖

dune-upgrade — upgrade projects across major Dune versions. like a little glow-up for your repo, no cap.

🌸 SYNOPSIS 🌸

dune upgrade [OPTION]…

✨ DESCRIPTION ✨

so what this does: dune upgrade upgrades all the projects in the workspace to the latest major version of Dune. every single one. it's a whole-workspace makeover, periodt. 💅

🎀 OPTIONS 🎀

  • --action-stderr-on-success=VAL — same vibe as --action-stdout-on-success but for standard error instead of standard output. lowkey a great default for big mono-repositories is --action-stdout-on-success=swallow plus --action-stderr-on-success=must-be-empty. that combo means a successful build has a "clean", empty output. chef's kiss. 🧚
  • --action-stdout-on-success=VAL — decides how we handle the standard output of actions when they succeed. the possible values are:
    • print — just print it right into Dune's output
    • swallow — completely ignore it, like it never happened 💀
    • must-be-empty — enforce that the action printed nothing. with this one, Dune will consider the action failed if it printed anything to its standard output.

the default is print.

  • --build-info — show build information. receipts, basically. 🧾
  • --display-separate-messages — separate error messages with a blank line. breathing room for your problems ✨
  • --error-reporting=VAL (absent=deterministic) — controls when build errors get reported:
    • early — reports errors as soon as they are discovered
    • deterministic — reports errors at the end of the build, in a deterministic order
    • twice — reports each error twice: once as soon as it's discovered, and then again at the end of the build, in a deterministic order. double the drama, double the fun 😭
  • -f, --force — force actions associated to aliases to be re-executed even if their dependencies haven't changed. rude? maybe. effective? yes. 🔥
  • --file-watcher=VAL (absent=automatic) — the mechanism for detecting changes in the source:
    • automatic — makes dune run an external program to detect changes
    • manual — you notify dune that files have changed, manually, yourself
  • --passive-watch-mode — similar to --watch, but it only starts a build when instructed externally by an RPC. it's the chill, wait-to-be-asked version. 🙈
  • --sandbox=VAL (absent DUNE_SANDBOX env) — set the sandboxing mode. some actions require a certain sandboxing mode, so they'll just ignore this setting (they're like that). the allowed values are: none, symlink, copy, hardlink.
  • --stop-on-first-error — stop the build the moment an error is encountered. no mercy. 💅
  • -w, --watch — instead of terminating the build after completion, wait continuously for file changes. it stays. it's committed. 🫶
  • --wait-for-filesystem-clock — okay so, Dune digests file contents for better incrementality, and those digests are themselves cached. in some cases Dune needs to drop some digest cache entries so things stay reliable. this option makes Dune wait for the file system clock to advance so it doesn't need to drop anything. you should probably not care about this option; it's mostly useful for Dune developers to make Dune tests of the digest cache more reproducible. iykyk. ⭐

🌈 COMMON OPTIONS 🌈

these options are common to all commands, so they're the group-chat regulars. no cap.

  • --always-show-command-line — always show the full command lines of programs executed by dune. full transparency, we love to see it 👑
  • --auto-promote — automatically promote files. this is similar to running dune promote after the build.
  • --build-dir=FILE (absent DUNE_BUILD_DIR env) — specified build directory. _build if unspecified.
  • --cache=VAL (absent DUNE_CACHE env) — enable or disable Dune cache. one of disabled, enabled-except-user-rules or enabled. default is enabled-except-user-rules.
  • --cache-check-probability=VAL (absent DUNE_CACHE_CHECK_PROBABILITY env) — check build reproducibility by re-executing randomly chosen rules and comparing their results with those stored in Dune cache. note: by increasing the probability of such checks you slow down the build. the default probability is zero, i.e. no rules are checked. zero thoughts, head empty 😌
  • --cache-storage-mode=VAL (absent DUNE_CACHE_STORAGE_MODE env) — Dune cache storage mode. one of auto, hardlink or copy. default is hardlink.
  • --config-file=FILE — load this configuration file instead of the default one.
  • --debug-backtraces — always print exception backtraces. the full lore, never edited. 📜
  • --debug-dependency-path — in case of error, print the dependency path from the targets on the command line to the rule that failed. it shows you exactly who did this. 🔍
  • --debug-package-logs (absent DUNE_DEBUG_PACKAGE_LOGS env) — always print the standard logs when building packages.
  • --default-target=TARGET (absent=@@default) — set the default target that is used when none is specified to dune build.
  • --diff-command=VAL (absent DUNE_DIFF_COMMAND env) — shell command to use to diff files. use - to disable printing the diff.
  • --disable-promotion (absent DUNE_DISABLE_PROMOTION env) — disable all promotion rules.
  • --display=MODE — control the display mode of Dune. see dune-config(5) for more details. valid values for this option are progress, verbose, short, quiet or tui.
  • --dump-gc-stats=FILE — dump the garbage collector stats to a file after the build is complete. data dump, literally 📊
  • --help[=FMT] (default=auto) — show this help in format FMT. the value FMT must be one of auto, pager, groff or plain. with auto, the format is pager or plain whenever the TERM env var is dumb or undefined.
  • --ignore-promoted-rules — ignore rules with (mode promote), except ones with (only ...). the variable %{ignoring_promoted_rules} in dune files reflects whether this option was passed or not.
  • --instrument-with=BACKENDS (absent DUNE_INSTRUMENT_WITH env) — enable instrumentation by BACKENDS. BACKENDS is a comma-separated list of library names, each one of which must declare an instrumentation backend.
  • -j JOBS (absent DUNE_JOBS env) — run no more than JOBS commands simultaneously. JOBS must be a positive integer or auto to auto-detect the number of cores (the default).
  • --no-buffer — do not buffer the output of commands executed by dune. by default dune buffers the output of subcommands, in order to prevent interleaving when multiple commands are executed in parallel. however, this can be an issue when debugging long running tests. with --no-buffer, commands have direct access to the terminal. note that as a result their output won't be captured in the log file. you should use this option in conjunction with -j 1, to avoid interleaving. additionally you should use --verbose as well, to make sure that commands are printed before they are being executed. bestie this one's highkey a whole procedure, read it twice 😭
  • --no-config — do not load the configuration file.
  • --no-print-directory — suppress "Entering directory" messages. quiet luxury 🎀
  • --only-packages=PACKAGES — ignore stanzas referring to a package that is not in PACKAGES. PACKAGES is a comma-separated list of package names. note that this has the same effect as deleting the relevant stanzas from dune files. it is mostly meant for releases. during development, it is likely that what you want instead is to build a particular <package>.install target.
  • -p PACKAGES, --for-release-of-packages=PACKAGES (required) — shorthand for --release --pkg=disabled --only-packages PACKAGE. you must use this option in your <package>.opam files, in order to build only what's necessary when your project contains multiple packages as well as getting reproducible builds.
  • --pkg=VAL — enable or disable package management. the default behaviour depends on whether a lock directory exists.
  • --profile=VAL (absent DUNE_PROFILE env) — select the build profile, for instance dev or release. the default is dev.
  • --promote-install-files[=VAL] (default=true) — promote any generated <package>.install files to the source tree.
  • --release — put dune into a reproducible release mode. shorthand for --root . --ignore-promoted-rules --no-config --profile release --always-show-command-line --promote-install-files --require-dune-project-file --default-target @install. you should use this option for release builds. for instance, you must use this option in your <package>.opam files. except if you already use -p, as -p implies this option.
  • --require-dune-project-file[=VAL] (default=true) — fail if a dune-project file is missing. no dune-project, no service 💀
  • --root=DIR (absent DUNE_ROOT env) — use this directory as workspace root instead of guessing it. note that this option doesn't change the interpretation of targets given on the command line. it is only intended for scripts.
  • --store-orig-source-dir (absent DUNE_STORE_ORIG_SOURCE_DIR env) — store original source location in dune-package metadata.
  • --target-exec=TOOLCHAIN=CMD (absent DUNE_TARGET_EXEC env) — wrapper command for running target binaries when cross-compiling. format: TOOLCHAIN=CMD (e.g., 'windows=wine').
  • --terminal-persistence=MODE — change how the log of build results are displayed to the console between rebuilds while in --watch mode. supported modes: preserve, clear-on-rebuild, clear-on-rebuild-and-flush-history.
  • --trace-file=FILE — output trace data in catapult format (compatible with chrome://tracing).
  • --verbose — same as --display verbose.
  • --version — show version information.
  • --watch-exclusions=REGEX — adds a POSIX regular expression that will exclude matching directories from dune build --watch. the option --watch-exclusions can be repeated to add multiple exclusions. semicolons can be also used as a separator. if no exclusions are provided, then a standard set of exclusions is used; however, if one or more --watch-exclusions are used, none of the standard exclusions are used. the standard exclusions are: ^_opam /_opam ^_esy /_esy ^\.#.* /\.#.* ~$ ^#[^#]*#$ /#[^#]*#$ ^4913$ /4913$ /.git /.hg :/windows
  • --workspace=FILE (absent DUNE_WORKSPACE env) — use this specific workspace file instead of looking it up.
  • -x VAL (absent DUNE_CROSS_TARGET env) — cross-compile using this toolchain.

🫶 MORE HELP 🫶

use `dune COMMAND --help' for help on a single command. one command at a time, bestie, we can't do everything at once 💜

⭐ EXIT STATUS ⭐

dune upgrade exits with:

  1. 0 — on success. slay. 🎉
  2. 1 — if an error happened. unfortunate. 😭
  3. 130 — if it was interrupted by a signal.

🌸 ENVIRONMENT 🌸

okay bestie, so upgrade reads a bunch of environment variables and they lowkey run the whole show. here's every single one, no skips 💖

  • DUNE_BUILD_DIR — where the build directory lives. if you just leave it vibing, it's _build.
  • DUNE_CACHE — turns the Dune cache on or off. you gotta pick one of disabled, enabled-except-user-rules or enabled. the default is enabled-except-user-rules.
  • DUNE_CACHE_CHECK_PROBABILITY — this one re-runs rules that were picked at random and compares the results against what's sitting in the Dune cache, so you can check whether your builds are actually reproducible. ⚠️ heads up: cranking up the probability slows your build down, no cap. default probability is zero, meaning no rules get checked at all.
  • DUNE_CACHE_STORAGE_MODE — the storage mode for the Dune cache, one of auto, hardlink or copy. default is hardlink.
  • DUNE_CROSS_TARGET — cross-compile using this toolchain.
  • DUNE_DEBUG_PACKAGE_LOGS — always print the standard logs when building packages.
  • DUNE_DIFF_COMMAND — the shell command used to diff files. pass - to disable printing the diff entirely.
  • DUNE_DISABLE_PROMOTION — kills all promotion rules. all of them. 💀
  • DUNE_INSTRUMENT_WITH — enables instrumentation by BACKENDS. BACKENDS is a comma-separated list of library names, and every single one of them has to declare an instrumentation backend.
  • DUNE_JOBS — never run more than JOBS commands at the same time. JOBS has to be a positive integer, or auto to auto-detect the number of cores (which is the default, slay).
  • DUNE_PROFILE — the build profile. dev if it's unspecified, or release if -p is set.
  • DUNE_ROOT — use this directory as the workspace root instead of letting Dune guess it. 📌 note: this doesn't change how targets given on the command line get interpreted — it's only meant for scripts.
  • DUNE_SANDBOX — the sandboxing mode used by default. (peep --sandbox for the deets)
  • DUNE_STORE_ORIG_SOURCE_DIR — stores the original source location in dune-package metadata.
  • DUNE_TARGET_EXEC — a wrapper command for running target binaries when you're cross-compiling. format: TOOLCHAIN=CMD (like, for example, 'windows=wine').
  • DUNE_WORKSPACE — use this specific workspace file instead of looking one up.

🐛 BUGS 🐛

found something cursed? go check the bug reports at https://github.com/ocaml/dune/issues 🫶

👀 SEE ALSO 👀

and that's the whole page bestie, you ate that 💅✨ this one's from Dune 3.24.1, and it's the DUNE-UPGRADE(1) manual — go forth and upgrade responsibly, mwah 🎀🦋

📦 where this page comes from