aboutsummaryrefslogtreecommitdiffstats
path: root/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
blob: f70f1d6db3fbd7e41331afa6a9c0eee674243b3f (plain)
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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
/****************************************************************************
**
** Copyright (C) 2018 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Creator documentation.
**
** 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.
**
****************************************************************************/

// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************

/*!
    \previouspage creator-vcs-subversion.html
    \page creator-configuring-projects.html
    \nextpage creator-targets.html

    \title Configuring Projects

    When you install Qt for a target platform, such as Android or QNX, the
    build and run settings for the development targets might be set up
    automatically in \QC.

    When you open a project for the first time, the
    \uicontrol {Configure Projects} view is displayed to let you select a set of
    \l{glossary-buildandrun-kit}{kits} that you want to use to build and run
    your project. At least one kit must be active for you to be able to build
    and run the project. For more information about selecting the initial kit,
    see \l{Opening Projects}.

    To maintain the list of active kits for a currently open project, switch to
    the \uicontrol Projects mode by pressing \key Ctrl+5.

    \section1 Activating Kits for a Project

    All kits compatible with your project are listed in the
    \uicontrol {Build & Run} section of the sidebar. To activate one or more
    disabled kits, click them.

    \image qtcreator-project-kits.png

    The list displays kits that are configured in \uicontrol Tools >
    \uicontrol Options > \uicontrol Kits. If the kit configuration is not
    suitable for the project type, warning and error icons are displayed.
    To view the warning and error messages, move the mouse pointer over
    the kit name.

    To modify kit configuration or to add kits to the list, select
    \uicontrol {Manage Kits}. For more information about managing kits, see
    \l{Adding Kits}.

    Each kit consists of a set of values that define one environment, such as a
    \l{glossary-device}{device}, compiler, and Qt version. For more information,
    see \l{Adding Qt Versions}, \l{Adding Compilers}, and \l{Adding Debuggers}.

    To copy the build and run settings for a kit to another kit, select
    \uicontrol {Copy Steps from Other Kit} in the context menu.

    To deactivate a kit, select \uicontrol {Disable Kit for Project} in the
    context menu.

    \note Deactivating a kit removes all custom build and run settings for the
    kit.

    To import an existing build for the project, select
    \uicontrol {Import Existing Build}.

    \section1 Specifying Settings

    To specify build or run settings for a kit, select \uicontrol Build or
    \uicontrol Run below the kit. For more information, see
    \l{Specifying Build Settings} and \l{Specifying Run Settings}.

    In addition, you can modify the following global settings for each project:

            \list

                \li \l{Specifying Editor Settings}{Editor}

                \li \l{Specifying Code Style Settings}{Code Style}

                \li \l{Specifying Dependencies}{Dependencies}

                \li \l{Specifying Environment Settings}{Environment}

                \li \l{Using Custom Output Parsers}{Custom Output Parsers}

                \li \l{Parsing C++ Files with the Clang Code Model}
                    {Clang Code Model}

                \li \l{Using Clang Tools}{Clang Tools}

                \li \l{To-Do Entries}{To-Do} (experimental)

            \endlist

    If you have multiple projects open in \QC, select the project to configure
    in the list of projects.

*/