Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Description about build helpers and generators #958

Merged
merged 2 commits into from
Nov 29, 2018
Merged

Description about build helpers and generators #958

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
13f2a55
Description about build helpers and generators
danimtb Nov 29, 2018
91ad83a
typo
jgsogo Nov 29, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion reference/build_helpers.rst
View file
Open in desktop
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 are
danimtb marked this conversation as resolved.
Show resolved Hide resolved
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
View file
Open in desktop
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