DUNE-SHUTDOWN(1)

📦
version 3.24.1 · 12 versions
, in ubuntu stonking

💅 dune-shutdown, from the Dune Manual

okay so hi bestie 💖 welcome to dune-shutdown(1) — yeah, it's in the Dune Manual, one of the dune girlies, and it is exactly what it sounds like: it cancels everything and shuts the whole thing down. no notes, no mercy, slay.

✨ NAME ✨

dune-shutdown — Cancel and shutdown any builds in the current workspace.

like, all of them. right now. the workspace is closing bestie, go home 🫶

🦋 SYNOPSIS 🦋

dune shutdown [OPTION]…

that's it. that's the whole vibe. you just say dune shutdown and add whatever options your little heart desires. ✨

🎀 OPTIONS 🎀

okay this is the long part but stay with me, it's all good info i promise 🌸

  • --action-stderr-on-success=VAL — Same as --action-stdout-on-success but for standard error instead of standard output. A good default for large mono-repositories is --action-stdout-on-success=swallow --action-stderr-on-success=must-be-empty. This ensures that a successful build has a "clean" empty output. clean output is such a mood honestly 🧼✨
  • --action-stdout-on-success=VAL — Specify how to deal with the standard output of actions when they succeed. Possible values are: print to just print it to Dune's output, swallow to completely ignore it and must-be-empty to enforce that the action printed nothing. With must-be-empty, Dune will consider that the action failed if it printed something to its standard output. The default is print.
  • --build-info — Show build information. like a little get-to-know-me for your build 👑
  • --display-separate-messages — Separate error messages with a blank line. breathing room for your errors ✨
  • --error-reporting=VAL (absent=deterministic) — Controls when the build errors are 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 the error is discovered and then again at the end of the build, in a deterministic order. (not me making you read the same error twice, but ok, it's literally an option 💀)
  • -f, --force — Force actions associated to aliases to be re-executed even if their dependencies haven't changed. no thoughts, just re-run 🔥
  • --file-watcher=VAL (absent=automatic) — Mechanism to detect changes in the source. Automatic to make dune run an external program to detect changes. Manual to notify dune that files have changed manually. bestie you can literally just tell dune. iconic 🫶
  • --passive-watch-mode — Similar to [--watch], but only start a build when instructed externally by an RPC. it just waits. patiently. for you. 💜
  • --sandbox=VAL (absent DUNE_SANDBOX env) — Set sandboxing mode. Some actions require a certain sandboxing mode, so they will ignore this setting. The allowed values are: none, symlink, copy, hardlink.
  • --stop-on-first-error — Stop the build as soon as an error is encountered. one strike and we're out ✋
  • -w, --watch — Instead of terminating build after completion, wait continuously for file changes. it's giving main character who never leaves the party 🌈
  • --wait-for-filesystem-clock — Dune digest file contents for better incrementally. These digests are themselves cached. In some cases, Dune needs to drop some digest cache entries in order for things to be reliable. This option makes Dune wait for the file system clock to advance so that it doesn't need to drop anything. You should probably not care about this option; it is mostly useful for Dune developers to make Dune tests of the digest cache more reproducible. fr fr, it's for the dune devs, not you, no cap 💅

🫶 COMMON OPTIONS 🫶

these are the ones that show up all over dune, so like, they're basically family at this point 🎀

  • --always-show-command-line — Always show the full command lines of programs executed by dune.
  • --auto-promote — Automatically promote files. This is similar to running dune promote after the build. auto-glow-up ✨
  • --build-dir=FILE (absent DUNE_BUILD_DIR env) — Specified build directory. _build if unspecified. (gender-neutral, iconic, classic _build 💖)
  • --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 checks by default because girl we are BUSY 😭
  • --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. they said the quiet part OUT LOUD 👑
  • --debug-dependency-path — In case of error, print the dependency path from the targets on the command line to the rule that failed. it's giving receipts 🧾✨
  • --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. nobody's getting promoted today, not on my watch 💅
  • --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. pick your aesthetic bestie 🎀
  • --dump-gc-stats=FILE — Dump the garbage collector stats to a file after the build is complete. garbage stats? in THIS economy? 💚
  • --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. (the TERM var being dumb is genuinely sending me 🙈)
  • --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). parallelism, the actual love language 🔥
  • --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. yes it's a whole combo, order it like a meal 🍓
  • --no-config — Do not load the configuration file.
  • --no-print-directory — Suppress "Entering directory" messages. (bestie we KNOW where we are 🙈)
  • --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. this one is REQUIRED, not optional, do not skip it 💀
  • --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. dev girlies stay winning 🌱
  • --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. the everything-bagel of release flags 👑
  • --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. scripts only, bestie, don't get creative 💜
  • --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. aesthetic choices for your scrollback ✨
  • --trace-file=FILE — Output trace data in catapult format (compatible with chrome://tracing). yes typing chrome://tracing into chrome is a real thing, slay 🌈
  • --verbose — Same as --display verbose.
  • --version — Show version information. what's your version bestie 💚
  • --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. that's the whole list, character for character, no edits, periodt 💅
  • --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. going to another platform? we ride 🦋

💀 EXIT STATUS 💀

dune shutdown exits with:

  • 0 — on success. we ate 🎀
  • 1 — if an error happened. ngl it happens 😭
  • 130 — if it was interrupted by a signal. someone hit Ctrl+C and ended the whole thing 💫

okay bestie that's not even the whole story — there's MORE coming, don't go anywhere 🫶💖

🌸 ENVIRONMENT 🌸

okay bestie, so shutdown is lowkey nosy about your environment — these variables all change how it behaves, so let's go through them one by one 💅

  • DUNE_BUILD_DIR — the build directory you're pointing at. If you don't say anything, it just assumes _build like the confident main character it is ✨
  • DUNE_CACHE — turns the Dune cache on or off. Your choices are disabled, enabled-except-user-rules, or enabled. Default? enabled-except-user-rules, no cap 🎀
  • DUNE_CACHE_CHECK_PROBABILITY — makes Dune check whether builds are reproducible by re-executing randomly chosen rules and comparing what they produce to what's stored in the Dune cache. Heads up though: the more you crank up the probability, the slower your build gets 😭. Default probability is zero, meaning literally no rules get checked.
  • DUNE_CACHE_STORAGE_MODE — how the Dune cache stores stuff. Pick one of auto, hardlink or copy. Default is hardlink 🫶
  • DUNE_CROSS_TARGET — cross-compile using this toolchain. that's it, that's the vibe 🌈
  • DUNE_DEBUG_PACKAGE_LOGS — always prints the standard logs when building packages. for when you need to see everything 👑
  • DUNE_DIFF_COMMAND — the shell command used to diff files. Set it to - if you want the diff printing to just... stop 🚫 (valid, honestly)
  • DUNE_DISABLE_PROMOTION — disables all promotion rules. every single one. gone 💀
  • DUNE_INSTRUMENT_WITH — enables instrumentation by BACKENDS. BACKENDS here is a comma-separated list of library names, and every one of those libraries has to declare an instrumentation backend. no freeloaders 🧚
  • DUNE_JOBS — caps how many commands run at the same time at JOBS. JOBS has to be a positive integer, or auto to auto-detect your core count — and auto is the default 💖
  • DUNE_PROFILE — the build profile. dev if you don't specify anything, or release if -p is set. two moods, pick one ⭐
  • DUNE_ROOT — use this directory as the workspace root instead of letting Dune guess. Important though: this does not change how targets given on the command line get interpreted. It's only meant for scripts, iykyk 🙈
  • DUNE_SANDBOX — the sandboxing mode to use by default. (peep --sandbox for the deets 🏖️)
  • DUNE_STORE_ORIG_SOURCE_DIR — stores the original source location in the dune-package metadata. archival queen 📦
  • 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 making Dune go look for one. decisive. obsessed 💜

👀 SEE ALSO 👀

  • dune(1) — go read that one too bestie, it's the whole ecosystem 🦋

aaaand that's the whole page, fr fr 🎀 this was Dune 3.24.1, the DUNE-SHUTDOWN(1) manual page — thanks for reading all the way to the bottom, you're literally the best, slay 💅✨💖

📦 where this page comes from