From 8306477be29f2f4a75ac85e5effe82cc4c58e0f7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Abril=20Rinc=C3=B3n=20Blanco?= Date: Mon, 30 Jun 2025 13:10:28 +0200 Subject: [PATCH] Document generators_folder --- reference/conanfile/attributes/folders.inc | 9 +++++++++ reference/conanfile/methods/generate.rst | 2 +- 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/reference/conanfile/attributes/folders.inc b/reference/conanfile/attributes/folders.inc index aa55a3784655..4af24b4d9579 100644 --- a/reference/conanfile/attributes/folders.inc +++ b/reference/conanfile/attributes/folders.inc @@ -42,6 +42,15 @@ The folder used to build the source code. The path is built joining the base dir directory when running in the cache or the ``output folder`` when running locally) with the value of ``folders.build`` if declared in the ``layout()`` method. + +.. _attribute_generators_folder: + +generators_folder +----------------- + +The folder where the files in the ``generate()`` method should be generated. The path is built +from the layout's ``self.folders.generators`` attribute. + .. _conan_conanfile_properties_package_folder: package_folder diff --git a/reference/conanfile/methods/generate.rst b/reference/conanfile/methods/generate.rst index d99e17338301..47c4b625a895 100644 --- a/reference/conanfile/methods/generate.rst +++ b/reference/conanfile/methods/generate.rst @@ -24,7 +24,7 @@ The idea is that the ``generate()`` method implements all the necessary logic, m very straightforward, and also the ``build()`` method logic simpler. The build produced by a user in their local flow should result in exactly the same one as the build done in the cache with a ``conan create`` without effort. -Generation of files happens in the ``generators_folder`` as defined by the current layout. +Generation of files happens in the :ref:`generators_folder` as defined by the current layout. In many cases, the ``generate()`` method might not be necessary, and declaring the ``generators`` attribute could be enough: