Skip to content

Commit 9e4d89d

Browse files
Clarify locking behavior
Signed-off-by: Marek Kubica <[email protected]>
1 parent 15a0e31 commit 9e4d89d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

doc/tutorials/dune-package-management/locking.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ use new versions of their dependencies. However some projects might want to
99
keep a fixed set of dependencies that is only updated manually. This can be
1010
done in multiple ways.
1111

12-
## Create a lock directory
12+
## Create a lock directory manually
1313

14-
Dune locks dependencies by creating lock directories. The default lock
15-
directory is called `dune.lock`. To create a lock, run
14+
Dune resolves dependencies by creating an internal lock directory
15+
automatically. However, if an manually created lock directory exists in the
16+
source, Dune will use that one instead. The default name of said lock directory
17+
is `dune.lock`, and it can be created manually:
1618

1719
```
1820
$ dune pkg lock
@@ -24,7 +26,7 @@ Solution for dune.lock:
2426

2527
Whenever Dune encounters a `dune.lock` folder, it will use the set of
2628
dependencies defined in the lock. The lock will not be updated until a user
27-
relocks by running `dune pkg lock` again.
29+
creates a new lock by running `dune pkg lock` again.
2830

2931
On the next build, Dune will read the solution from the `dune.lock` directory,
3032
download and build the dependencies and then continue on building the project

0 commit comments

Comments
 (0)