Merge branch 'main' into patch-1

Author: chris-armstrong

doc/faq.rst

@@ -8,7 +8,7 @@ FAQ
 
    Some of these are mini how-to guides, or sections of existing guides.
 
-Why Do Many Dune Projects Contain a ``Makefile``?
+Why do many Dune projects contain a ``Makefile``?
 =================================================
 
 Many Dune projects contain a root ``Makefile``. It's often only there for
@@ -23,31 +23,31 @@ convenience for the following reasons:
 
 3. ``make`` is shorter to type than ``dune build @install``
 
-How to Add a Configure Step to a Dune Project
-=============================================
+How to add a configure step to a Dune project?
+==============================================
 
 The with-configure-step_ example shows one way to add a configure step that
 preserves composability; i.e., it doesn't require manually running the
 ``./configure`` script when working on multiple projects simultaneously.
 
 .. _with-configure-step: https://github.com/ocaml/dune/tree/master/example/with-configure-step.t
 
-Can I Use ``topkg`` with Dune?
+Can I use ``topkg`` with Dune?
 ==============================
 
 While it's possible to use the topkg-jbuilder_, it's not recommended.
 dune-release_ subsumes ``topkg-jbuilder`` and is specifically tailored to Dune
 projects.
 
 
-How Do I Publish My Packages with Dune?
+How do I publish my packages with Dune?
 =======================================
 
 Dune is just a build system and considers publishing outside of its scope.
 However, the dune-release_ project is specifically designed for releasing Dune
 projects to opam. We recommend using this tool for publishing Dune packages.
 
-Where Can I Find Some Examples of Projects Using Dune?
+Where can I find some examples of projects using Dune?
 ======================================================
 
 The dune-universe_ repository contains a snapshot of the latest versions of all
@@ -68,8 +68,8 @@ Jane Street as well.
 .. _dune-release: https://github.com/samoht/dune-release
 .. _jenga: https://github.com/janestreet/jenga
 
-How to Make Warnings Non-Fatal
-==============================
+How to make warnings non-fatal?
+===============================
 
 `jbuilder` formerly displayed warnings, but most of them wouldn't stop the
 build. However, Dune makes all warnings fatal by default. This can be a
@@ -92,8 +92,8 @@ non-fatal:
     (dev
       (flags (:standard -warn-error -A))))
 
-How to Turn Specific Errors into Warnings
-=========================================
+How to turn specific errors into warnings?
+==========================================
 
 Dune is strict about warnings by default in that all warnings are treated as
 fatal errors. To change certain errors into warnings for a project, you can add
@@ -106,8 +106,8 @@ the following to ``dune-workspace``:
 In this example, the warnings 27 (unused-var-strict) and 32
 (unused-value-declaration) are treated as warnings rather than errors.
 
-How to Display the Output of Commands as They Run
-=================================================
+How to display the output of commands as they run?
+==================================================
 
 When Dune runs external commands, it redirects and saves their output, then
 displays it when complete. This ensures that there's no interleaving when
@@ -120,8 +120,8 @@ In that case, one can pass ``-j1 --no-buffer`` so the commands are directly
 printed on the console (and the parallelism is disabled so the output stays
 readable).
 
-How Can I Generate an ``mli`` File From an ``ml`` File
-======================================================
+How can I generate an ``mli`` file from an ``ml`` file?
+=======================================================
 
 When a module starts as just an implementation (``.ml`` file), it can be
 tedious to define the corresponding interface (``.mli`` file).
@@ -143,7 +143,7 @@ file:
 The ``ocaml-print-intf`` program has special support for Dune, so it will
 automatically understand external dependencies.
 
-How Can I Build a Single Library?
+How can I build a single library?
 =================================
 
 You might want to do this when you don't have all the dependencies installed to
@@ -171,8 +171,8 @@ directory - not the project root. If the library defines a ``name`` distinct fro
 its ``public_name`` then that can be used interchangeably with the ``public_name``
 in this command.
 
-Files and Directories Whose Names Begin with "." (Period) are Ignored by ``source_tree``
-========================================================================================
+Why does ``source_tree`` ignore files and directories when they begin with a "." (period)?
+==========================================================================================
 
 Dune's default behaviour is to ignore files and directories starting with "."
 when copying directories with ``source_tree``. This is to avoid accidentally
@@ -224,8 +224,8 @@ In this case you can update it to look like this:
     (dirs :standard .cargo \ target)
     (data_only_dirs vendor)
 
-How Can I Write Inline Tests in a Package Without my Users Needing to Install ``ppx_inline_test``?
-==================================================================================================
+Why can't I write inline tests in a package without users needing to install ``ppx_inline_test``?
+=================================================================================================
 
 If you came to OCaml from Rust and noticed that Dune has a feature for running
 inline tests you might be wondering how to do the OCaml equivalent of:

src/dune_lang/action.ml

@@ -70,7 +70,7 @@ end
 
 module Env_update = struct
   module Op = struct
-    type t =
+    type t = OpamParserTypes.env_update_op =
       | Eq
       | PlusEq
       | EqPlus

src/dune_lang/action.mli

@@ -66,7 +66,7 @@ end
 
 module Env_update : sig
   module Op : sig
-    type t =
+    type t = OpamParserTypes.env_update_op =
       | Eq
       | PlusEq
       | EqPlus

src/dune_pkg/opam_solver.ml

@@ -360,7 +360,7 @@ module Solver = struct
     and real_impl =
       { pkg : OpamPackage.t
       ; conflict_class : OpamPackage.Name.t list
-      ; requires : dependency list
+      ; requires : dependency list Lazy.t
       }
 
     and dependency =
@@ -454,7 +454,7 @@ module Solver = struct
       let requires _ = function
         | Dummy | Reject _ -> []
         | VirtualImpl (_, deps) -> deps
-        | RealImpl impl -> impl.requires
+        | RealImpl impl -> Lazy.force impl.requires
       ;;
 
       let conflict_class = function
@@ -565,15 +565,16 @@ module Solver = struct
             let pkg = OpamPackage.create role version in
             (* Note: we ignore depopts here: see opam/doc/design/depopts-and-features *)
             let requires =
-              let rank = Rank.assign () in
-              let make_deps importance xform get =
-                get opam
-                |> Context.filter_deps context pkg
-                |> xform
-                |> list_deps ~importance ~rank
-              in
-              make_deps Ensure ensure OpamFile.OPAM.depends
-              @ make_deps Prevent prevent OpamFile.OPAM.conflicts
+              lazy
+                (let rank = Rank.assign () in
+                 let make_deps importance xform get =
+                   get opam
+                   |> Context.filter_deps context pkg
+                   |> xform
+                   |> list_deps ~importance ~rank
+                 in
+                 make_deps Ensure ensure OpamFile.OPAM.depends
+                 @ make_deps Prevent prevent OpamFile.OPAM.conflicts)
             in
             let conflict_class = OpamFile.OPAM.conflict_class opam in
             Some (RealImpl { pkg; requires; conflict_class }))
@@ -1536,17 +1537,8 @@ let opam_commands_to_actions
         Some action))
 ;;
 
-let opam_env_update_to_env_update ((var, env_op, value_string, _) : OpamTypes.env_update)
-  : String_with_vars.t Action.Env_update.t
-  =
-  { Action.Env_update.op =
-      (match (env_op : OpamParserTypes.env_update_op) with
-       | Eq -> Eq
-       | PlusEq -> PlusEq
-       | EqPlus -> EqPlus
-       | ColonEq -> ColonEq
-       | EqColon -> EqColon
-       | EqPlusEq -> EqPlusEq)
+let opam_env_update_to_env_update (var, env_op, value_string, _) : _ Action.Env_update.t =
+  { Action.Env_update.op = env_op
   ; var
   ; value = String_with_vars.make_text Loc.none value_string
   }

src/sat/sat.ml

@@ -42,6 +42,7 @@ module VarID : sig
     val create : unit -> t
     val mem : t -> id -> bool
     val add : t -> id -> unit
+    val clear : t -> unit
   end
 end = struct
   type t = int
@@ -153,6 +154,12 @@ module Make (User : USER) = struct
       }
 
     let create () = { pos = VarID.Hash_set.create (); neg = VarID.Hash_set.create () }
+    let temp = create ()
+
+    let clear () =
+      VarID.Hash_set.clear temp.pos;
+      VarID.Hash_set.clear temp.neg
+    ;;
 
     let mem { pos; neg } (sign, lit) =
       match sign with
@@ -194,7 +201,8 @@ module Make (User : USER) = struct
   ;;
 
   let remove_duplicates lits =
-    let seen = LitSet.create () in
+    LitSet.clear ();
+    let seen = LitSet.temp in
     let rec find_unique = function
       | [] -> []
       | x :: xs when LitSet.mem seen x -> find_unique xs
@@ -454,13 +462,13 @@ module Make (User : USER) = struct
               enqueue problem lits.(0) (Clause t))
             else (
               match lit_value lits.(i) with
+              | False -> find_not_false (i + 1)
               | Undecided | True ->
                 (* If it's True then we've already done our job,
                    so this means we don't get notified unless we backtrack, which is fine. *)
                 Array.swap lits 1 i;
                 watch_lit (neg lits.(1)) t;
-                true
-              | False -> find_not_false (i + 1))
+                true)
           in
           find_not_false 2)
       | At_most_one (current, problem, lits) ->
@@ -595,7 +603,10 @@ module Make (User : USER) = struct
     then (* Trivially true already if any literal is True. *)
       ()
     else (
-      let seen = LitSet.create () in
+      let seen =
+        LitSet.clear ();
+        LitSet.temp
+      in
       let rec simplify unique = function
         | [] -> Some unique
         | x :: _ when LitSet.mem seen (neg x) -> None (* X or not(X) is always True *)

test/blackbox-tests/test-cases/promote/deep-subdir.t

@@ -0,0 +1,60 @@
+Tests for promoting directory targets
+-------------------------------------
+
+  $ cat > dune-project << EOF
+  > (lang dune 3.0)
+  > (using directory-targets 0.1)
+  > EOF
+
+  $ cat > dune << EOF
+  > (rule
+  >  (deps
+  >   (source_tree deep))
+  >  (targets
+  >   (dir deep_copied))
+  >  (mode promote)
+  >  (action
+  >   (run cp -r deep deep_copied)))
+  > EOF
+
+Let's create the directory structure we are going to promote (as a copy on
+another dir):
+
+  $ mkdir -p deep/a/
+  $ touch deep/a/deep_file
+  $ touch deep/base_file
+
+Let's try this:
+
+  $ dune build deep_copied
+
+This one works. Now, let's add a layer between base_file and deep_file:
+
+  $ rm -rf deep
+  $ mkdir -p deep/a/b/
+  $ touch deep/a/b/deep_file
+  $ touch deep/base_file
+
+  $ dune build deep_copied
+  File "dune", lines 1-8, characters 0-123:
+  1 | (rule
+  2 |  (deps
+  3 |   (source_tree deep))
+  4 |  (targets
+  5 |   (dir deep_copied))
+  6 |  (mode promote)
+  7 |  (action
+  8 |   (run cp -r deep deep_copied)))
+  Error: Cannot promote files to "deep_copied/a/b".
+  Reason: opendir(deep_copied/a/b): No such file or directory
+  -> required by _build/default/deep_copied
+  [1]
+
+It does not work! Note that the `base_file` is required. For instance, move it
+to `a/`, or remove it, and it works:
+
+  $ mv deep/base_file deep/a/
+  $ dune build deep_copied
+
+  $ rm deep/a/base_file
+  $ dune build deep_copied