feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Turn Opening Projects into a How-to topic

Browse Source 
Describe the ways to open projects before the case where
one needs to re-configure the project.

Task-number: QTCREATORBUG-29361
Change-Id: I32b8676112e412fe8b4f114c54371169f478d361
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2023-08-03 16:59:43 +02:00
parent 253eb4779b
commit 70f5d18fe9
12 changed files with 82 additions and 70 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
doc/qtcreator/images/qtcreator-welcome-open-projects.webp Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

2
doc/qtcreator/src/cmake/creator-projects-cmake-presets.qdoc
View File

@@ -20,7 +20,7 @@
enforce version checking. It reads and uses all the fields from version 3 if
present. It does not support test presets.
You can import the presets the first time you \l {Opening Projects}
You can import the presets the first time you \l {Open projects}
{open a project}, when no \c CMakeLists.txt.user file exists or you have
disabled all kits in the project.

4
doc/qtcreator/src/cmake/creator-projects-cmake.qdoc
View File

@@ -69,7 +69,7 @@
and open that in \QC, as described in \l{Using Compilation Databases}.
\li Create an ad-hoc project file for a qmake build using
\c{qmake -project} and \l{Opening Projects}{open} that in \QC.
\c{qmake -project} and \l{Open projects}{open} that in \QC.
Be aware that this is typically
not compilable without further manual changes.
@@ -215,7 +215,7 @@
\section1 Related Topics
\list
\li \l {Opening Projects}
\li \l {Open projects}
\li \l {CMake Build Configuration}
\li \l {Specifying Run Settings}
\li \l {Deploying to Remote Linux}

2
doc/qtcreator/src/editors/creator-only/creator-clang-codemodel.qdoc
View File

@@ -136,7 +136,7 @@
The clangd \e index provides exact and complete results for services such
as finding references, following symbols under cursor, and using the
locator, even for complex constructs. When you \l{Opening Projects}
locator, even for complex constructs. When you \l{Open projects}
{open a project}, clangd scans the source files to generate the index. For
large projects, this can take a while, but the index is persistent and
re-scanning is incremental, so nothing is lost by closing and re-starting

1
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -67,6 +67,7 @@
\li \l {Create OpenGL fragment and vertex shaders}
\li \l {Create resource files}
\li \l {Develop Qt for Python applications}
\li \l {Open projects}
\li \l {Specify project contents}
\li \l {Select the build system}
\li \l {Use project wizards}

2
doc/qtcreator/src/meson/creator-projects-meson.qdoc
View File

@@ -87,7 +87,7 @@
\section1 Related Topics
\list
\li \l {Opening Projects}
\li \l {Open projects}
\li \l {Meson Build Configuration}
\li \l {Specifying Run Settings}
\endlist

5
doc/qtcreator/src/projects/creator-only/creator-projects-creating.qdoc
View File

@@ -10,7 +10,7 @@
/*!
\previouspage creator-project-managing.html
\page creator-project-creating.html
\nextpage creator-file-creating.html
\nextpage creator-project-qmake-libraries.html
\ingroup creator-explanation-projects
@@ -70,8 +70,7 @@
\l{Connecting Devices}{connect} to them from the development PC.
\sa {Manage Projects}{How-to: Manage Projects},
{Adding Libraries to Projects}, {Opening Projects},
{Adding New Custom Wizards}
{Adding Libraries to Projects}, {Adding New Custom Wizards}
*/
/*!

2
doc/qtcreator/src/projects/creator-only/creator-projects-libraries.qdoc
View File

@@ -8,7 +8,7 @@
// **********************************************************************
/*!
\previouspage creator-project-opening.html
\previouspage creator-project-creating.html
\page creator-project-qmake-libraries.html
\nextpage creator-project-wizards.html

128
doc/qtcreator/src/projects/creator-only/creator-projects-opening.qdoc
View File

@@ -1,5 +1,5 @@
// Copyright (C) 2022 The Qt Company Ltd.
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
@@ -9,26 +9,70 @@
// **********************************************************************
/*!
\previouspage creator-file-creating.html
\page creator-project-opening.html
\nextpage creator-project-qmake-libraries.html
\previouspage creator-how-tos.html
\title Opening Projects
\ingroup creator-how-to-projects
\title Open projects
To open a project, open the project file for the project:
\e {CMakeLists.txt} (CMake), \e {.pro} (qmake), \e {.qbs} (Qbs),
\e {meson.build} (Meson), \e {pyproject} (Python), or \e {Makefile.am}
(Autotools, experimental).
You can open a project in the following ways:
\list
\li Select \uicontrol File > \uicontrol {Open File or Project}.
\li In the \uicontrol Welcome mode, \uicontrol Projects tab, select
\uicontrol {Open Project} (1).
\image qtcreator-welcome-open-projects.webp {Ways to open projects in the Welcome mode Projects tab}
\li In the \uicontrol Projects tab, select a project in the list of
recently opened projects (2).
\li In the \l Projects view, right-click to open a context
menu and select \uicontrol {Load Project} to open the
\uicontrol {Load Project} dialog, where you can select
a project file.
\li Use the following keyboard shortcuts, depending on the mode you are
currently in:
\list
\li In all modes, press \key Ctrl+O (\key Cmd+O on \macos) to open the
\uicontrol {Open File} dialog, where you can select a project file.
\li On Windows and Linux, in all modes except the \uicontrol Help mode,
press \key Ctrl+Shift+O to open the \uicontrol {Load Project} dialog.
\li In the \uicontrol Welcome mode, \uicontrol Projects tab, press
\key Ctrl+Shift+number (\key Cmd+Shift+number on \macos), where
the number is the number of a project in the list of recently opened
projects (3).
\endlist
\endlist
\section1 Re-configure projects
\QC stores information that it needs to build projects in a .user file. If
\QC cannot find the file when you open an existing project, it prompts you
to enter the information. If you used another \QC instance to create the
project, \QC asks whether you want to use the old settings. The settings
are specific to the development environment, and you should not copy them from
one environment to another. Therefore, we recommend that you select \uicontrol No
and enter the information again in the \uicontrol {Configure Project} tab.
to enter the information.
The \uicontrol {Configure Project} tab displays a list of \l{glossary-buildandrun-kit}{kits}
for building and running projects, that you install on the development PC and
configure in \uicontrol Edit > \uicontrol Preferences > \uicontrol Kits.
Select the kits that you want to build and run the project with.
If you used another \QC instance to create the project, \QC asks whether you
want to use the old settings. The settings are specific to the development
environment, and you should not copy them from one environment to another.
Therefore, we recommend that you select \uicontrol No and enter the
information again in the \uicontrol {Configure Project} tab.
\image qtcreator-open-project-kits.png "Configure Project tab"
To re-configure projects:
\list 1
\li In the \uicontrol {Configure Project} tab, select
\l{glossary-buildandrun-kit}{kits} for building
and running your project.
\image qtcreator-open-project-kits.png {Configure Project tab}
\li Select \uicontrol {Configure Project}.
\endlist
The \uicontrol {Configure Project} tab displays a list of kits that you
install on the development PC and configure in \uicontrol Edit >
\uicontrol Preferences > \uicontrol Kits.
Even if you do not intend to build the project, the C++ and QML code models
need a Qt version and compiler to offer code completion. To specify them,
@@ -39,61 +83,27 @@
{language server client} for code completion, highlighting, and
other useful features.
If \QC cannot find an existing build for a particular \l{glossary-buildandrun-kit}{kit},
it starts out
from a clean slate, and creates new debug and release build configurations
in the specified directory. \QC suggests a name
and location for the directory that you can change.
If \QC cannot find an existing build for a particular kit, it starts out
from a clean slate and creates new debug and release build configurations
in the specified directory. \QC suggests a name and location for the
directory that you can change.
\section1 Import builds
If you have built the project before, \QC can use the existing build
configuration to make the exact same build available to you. To import a
build, specify a directory in the
\uicontrol {Import Build From} section and select \uicontrol {Import}.
build, specify a directory in the \uicontrol {Import Build From} section
of the \uicontrol {Configure Project} tab and select \uicontrol {Import}.
You can edit the build configuration later. For more information, see
\l{Editing Build Configurations}.
To open a project:
\list 1
\li Select \uicontrol File > \uicontrol {Open File or Project}
(\key Ctrl+O or \key Cmd+O on \macos) and select the project file
for the project to open: \e {.pro} (qmake), \e {CMakeLists.txt}
(CMake), \e {.qbs} (Qbs), \e {meson.build} (Meson), \e {pyproject} (Python), or
\e {Makefile.am} (Autotools, experimental).
\li In the \uicontrol {Configure Project} tab, select kits for building
and running your project.
\li Select \uicontrol {Configure Project}.
\endlist
You can use the following keyboard shortcuts to open projects, depending on
the mode you are currently in:
\list
\li In all modes, press \key Ctrl+O (\key Cmd+O on \macos) to open the
\uicontrol {Open File} dialog, where you can select a project file
to open a project.
\li In all modes, except the \uicontrol Help mode, press
\key Ctrl+Shift+O (\key Cmd+Shift+O on \macos) to open the
\uicontrol {Load Project} dialog, where you can select a project
file to open a project.
\li In the \uicontrol Welcome mode, \uicontrol Projects tab, press
\key Ctrl+Shift+number (\key Cmd+Shift+number on \macos), where
the number is the number of a project in the list of recently opened
projects.
\endlist
\section1 Show progress information
\QC parses all the source files in the project and performs a semantic
analysis to build up the information that it needs for functions such as
navigation and finding usages. A progress bar is displayed during parsing.
To show or hide detailed progress information, select
\uicontrol {Toggle Progress Details} (1).
@@ -102,4 +112,6 @@
You can drag the progress bar to another position. The position is saved for
later. Select the \inlineimage icons/pin.png
(\uicontrol Pin) button to pin the progress bar back to the toggle button.
\sa {Adding Kits}
*/

2
doc/qtcreator/src/projects/creator-only/creator-projects-qbs.qdoc
View File

@@ -66,7 +66,7 @@
\section1 Related Topics
\list
\li \l {Opening Projects}
\li \l {Open projects}
\li \l {Qbs Build Configuration}
\li \l {Specifying Run Settings}
\endlist

2
doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc
View File

@@ -20,7 +20,7 @@
targets. Select the kits to use in the \uicontrol {Configure Projects}
view when you open a project for the first time. At least one kit must be
active. For more information about selecting the initial kit, see
\l{Opening Projects}.
\l{Open projects}.
To maintain the list of active kits for a currently open project, switch to
the \uicontrol Projects mode by pressing \key Ctrl+5.

2
doc/qtcreator/src/qtcreator-toc.qdoc
View File

@@ -25,7 +25,6 @@
\list
\li \l{Creating Projects}
\list
\li \l{Opening Projects}
\li \l{Adding Libraries to Projects}
\li \l{Adding New Custom Wizards}
\endlist
@@ -282,6 +281,7 @@
\li \l {Create OpenGL fragment and vertex shaders}
\li \l {Create resource files}
\li \l {Develop Qt for Python applications}
\li \l {Open projects}
\li \l {Select the build system}
\li \l {Specify project contents}
\li \l {Use project wizards}