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

Jump to bottom

Rename QbsToolchain to QbsProfile #2027

Merged
merged 2 commits into from
Feb 22, 2021
Merged

Rename QbsToolchain to QbsProfile #2027

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6a94121
Rename QbsToolchain to QbsProfile
Feb 21, 2021
806fbd0
Rename use_profile to profile
Feb 21, 2021
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
16 changes: 8 additions & 8 deletions reference/conanfile/tools/qbs.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,21 +3,21 @@
conan.tools.qbs
===============

QbsToolchain
QbsProfile
------------

.. warning::

This is an **experimental** feature subject to breaking changes in future releases.


The ``QbsToolchain`` can be used in the ``generate()`` method:
The ``QbsProfile`` can be used in the ``generate()`` method:


.. code:: python

from conans import ConanFile
from conan.tools.qbs import QbsToolchain
from conan.tools.qbs import QbsProfile

class App(ConanFile):
settings = "os", "arch", "compiler", "build_type"
Expand All @@ -26,17 +26,17 @@ The ``QbsToolchain`` can be used in the ``generate()`` method:
default_options = {"shared": False}

def generate(self):
tc = QbsToolchain(self)
tc = QbsProfile(self)
tc.generate()


The ``QbsToolchain`` will generate the following file during :command:`conan install`
The ``QbsProfile`` will generate the following file during :command:`conan install`
command (or before calling the ``build()`` method when the package is being
built in the cache): *conan_toolchain.qbs*. This file will contain a qbs profile
built in the cache): *conan_toolchain_profile.qbs*. This file will contain a qbs profile
named *conan_toolchain_profile*.


*conan_toolchain.qbs* will contain the definitions of all the Qbs properties
*conan_toolchain_profile.qbs* will contain the definitions of all the Qbs properties
related to the Conan options and settings for the current package, platform,
etc. This includes the following:

Expand Down Expand Up @@ -102,7 +102,7 @@ Parameters:
Attributes
++++++++++

use_toolchain_profile
profile
*********************

**Defaulted to**: ``conan_toolchain_profile``
Expand Down