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(requirements): propagate in build context #3816

Merged
merged 5 commits into from
Aug 28, 2024
Merged

docs(requirements): propagate in build context #3816

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ffa51ef
docs(requirements): propagate in build context
maximilianmuehlbauer Aug 24, 2024
ba40aa3
docs(requirements): build=True and headers, libs
maximilianmuehlbauer Aug 26, 2024
d174595
Merge branch 'develop2' into patch-1
czoido Aug 28, 2024
dc5f321
docs(requirements): warn about build=True, visible=True
maximilianmuehlbauer Aug 28, 2024
4eeebde
docs(requirements): merge build trait description
maximilianmuehlbauer Aug 28, 2024
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
5 changes: 4 additions & 1 deletion reference/conanfile/methods/requirements.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,10 @@ build

This dependency is a build tool, an application or executable, like cmake, that is used
exclusively at build time. It is not linked/embedded into binaries, and will be in the
build context.
build context. If ``visible=True`` is set, this dependency will be propagated downstream,
making it available in the "build" context of consumer packages. ``headers`` and ``libs``
traits will not be propagated downstream (do not set those to ``True``, propagating headers
and libraries from build to host context is invalid e.g. in the case of cross building).
maximilianmuehlbauer marked this conversation as resolved.
Show resolved Hide resolved

run
~~~
Expand Down