Skip to content

Commit

Permalink
Improve the documentation of OpamSwitchState.dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
kit-ty-kate committed Aug 20, 2024
1 parent 6d4f0f6 commit e5277ca
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions src/state/opamSwitchState.mli
Original file line number Diff line number Diff line change
Expand Up @@ -167,11 +167,14 @@ val depexts: 'a switch_state -> package -> OpamSysPkg.Set.t
(** Return the transitive dependency closures
of a collection of packages.
[depopts]: include optional dependencies (depopts: foo)
[build]: include build dependencies (depends: foo {build})
[post]: include post dependencies (depends: foo {post})
[installed]: only consider already-installed packages
[unavaiable]: also consider unavailable packages
@param depopts include optional dependencies (depopts: foo)
@param build include build dependencies (depends: foo {build})
@param post include post dependencies (depends: foo {post})
@param installed only consider already-installed packages
@param unavaiable also consider unavailable packages.
If the availability of packages hasn't been computed yet,
setting this [false] can have a significant performance
impact depending on the platform.
*)
val dependencies:
'a switch_state -> build:bool -> post:bool -> depopts:bool ->
Expand Down

0 comments on commit e5277ca

Please sign in to comment.