-
Notifications
You must be signed in to change notification settings - Fork 414
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc: add @pkg-install alias documentation (#11137)
Signed-off-by: Etienne Marais <[email protected]> Signed-off-by: Christine Rose <[email protected]> Co-authored-by: Christine Rose <[email protected]>
- Loading branch information
1 parent
a602bb0
commit 2164453
Showing
3 changed files
with
35 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
@pkg-install | ||
============ | ||
|
||
This alias is only relevant when using Dune with *package management* (see | ||
:doc:`/tutorials/dune-package-management/index`). Running ``dune build | ||
@pkg-install`` will fetch the dependencies described in the ``depends`` field | ||
of your ``dune-project`` (see :doc:`/reference/dune-project/package`) and build | ||
them. It will not build your project. | ||
|
||
Indeed, if you need to build the project, you need to use the regular ``dune | ||
build`` command. Note that if the dependencies have not been already fetch and | ||
downloaded, ``dune build`` will **also** take care of getting and building them. | ||
|
||
.. note:: | ||
``dune build @pkg-install`` is particularly useful when you are building | ||
projects using per-layer caching systems, e.g., Docker images. Using this | ||
alias, you will be able to cache the dependencies building stage as they | ||
change less regularly. | ||
|
||
If you are building the ``@pkg-install`` alias in a repository where package | ||
management is not activated, the command has no effect. | ||
|
||
.. seealso:: :doc:`/explanation/package-management` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters