Skip to content
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

Revert workspace detection #5206

Merged
merged 4 commits into from
Nov 23, 2021
Merged

Revert workspace detection #5206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2e26ecc
Restore workspace finding behavior
voodoos Nov 22, 2021
0177eaf
Update docs
voodoos Nov 22, 2021
8aa12db
tweaks
jeremiedimino Nov 22, 2021
44ed978
Grammar tweaks in doc/usage.rst
voodoos Nov 22, 2021
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
38 changes: 30 additions & 8 deletions bin/workspace_root.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,22 @@ module Kind = struct
| Dune_workspace
| Dune_project
| Cwd

let priority = function
| Explicit -> 0
| Dune_workspace -> 1
| Dune_project -> 2
| Cwd -> 3

let lowest_priority = max_int

let of_dir_contents files =
if String.Set.mem files Workspace.filename then
Some Dune_workspace
else if String.Set.mem files Dune_project.filename then
Some Dune_project
else
None
end

type t =
Expand All @@ -27,7 +43,8 @@ end

let find () =
let cwd = Sys.getcwd () in
let rec loop counter ~candidate ~to_cwd dir : Candidate.t option =
let rec loop counter ~(candidate : Candidate.t option) ~to_cwd dir :
Candidate.t option =
match Sys.readdir dir with
| exception Sys_error msg ->
User_warning.emit
Expand All @@ -42,13 +59,18 @@ let find () =
candidate
| files ->
let files = String.Set.of_list (Array.to_list files) in
if String.Set.mem files Workspace.filename then
Some { kind = Dune_workspace; dir; to_cwd }
else if String.Set.mem files Dune_project.filename then
let candidate = Some { Candidate.kind = Dune_project; dir; to_cwd } in
cont counter ~candidate dir ~to_cwd
else
cont counter ~candidate dir ~to_cwd
let candidate =
let candidate_priority =
match candidate with
| Some c -> Kind.priority c.kind
| None -> Kind.lowest_priority
in
match Kind.of_dir_contents files with
| Some kind when Kind.priority kind <= candidate_priority ->
Some { Candidate.kind; dir; to_cwd }
| _ -> candidate
in
cont counter ~candidate dir ~to_cwd
and cont counter ~candidate ~to_cwd dir =
if counter > String.length cwd then
candidate
Expand Down
46 changes: 22 additions & 24 deletions doc/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,10 @@ Finding the Root
================

The root of the current workspace is determined by looking up a
``dune-workspace`` or ``dune-project`` file in the current directory
and its parent directories.
``dune-workspace`` or ``dune-project`` file in the current directory and its
parent directories. Dune requires at least one of these two files to operate.

If it isn't in the current
directory, Dune prints out the root when starting:
If it isn't in the current directory, Dune prints out the root when starting:

.. code:: bash

Expand All @@ -100,17 +99,16 @@ directory, Dune prints out the root when starting:
This message can be suppressed with the ``--no-print-directory``
command line option (as in GNU make).

Dune requires at least one ``dune-workspace`` file or ``dune-project``
file to operate. This file may appear in the current or a parent
directory. It's used to mark the root of the current workspace;
however, ``dune-workspace`` and ``dune-project`` files are treated
slightly differently. Since there can be only a single workspace
active at a given time, Dune stops its search for the root at the
first ``dune-workspace`` file it encounters. On the other hand, Dune
projects are composable, and there can be multiple projects in a
single workspace. For this reason, when Dune finds a ``dune-project``
file it will continue searching in parent directories, in case this
project is part of a bigger workspace.
More precisely, Dune will choose the outermost ancestor directory containing a
``dune-workspace`` file, which is used to mark the root of the current workspace.
If no ``dune-workspace`` file is present, the same strategy applies with
``dune-project`` files.

In case of a mix of `dune-workspace` and `dune-project` files, workspace files
take precedence over project files in the sense that if a ``dune-workspace``
file is found, only parent ``dune-workspace`` files will be considered when
looking for the root; however, if a `dune-project` file is found both parent
``dune-workspace`` and ``dune-project`` files will be considered.

A ``dune-workspace`` file is also a configuration file. Dune will read
it unless the ``--workspace`` command line option is used. See the
Expand Down Expand Up @@ -302,7 +300,7 @@ See :ref:`variables-for-artifacts` for more information.
Finding External Libraries
==========================

When a library isn't available in the workspace, Dune search for it
When a library isn't available in the workspace, Dune will search for it
in the installed world and expect it to be already compiled.

It looks up external libraries using a specific list of search paths,
Expand Down Expand Up @@ -411,7 +409,7 @@ dune subst
==========

One of the features ``dune-release`` provides is watermarking; it replaces
various strings of the form ``%%ID%%`` in all your project files
various strings of the form ``%%ID%%`` in all your project files
before creating a release tarball or when the Opam user pins the package.

This is especially interesting for the ``VERSION`` watermark, which gets
Expand Down Expand Up @@ -453,7 +451,7 @@ file in the directory where ``dune subst`` is called. The
``dune-project`` file must exist and contain a valid ``(name ...)``
field.

Note that ``dune subst`` is meant to be called from the Opam file and
Note that ``dune subst`` is meant to be called from the Opam file and
behaves a bit different to other Dune commands. In
particular it doesn't try to detect the root of the workspace and must
be called from the root of the project.
Expand Down Expand Up @@ -523,13 +521,13 @@ OCaml projects to find them, and this location might be different from
Historically, the location where to store OCaml library files was
configured through `findlib
<http://projects.camlcity.org/projects/findlib.html>`__, and the
``ocamlfind`` command-line tool was used to both install
and locate these files. Many Linux distributions (or other packaging systems)
``ocamlfind`` command-line tool was used to both install
and locate these files. Many Linux distributions (or other packaging systems)
use this mechanism to setup where OCaml library files should be
copied.

As a result, if neither ``--libdir`` or ``--prefix`` is passed to ``dune
install``, and ``ocamlfind`` is present in the ``PATH``, then Dune copies library files
install``, and ``ocamlfind`` is present in the ``PATH``, then Dune copies library files
to the directory reported by ``ocamlfind printconf destdir``. This
ensures that ``dune install`` can be used without Opam. When using opam,
``ocamlfind`` is configured to point to the Opam directory, so this rule makes
Expand Down Expand Up @@ -562,7 +560,7 @@ Querying Merlin Configuration
Since Version 2.8, Dune no longer promotes ``.merlin`` files to the source
directories. Instead, Dune stores these configurations in the `_build`
folder, and Merlin communicates directly with Dune to obtain its configuration
via the `ocaml-merlin` subcommand. The Merlin configuration is now stanza-specific,
via the `ocaml-merlin` subcommand. The Merlin configuration is now stanza-specific,
allowing finer control. The following commands aren't needed for
normal Dune and Merlin use, but they can provide insightful information when
debugging or configuring non-standard projects.
Expand Down Expand Up @@ -592,8 +590,8 @@ Merlin configuration syntax by running the following command:

$ dune ocaml dump-dot-merlin > .merlin

In that case, Dune prints only one configuration: the result of the configuration's
coarse merge in the current folder's various modules.
In that case, Dune prints only one configuration: the result of the configuration's
coarse merge in the current folder's various modules.
This folder must be in a Dune workspace, and the project must be already
built. Preprocessing directives and other flags will be commented out and must
be un-commented afterward. This feature doesn't aim at writing exact or correct
Expand Down