Skip to content

Add Q&A entry for preview #179

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Leonidas-from-XIV wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add Q&A entry for preview #179

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
90c0645
Add Q&A entry for preview
Leonidas-from-XIV Nov 26, 2025
833f332
Explain what happened to each of the features
Leonidas-from-XIV Nov 26, 2025
ee31605
Apply suggestions from code review
Leonidas-from-XIV Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions lib/main.mlx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,18 @@ let q_and_a = [
[JSX.string "$ opam pin add dune --dev-repo"]
</Code>
</div>
; "How does the nightly differ from the preview?",
<div class_="flex flex-col gap-2">
<p>"Like the nightly, the preview was a binary build created every day from the most current Dune sources. However, it also enabled certain optional features by default."</p>
<p>
<ul>
<li><var>"DUNE_CONFIG__PORTABLE_LOCK_DIRS"</var>" has been incorporated into mainline Dune, it is always enabled."</li>
<li><var>"DUNE_CONFIG__PKG_BUILD_PROGRESS"</var>" has been incorporated into mainline Dune, it is enabled when running Dune with "<code>"--display=short"</code>"."</li>
<li><var>"DUNE_CONFIG__LOCK_DEV_TOOL"</var>" is not enabled anymore but can still be set in the environment. To use dev-tools use "<code>"dune tools"</code>" while we work for better support for dev-tools."</li>
Copy link
Member

@shonfeder shonfeder Nov 26, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's clear from the name of the config or this description what this feature did. It makes it sound like dev tools are not really supported at all without this feature. But that's not true. So I think, if this is to be included, we have to be more precise:

Suggested change
<li><var>"DUNE_CONFIG__LOCK_DEV_TOOL"</var>" is not enabled anymore but can still be set in the environment. To use dev-tools use "<code>"dune tools"</code>" while we work for better support for dev-tools."</li>
<li><var>"DUNE_CONFIG__LOCK_DEV_TOOL"</var>" is not enabled anymore but can still be set in the environment. This features makes dev tools automatically installed when they are invoked. E.g., running "<code>dune fmt</code>` will automatically install `ocamlformat`. Without this feature, one simply has to run `dune tools install ocamlformat` first. To use and install dev tools run "<code>"dune tools"</code>" "</li>

</ul>
</p>
<p>"The re-branded nightly builds now just follow Dune's "<pre>"main"</pre>" branch with no additional features enabled."</p>
</div>
]

let faq () =
Expand Down