forked from qt-creator/qt-creator
Doc: add definitions for project-related terms
Arrange terms in alphabetic order. Change-Id: Iba41fbf087b251299cb0bc7281bf46ebd5f270b4 Reviewed-by: Tobias Hunger <tobias.hunger@nokia.com>
This commit is contained in:
Leena Miettinen
@@ -39,44 +39,33 @@
|
|||||||
\o Meaning
|
\o Meaning
|
||||||
|
|
||||||
\row
|
\row
|
||||||
\o Qt in PATH
|
\o Build configuration
|
||||||
\target glossary-system-qt
|
\target glossary-build-config
|
||||||
\o This is the Qt
|
\o Contains all the information you need to compile the sources
|
||||||
version for the \c qmake command found in your \c PATH
|
into binaries. Different build configurations allow you to
|
||||||
environment variable.
|
quickly build the project for different purposes.
|
||||||
This is likely to be the system's Qt version.
|
By default, \QC creates \e {debug build} and \e {release build}
|
||||||
|
configurations for each \e target. A debug build contains
|
||||||
|
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.
|
||||||
|
|
||||||
\row
|
\row
|
||||||
\o Project Qt
|
\o Build step
|
||||||
\target glossary-project-qt
|
\target glossary-build-step
|
||||||
\o The version of Qt configured in the \gui{Projects} mode,
|
\o A command that \QC executes to accomplish a basic step in a
|
||||||
\gui {Build Settings}, \gui {Qt Version} field. This is the Qt
|
complex task such as cleaning, building, or deploying a project.
|
||||||
version that is actually used by a particular project.
|
\QC executes build steps in sequence to complete the task.
|
||||||
|
The number and type of necessary build steps depends on the
|
||||||
\row
|
project type and the build system you use. For example, projects
|
||||||
\o Shadow build
|
that are based on \c qmake specify build steps to use \c qmake
|
||||||
\target glossary-shadow-build
|
and \c make.
|
||||||
\o Shadow building means building a project in a separate
|
|
||||||
directory, the \e{build directory}. The build directory is
|
|
||||||
different from the source directory. One of the benefits of
|
|
||||||
shadow building is that it keeps your source directory clean.
|
|
||||||
Shadow building is the best practice if you need many build
|
|
||||||
configurations for a single set of source.
|
|
||||||
|
|
||||||
\row
|
|
||||||
\o Target
|
|
||||||
\target glossary-development-target
|
|
||||||
\o Target means the software platform for which you develop an
|
|
||||||
application. \QC groups platform specific settings (such
|
|
||||||
as build configurations, compatible tool chains, and supported
|
|
||||||
Qt versions) as targets to make cross-platform development
|
|
||||||
easier.
|
|
||||||
|
|
||||||
\row
|
\row
|
||||||
\o Component
|
\o Component
|
||||||
\target glossary-component
|
\target glossary-component
|
||||||
\o A component is an instantiable QML definition, typically
|
\o An instantiable QML definition, typically
|
||||||
contained in a .qml file. For instance, a Button component may
|
contained in a .qml file. For instance, a Button component may
|
||||||
be defined in Button.qml. The QML runtime may instantiate this
|
be defined in Button.qml. The QML runtime may instantiate this
|
||||||
Button component to create Button objects. Alternatively, a
|
Button component to create Button objects. Alternatively, a
|
||||||
@@ -84,6 +73,80 @@
|
|||||||
\l{http://doc.qt.nokia.com/4.7-snapshot/qmlreusablecomponents.html}
|
\l{http://doc.qt.nokia.com/4.7-snapshot/qmlreusablecomponents.html}
|
||||||
{Component} element.
|
{Component} element.
|
||||||
|
|
||||||
|
\row
|
||||||
|
\o Deploy configuration
|
||||||
|
\target glossary-deploy-config
|
||||||
|
\o Handles the packaging and copying of the necessary files to a
|
||||||
|
location you want to run the executable at. The files can be
|
||||||
|
copied to a location in the file system of the development PC or
|
||||||
|
a mobile device.
|
||||||
|
|
||||||
|
\row
|
||||||
|
\o Mode
|
||||||
|
\target glossary-mode
|
||||||
|
\o Adapts the \QC user interface to the different application
|
||||||
|
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
|
||||||
|
\o Project
|
||||||
|
\target glossary-project
|
||||||
|
\o Groups together a set of source files, forms, and resource files
|
||||||
|
that you can build, deploy, and run for different \e targets, as
|
||||||
|
specified by a \e {build configuration}, \e {deploy
|
||||||
|
configuration}, and \e {run configuration}.
|
||||||
|
|
||||||
|
\row
|
||||||
|
\o Qt version
|
||||||
|
\target glossary-project-qt
|
||||||
|
\o \QC allows you to have multiple versions of Qt installed on your
|
||||||
|
development PC and use different versions to build your projects
|
||||||
|
for different \e targets. Select the Qt version in the \e {build
|
||||||
|
configuration} for the project.
|
||||||
|
|
||||||
|
\row
|
||||||
|
\o Run configuration
|
||||||
|
\target glossary-run-config
|
||||||
|
\o Starts the application in the location where it was copied by
|
||||||
|
the \e {deploy configuration}. By default, when you run a
|
||||||
|
project, \QC builds it, deploys it to the selected \e target,
|
||||||
|
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.
|
||||||
|
|
||||||
|
\row
|
||||||
|
\o Shadow build
|
||||||
|
\target glossary-shadow-build
|
||||||
|
\o Shadow building means building a project in a separate
|
||||||
|
directory, the \e{build directory}. The build directory is
|
||||||
|
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.
|
||||||
|
|
||||||
|
\row
|
||||||
|
\o Target
|
||||||
|
\target glossary-development-target
|
||||||
|
\o The software platform for which you develop an
|
||||||
|
application. \QC groups platform specific settings (such as
|
||||||
|
\e {build configurations}, \e {deploy configurations},
|
||||||
|
compatible \e {tool chains}, and supported \e {Qt versions}) as
|
||||||
|
targets to make cross-platform development easier.
|
||||||
|
|
||||||
|
\row
|
||||||
|
\o Tool chain
|
||||||
|
\target glossary-tool-chain
|
||||||
|
\o Specifies a compiler and a debugger and other necessary
|
||||||
|
tools for building an application for a particular \e target.
|
||||||
|
\QC tries to detect the tool chains that are available on your
|
||||||
|
system. You can manually add tool chains that are not detected
|
||||||
|
automatically.
|
||||||
|
|
||||||
\endtable
|
\endtable
|
||||||
|
|
||||||
*/
|
*/
|
||||||
|
|||||||
Reference in New Issue
Block a user