Skip to content

Docs for recipe attribute in ConanFileInterface #4264

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

Merged
merged 3 commits into from
Oct 8, 2025
Merged

Docs for recipe attribute in ConanFileInterface #4264

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
bcfab61
Update doc about conanfile interface
araffin Oct 1, 2025
c1db387
Update reference/conanfile/methods/generate.rst
memsharded Oct 8, 2025
c6ca7a4
Apply suggestion from @AbrilRBS
AbrilRBS Oct 8, 2025
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
3 changes: 2 additions & 1 deletion reference/conanfile/methods/generate.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ In many cases, the ``generate()`` method might not be necessary, and declaring t

But the ``generate()`` method can explicitly instantiate those generators, use them conditionally (like using one build system in Windows,
and another build system integration in other platforms), customize them, or provide a complete custom
generation.
generation.

.. code:: python

Expand Down Expand Up @@ -200,6 +200,7 @@ Not all fields of the dependency conanfile are exposed, the current fields are:
- **package_type**: The ``package_type`` of the dependency
- **languages**: The ``languages`` of the dependency.
- **extension_properties**: The ``extension_properties`` of the dependency. Should be treated as read-only.
- **recipe**: The ``recipe`` type of the dependency (e.g., "Cache"). This should only be used for `informational <https://github.com/conan-io/conan/issues/18996>`_ or reporting purposes. Using it for any kind of conditional logic on the consumers side is considered bad practice and unsupported.


Iterating dependencies
Expand Down