Skip to content

Commit

Permalink
Improve trim_conandata() docs (#3624)
Browse files Browse the repository at this point in the history
  • Loading branch information
@AbrilRBS
AbrilRBS authored Mar 7, 2024
1 parent 3b70f67 commit 44fc808
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions reference/tools/files/basic.rst
View file
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

0 comments on commit 44fc808

Please sign in to comment.