Skip to content

Commit a5b6e61

Browse files
danimtbjgsogo
authored andcommitted
Description about build helpers and generators (#958)
* Description about build helpers and generators * typo Co-Authored-By: danimtb <[email protected]>
1 parent 0cfce10 commit a5b6e61

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

reference/build_helpers.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33
Build helpers
44
=============
55

6-
There are several helpers that can assist to automate the build() method for popular build systems
6+
Build helpers are Python wrappers of a build tool that help with the conversion of the Conan settings to the build system's ones. They
7+
assist users with the compilation of libraries and applications in the ``build()`` method of a recipe.
78

89
Contents:
910

reference/generators.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,14 @@
33
Generators
44
==========
55

6+
Generators are specific components that provide the information of dependencies calculated by Conan in a suitable format for a build system.
7+
They normally provide Conan users with a *conanbuildinfo.XXX* file that can be included or injected to the specific build system. The file
8+
generated contains information of dependencies in form of different variables and sometimes function helpers too.
9+
610
You can specify a generator in:
711

8-
- The **[generators]** section from :ref:`conanfile.txt<conanfile_txt_reference>`
9-
- The **generators** attribute in :ref:`conanfile.py<conanfile_reference>`
12+
- The ``[generators]`` section from :ref:`conanfile.txt<conanfile_txt_reference>`
13+
- The ``generators`` attribute in :ref:`conanfile.py<conanfile_reference>`
1014

1115
Available generators:
1216

0 commit comments

Comments
 (0)