exports conf (#3703)

conan-io · May 6, 2024 · eb2b5cd · eb2b5cd
1 parent 75a6aca
commit eb2b5cd
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/reference/conanfile/methods/export.rst b/reference/conanfile/methods/export.rst
@@ -33,5 +33,7 @@ There are 2 files that are always exported to the cache, without being explicitl
     **Best practices**
 
     - The recipe files must be configuration independent. Those files are common for all configurations, thus it is not possible to do conditional ``export()`` to different settings, options, or platforms. Do not try to do any kind of conditional export. If necessary export all the files necessary for all configurations at once.
+    - The ``export()`` method does not receive any information from profiles, not even ``conf``. Only the ``global.conf`` will be available, and in any case it is not possible to use that ``conf`` to define conditionals.
+    - Keep the ``export()`` method simple. Its intention is to copy files from the user folder to the cache to store those files together with the recipe.
     - The exported files must be small. Exporting big files with the recipe will make the resolution of dependencies much slower the resolution.
     - Only files that are necessary for the evaluation of the ``conanfile.py`` recipe must be exported with this method. Files necessary for building from sources should be exported with the ``exports_sources`` attribute or the :ref:`export_source()<reference_conanfile_methods_export_sources>` method.
diff --git a/reference/conanfile/methods/export_sources.rst b/reference/conanfile/methods/export_sources.rst
@@ -56,7 +56,6 @@ in the ``conandata.yml`` file, which could be later applied with ``apply_conanda
 
     **Best practices**
 
-    The recipe sources must be configuration independent. Those sources are common for all configurations,
-    thus it is not possible to do conditional ``export_sources()`` to different settings, options, or
-    platforms. Do not try to do any kind of conditional export. If necessary export all the files necessary for 
-    all configurations at once.
+    - The recipe sources must be configuration independent. Those sources are common for all configurations, thus it is not possible to do conditional ``export_sources()`` to different settings, options, or platforms. Do not try to do any kind of conditional export. If necessary export all the files necessary for all configurations at once.
+    - The ``export_sources()`` method does not receive any information from profiles, not even ``conf``. Only the ``global.conf`` will be available, and in any case it is not possible to use that ``conf`` to define conditionals.
+    - Keep the ``export_source()`` method simple. Its intention is to copy files from the user folder to the cache to store those files together with the recipe.