Skip to content

Commit

Permalink
Description about build helpers and generators (#958)
Browse files Browse the repository at this point in the history
* Description about build helpers and generators

* typo

Co-Authored-By: danimtb <danimanzaneque@gmail.com>
  • Loading branch information
danimtb authored and jgsogo committed Nov 29, 2018
1 parent 0cfce10 commit a5b6e61
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 3 deletions.
3 changes: 2 additions & 1 deletion reference/build_helpers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
Build helpers
=============

There are several helpers that can assist to automate the build() method for popular build systems
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
assist users with the compilation of libraries and applications in the ``build()`` method of a recipe.

Contents:

Expand Down
8 changes: 6 additions & 2 deletions reference/generators.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,14 @@
Generators
==========

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

You can specify a generator in:

- The **[generators]** section from :ref:`conanfile.txt<conanfile_txt_reference>`
- The **generators** attribute in :ref:`conanfile.py<conanfile_reference>`
- The ``[generators]`` section from :ref:`conanfile.txt<conanfile_txt_reference>`
- The ``generators`` attribute in :ref:`conanfile.py<conanfile_reference>`

Available generators:

Expand Down

0 comments on commit a5b6e61

Please sign in to comment.