Skip to content

Commit ddefc99

Browse files
add warning that dune-site forces linkall (#13109)
addresses #12749 I don't know what to do about the index.mld, I haven't used `dune-site` and I only have a superficial understanding of it from reading the manual… so I can't really write a full index.mld file just having a link feels a bit wrong (what when the url for the doc changes??) should the mld file just be the same content as the rst but translated?? Signed-off-by: Raphaël Proust <code@bnwr.net>
1 parent 9aa1fa8 commit ddefc99

File tree

3 files changed

+11
-0
lines changed

3 files changed

+11
-0
lines changed

doc/sites.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,11 @@ site using the :doc:`generate_sites_module stanza
9898
The generated module ``mysites`` depends on the library ``dune-site`` provided
9999
by Dune. As such, the dependency on ``dune-site`` must be specified explicitly.
100100

101+
.. warning::
102+
103+
An executable that depends (even transitively) on `dune-site` will be compiled with
104+
`linkall`, regardless of other options.
105+
101106
.. note::
102107

103108
The dependency on ``dune-site`` also needs to be added to the ``depends``

otherlibs/dune-site/src/dune

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@
99
(libraries
1010
(re_export dune-private-libs.dune-section)
1111
dune-site.private))
12+
13+
(documentation
14+
(package dune-site))

otherlibs/dune-site/src/index.mld

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{1 [dune-site] - loading additional files at runtime. }
2+
3+
{:https://dune.readthedocs.io/en/stable/sites.html#how-to-load-additional-files-at-runtime}

0 commit comments

Comments
 (0)