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

Improve trim_conandata() docs #3624

Merged
merged 1 commit into from
Mar 7, 2024
+3 −2
Merged

Improve trim_conandata() docs #3624

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
5 changes: 3 additions & 2 deletions reference/tools/files/basic.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,8 +258,9 @@ conan.tools.files.trim_conandata()
This function modifies the ``conandata.yml`` inside the exported folder in the conan cache, if it exists,
and keeps only the information related to the currently built version.

This helper can only be used within the ``export()`` method, it can raise otherwise. One application is
to ensure changes in the ``conandata.yml`` file related to some versions do not affect the generated recipe revisions of the rest.
This helper can only be used within the ``export()`` method or ``post_export()`` :ref:`hook<reference_extensions_hooks>`,
it may raise in the future otherwise. One application is to ensure changes in the ``conandata.yml`` file
related to some versions do not affect the generated recipe revisions of the rest.

Usage:

Expand Down