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

docs: clarify use cases for declare_dependency() #14170

Merged
merged 1 commit into from
Jan 21, 2025
Merged

docs: clarify use cases for declare_dependency() #14170

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 5 additions & 3 deletions docs/yaml/functions/declare_dependency.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ returns: dep
description: |
This function returns a [[@dep]] object that
behaves like the return value of [[dependency]] but is
internal to the current build. The main use case for this is in
internal to the current build. One use case for this is in
subprojects. This allows a subproject to easily specify how it should
be used. This makes it interchangeable with the same dependency that
is provided externally by the system.
is provided externally by the system. Another common use case is to
declare project targets as dependencies so they may be used as
dependencies of other build targets.
kwargs:
compile_args:
Expand Down Expand Up @@ -49,7 +51,7 @@ kwargs:
description: |
extra files to add to targets.
mostly used for IDE integration.
version:
type: str
description: |
Expand Down
Loading