Improve structure of package locking documentation#14181
Improve structure of package locking documentation#14181
Conversation
Suggests some reformatting and languages tweaks, aimed to improve the documentation of this functionality. Signed-off-by: Shon Feder <shon.feder@gmail.com>
| keep a fixed set of (transitive) dependencies that is only updated manually. | ||
|
|
||
| ## Create a lock directory manually | ||
| ## Creating a lock directory |
There was a problem hiding this comment.
I think the "manually" is important here, because Dune pkg will use a lock directory no matter what.
You can also reformulate to say "explicitely" or something along these but I think the important thing here that this is the user-initiated version.
There was a problem hiding this comment.
Dune pkg will use a lock directory no matter what
Isn't the lock invisible to users (unless they go digging the build directory), and updated implicitly unless they run dune pkg lock? If so, that is effectively not a lock, but just a cached solution, right? Or am I misunderstanding the dynamics you are thinking of? Note that https://dune.readthedocs.io/en/stable/tutorials/dune-package-management/setup.html does not mentioning locking at all (as it shouldn't, IMO) and this sections is called Locking dependencies, the only instruction on how to do so being this one here.
Signed-off-by: Shon Feder <shon.feder@gmail.com>
2 participants
Suggests some reformatting and languages tweaks, aimed to improve the documentation of this functionality.