Skip to content

Commit

Permalink
Rename QbsToolchain to QbsProfile (#2027)
Browse files Browse the repository at this point in the history
* Rename QbsToolchain to QbsProfile

* Rename use_profile to profile
  • Loading branch information
Psy-Kai authored Feb 22, 2021
1 parent 19305e2 commit 7d91b5b
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions reference/conanfile/tools/qbs.rst
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

0 comments on commit 7d91b5b

Please sign in to comment.