Deploying to wikidoc from @ 969bb0c 🚀

Author: hhugo

doc/dev/manual/effects.wiki

@@ -11,14 +11,13 @@ The analysis is especially effective on monomorphic code. It is not so effective
 We hope to improve on this by trying alternative compilation
 strategies.
 
-An alternative CPS transform is provided under the {{--effects=double-translation}} option. It keeps a direct-style version of the transformed functions in addition to the CPS version. The choice of running the CPS version is delayed to run time. Since CPS code is usually slower, this can avoid degradations. In addition, one can ensure that some code is run in direct style by using {{Jsoo_runtime.Effect.assume_no_perform}}. A caveat is that Dune does not know about {{--effects=double-translation}} yet and may try to link together files built with {{--enable=double-translation}} and files built with only {{--enable=effects}}, which gives an error. A work-around is to disable separate compilation by using the option {{(js_of_ocaml (compilation_mode whole_program))}}.
+An alternative CPS transform is provided under the {{{--effects=double-translation}}} option. It keeps a direct-style version of the transformed functions in addition to the CPS version. The choice of running the CPS version is delayed to run time. Since CPS code is usually slower, this can avoid degradations. In addition, one can ensure that some code is run in direct style by using {{{Jsoo_runtime.Effect.assume_no_perform}}}.
 
 === Dune integration ===
 
-We're still working on dune support for compiling js_of_ocaml programs
-with effect handlers enabled.
+Dune is aware of the {{{--enable effects}}} option. So, you can just add it to the Js_of_ocaml flags {{{(js_of_ocaml (flags ...))}}} wherever you want to use it.
 
-For now, here are two possible setups.
+We're still working on dune support for the {{{--effects}}} option. For now, here are two possible setups.
 
 === Whole dune workspace setup ===
 
@@ -27,8 +26,8 @@ Put the following in a {{{dune}}} (or {{{dune-workspace}}}) file at the root of
 (env
  (_
   (js_of_ocaml
-   (flags (:standard --enable effects))
-   (build_runtime_flags (:standard --enable effects)))))
+   (flags (:standard --effects=double-translation))
+   (build_runtime_flags (:standard --effects=double-translation)))))
 }}}
 
 With this setup, one can use both separate and whole program compilation.
@@ -37,28 +36,19 @@ With this setup, one can use both separate and whole program compilation.
 === Sub directory setup ===
 
 If you want to enable effect handlers for some binaries only, you'll
-have to give-up separate compilation for now using the following in
-your {{{dune}}} file.
-
-{{{
-(env
- (_
-  (js_of_ocaml
-   (compilation_mode whole_program))))
-}}}
-
-Then pass the rights {{{js_of_ocaml}}} flags to the executable stanza
-
+have to give-up separate compilation for now using:
 {{{
 (executable
   (name main)
-  (js_of_ocaml (flags (:standard --enable effects)))
+  (js_of_ocaml
+   (compilation_mode whole_program)
+   (flags (:standard --effects=double-translation)))
 )
 }}}
 
 Trying to use separate compilation would result in a error while attempting to link the final js file.
 {{{
 js_of_ocaml: Error: Incompatible build info detected while linking.
- - test6.bc.runtime.js: effects=false
- - .cmphash.eobjs/byte/dune__exe.cmo.js: effects=true
+ - test6.bc.runtime.js: effects=disabled
+ - .cmphash.eobjs/byte/dune__exe.cmo.js: effects=double-translation
 }}}