diff --git a/doc/qtcreator.qdoc b/doc/qtcreator.qdoc index 530cf1e9fd4..c7449a36ee7 100644 --- a/doc/qtcreator.qdoc +++ b/doc/qtcreator.qdoc @@ -995,15 +995,42 @@ \title Managing Projects - Qt Creator allows you to deploy various types of projects and provides a - platform to work on different types of projects: + One of the major advantages of Qt Creator is that it allows a team of + developers to share a project across different development platforms with a common + tool for development and debugging. + + The recommended way to build a project is to use a \l{Using Version Control Systems} {version control system}. + Store and edit only project source files and the .pro and .pri files (for qmake) + or CMakeLists.txt and *.cmake files (for CMake). Do not store + files generated by the build system or Qt Creator, such as makefiles, + .pro.user, and object files. Other approaches are possible, + but we recommend that you do not use network resources, for example. + + Qt Creator allows you to specify separate \l{Build Settings} {build settings} + for each development platform. You can use \l{glossary-shadow-build}{shadow builds} to + keep the build specific files separate from the source. + + You can create separate versions of project files to keep platform-dependent + code separate. You can use qmake + \l{http://qt.nokia.com/doc/4.2/qmake-tutorial.html#adding-platform-specific-source-files}{scopes} + to select the file to process depending on which platform qmake is run on. + + Items such as open files, breakpoints, and watches are stored in + \l{Managing Sessions}{sessions}. They are not considered to be part of the + information shared across platforms. + + Qt Creator is integrated with cross-platform systems for build automation: + qmake and CMake. In addition, you can import generic projects that do not use qmake + or CMake, and specify that Qt Creator ignores your build system. \list \o To work with \bold{qmake projects}, open a \c .pro file. For more information, see \l{Setting Up a qmake Project}. \o To work with \bold{CMake projects} you need to have CMake version 2.8.0 or later installed. For more information, see \l{Setting Up a CMake Project}. - \o Qt Creator supports generic projects. For more information, see + \o To work with \bold{generic projects}, specify which files belong to + your project and which include directories or defines you want to pass + to your compiler. For more information, see \l{Setting Up a Generic Project}. \endlist @@ -1029,10 +1056,6 @@ \l{Adding External Libraries to a Generic Project}. \endlist - \section1 Session Management - In Qt Creator a session is a collection of bookmarks, breakpoints and - watchers and can include multiple open projects. To learn about using and - managing sessions, see \l{Managing Sessions}. */ @@ -1086,6 +1109,19 @@ \title Setting Up a qmake Project + The qmake tool helps simplify the build process for development projects + across different platforms. qmake automates the generation of makefiles + so that only a few lines of information are needed to create each makefile. + qmake can be used for any software project, whether it is written in Qt or not. + + The qmake tool generates a makefile based on the information in a project + file that is generated by Qt Creator. It can generate makefiles for MinGW, + Microsoft Visual studio, and CSL ARM in Windows, and GNU Compiler Collection + (GCC) in Linux and Mac OS X. + + For more information about qmake, see the + \l{http://qt.nokia.com/doc/4.2/qmake-manual.html}{qmake Manual}. + \section1 Selecting the Qt Version Qt Creator allows you to have multiple versions of Qt installed on @@ -2909,10 +2945,17 @@ \title Setting Up a CMake Project - Since Qt Creator 1.1, support for \c CMake project files is available. + CMake is an alternative to qmake for automating the generation of makefiles. + It controls the software compilation process by using simple configuration + files, called CMakeLists.txt files. CMake generates native makefiles and + workspaces that you can use in the compiler environment of your choice. + + Since Qt Creator 1.1, CMake configuration files are supported. Qt Creator 1.3 supports the Microsoft Toolchain if the CMake version is at least 2.8. + \section1 Setting the Path for CMake + You can set the path for the \c CMake executable in \gui{Tools} > \gui{Options...} > \gui{CMake} > \gui{CMake}. @@ -2937,11 +2980,11 @@ To open a \c CMake project: \list 1 - \o Select \gui{File} > \gui{Open File or Project...} - \o Select the \c{CMakeLists.txt} file from your \c CMake project + \o Select \gui{File} > \gui{Open File or Project...}. + \o Select the \c{CMakeLists.txt} file from your \c CMake project. \endlist - A wizard guides you with the rest of the process. + A wizard guides you through the rest of the process. \note If the \c CMake project does not have an in-place build, Qt Creator lets you specify the directory in which the project is built