File: profile.qdoc

package info (click to toggle)
qbs 3.1.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 30,968 kB
  • sloc: cpp: 120,478; ansic: 72,055; javascript: 14,887; python: 5,882; asm: 1,742; sh: 1,059; java: 693; objc: 409; lex: 194; xml: 141; perl: 137; yacc: 86; makefile: 55; cs: 41
file content (93 lines) | stat: -rw-r--r-- 3,187 bytes parent folder | download | duplicates (10)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qbs.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
    \previouspage Product
    \nextpage Project
    \qmltype Profile
    \inqmlmodule QbsLanguageItems
    \ingroup list-of-items
    \keyword QML.Profile

    \brief Creates a profile within the project.

    The profiles used by \QBS are normally set up on a user's machine and are then available
    to all projects. See \l{Configuring Profiles and Preferences} for information on how
    to set up and use profiles on the command line.
    In some rare cases, however, the creator of a project has complete knowledge about the system
    on which that project is to be built. Then it can make sense to integrate the profile into
    the project:

    \code
    Product {
        // ...
        Profile {
            name: "my-special-profile"
            qbs.toolchainType: "gcc"
            qbs.targetPlatform: "linux"
            qbs.architecture: "armv7a"
            cpp.toolchainInstallPath: "/opt/special-gcc/bin"
            cpp.toolchainPrefix: "arm-linux-gnueabi-"
        }
        qbs.profiles: ["my-special-profile"]
        // ...
    }
    \endcode

    The project in the above example can be built in a particular well-known environment
    without any additional setup.

    \c Profile items can appear inside \l{Product} and \l{Project} items.
*/

/*!
    \qmlproperty string Profile::baseProfile

    The name of a profile from which this profile inherits. If the same property is
    set in both this profile and the base profile, the value from this profile
    takes precedence.

    \nodefaultvalue
*/

/*!
    \qmlproperty bool Profile::condition

    Determines whether this profile can be used.

    If this property is set to \c false, the profile cannot be used.

    \defaultvalue \c true
*/

/*!
    \qmlproperty string Profile::name

    The name under which the profile can be referenced later. Setting this property
    is required. The value must be unique among all profiles in an entire project.

    \nodefaultvalue
*/