creator-glossary.qdoc 6.88 KB
Newer Older
1 2
/****************************************************************************
**
3 4
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
5
**
6
** This file is part of the Qt Creator documentation.
7
**
8 9 10 11 12 13 14
** 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.
15
**
16
** GNU Free Documentation License Usage
17 18
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
19 20 21 22
** 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.
23 24 25 26 27 28 29 30 31 32
**
****************************************************************************/

// **********************************************************************
// 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.
// **********************************************************************

/*!
33
    \contentspage {Qt Creator Manual}
34
    \previouspage creator-known-issues.html
35
    \page creator-glossary.html
36
    \nextpage technical-support.html
37 38 39 40 41

    \title Glossary

    \table
        \header
42 43
            \li Term
            \li Meaning
44 45

        \row
46
            \li Build configuration
47
                \target glossary-build-config
48
            \li Contains all the information you need to compile the sources
49 50 51
                into binaries. Different build configurations allow you to
                quickly build the project for different purposes.
                By default, \QC creates \e {debug build} and \e {release build}
52 53
                configurations for each \l{glossary-buildandrun-kit}{kit} defined for your project.
                A debug build contains
54 55 56 57
                additional debug symbols that you need for debugging the
                application but that you can leave out from the release version.
                Generally, you use the debug configuration for testing and the
                release configuration for creating the final installation file.
58

59
        \row
60
            \li Build step
61
                \target glossary-build-step
62
            \li A command that \QC executes to accomplish a basic step in a
63 64 65 66 67 68 69 70
                complex task such as cleaning, building, or deploying a project.
                \QC executes build steps in sequence to complete the task.
                The number and type of necessary build steps depends on the
                project type and the build system you use. For example, projects
                that are based on \c qmake specify build steps to use \c qmake
                and \c make.

        \row
71
            \li Component
72
                \target glossary-component
73
            \li An instantiable QML definition, typically
74 75 76
                contained in a .qml file. For instance, a Button component may
                be defined in Button.qml. The QML runtime may instantiate this
                Button component to create Button objects. Alternatively, a
77
                component may be defined inside a \l{Component} QML type.
78 79

        \row
80
            \li Deploy configuration
81
                \target glossary-deploy-config
82
            \li Handles the packaging and copying of the necessary files to a
83
                location you want to run the executable at. The files can be
84 85
                copied to a location in the file system of the development PC,
                an embedded device, or a mobile device.
86

87
        \row
88
            \li Kit
89
                \target glossary-buildandrun-kit
90
            \li \QC groups build and run specific settings as kits to make
91 92 93
                cross-platform development easier. Each kit consists of a set
                of values that define one environment, such as a device,
                tool chain, Qt version, and debugger command to use. Configure kits at
94
                \uicontrol {Tools > Options > Build & Run > Kits}.
95

96
        \row
97
            \li Mode
98
                \target glossary-mode
99
            \li Adapts the \QC user interface to the different application
100 101 102 103 104 105 106
                development tasks at hand. Each mode has its own view that shows
                only the information required for performing a particular task,
                and provides only the most relevant features and functions
                related to it. As a result, the majority of the \QC window area
                is always dedicated to actual application development tasks.

        \row
107
            \li Project
108
                \target glossary-project
109
            \li Groups together a set of source files, forms, and resource files
110
                that you can build for, as well as deploy and run on different desktop,
111
                embedded, and mobile device platforms, as
112 113
                specified by a \e {build configuration}, \e {deploy
                configuration}, and \e {run configuration}.
114 115

        \row
116
            \li Qt version
117
                \target glossary-project-qt
118
            \li \QC allows you to have multiple versions of Qt installed on your
119
                development PC and use different versions to build your projects
120
                for different purposes.
121 122

        \row
123
            \li Run configuration
124
                \target glossary-run-config
125
            \li Starts the application in the location where it was copied by
126
                the \e {deploy configuration}. By default, when you run a
127 128
                project, \QC builds it, deploys it to the device specified in the selected
                \l{glossary-buildandrun-kit}{kit},
129 130 131
                and runs it there. However, if you have not made any changes to
                the project since you last built and deployed it, \QC simply
                runs it again.
132 133

        \row
134
            \li Shadow build
135
                \target glossary-shadow-build
136
            \li Shadow building means building a project in a separate
137
                directory, the \e{build directory}. The build directory is
138 139 140 141 142 143
                different from the \e {source directory}. One of the benefits of
                shadow building is that it keeps your source directory clean,
                which makes it faster to switch between \e {build
                configurations}. Therefore, shadow building is the best practice
                if you need many build configurations for a single set of
                source files.
144 145 146 147

    \endtable

*/