Doc: Turn Managing Sessions into a how-to topic

Task-number: QTCREATORBUG-29361
Change-Id: If15556fdcb5d365b65f1f56a77ab9c21739d0854
Reviewed-by: <github-actions-qt-creator@cristianadam.eu>
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2023-10-31 16:01:44 +01:00
parent 702f4393f9
commit eb9c2da726
11 changed files with 22 additions and 29 deletions

View File

@@ -170,7 +170,7 @@
\section2 Opening Sessions from Locator \section2 Opening Sessions from Locator
You can use the filter that triggers menu commands to open You can use the filter that triggers menu commands to open
\l{Managing Sessions}{sessions}. Enter \l{Manage sessions}{sessions}. Enter
\c {t yoursess} or \c {t sess yoursess} to trigger \uicontrol File > \c {t yoursess} or \c {t sess yoursess} to trigger \uicontrol File >
\uicontrol Sessions > \e <session_name>. \uicontrol Sessions > \e <session_name>.

View File

@@ -149,7 +149,7 @@
\image qtcreator-toggle-progress-bar.webp {Toggle Progress Details button} \image qtcreator-toggle-progress-bar.webp {Toggle Progress Details button}
By default, \QC runs one clangd process per project. If you have created By default, \QC runs one clangd process per project. If you have created
\l{Managing Sessions}{sessions} that have related projects, you can \l{Manage sessions}{sessions} that have related projects, you can
specify that the projects in the session should be managed by a single specify that the projects in the session should be managed by a single
clangd process. clangd process.

View File

@@ -197,15 +197,13 @@
\li -lastsession \li -lastsession
\li ProjectExplorer plugin: load the last session when \QC starts. \li ProjectExplorer plugin: load the last session when \QC starts.
Open the projects and files that were open when you last exited Open the projects and files that were open when you last exited
\QC. For more information about managing sessions, see \QC.
\l{Managing Sessions}.
\row \row
\li <session> \li <session>
\li ProjectExplorer plugin: load the given session when \QC starts. \li ProjectExplorer plugin: load the given session when \QC starts.
Open the projects and files that were open when you last exited Open the projects and files that were open when you last exited
\QC. For more information about managing sessions, see \QC.
\l{Managing Sessions}.
\endtable \endtable
@@ -225,5 +223,5 @@
You can also switch to a dark theme to customize the appearance of widgets, You can also switch to a dark theme to customize the appearance of widgets,
colors, and icons without using stylesheets. colors, and icons without using stylesheets.
\sa {Run Qt Creator from the command line} \sa {Run Qt Creator from the command line}, {Manage sessions}
*/ */

View File

@@ -173,7 +173,7 @@
To open a project that is located in a particular directory, you can To open a project that is located in a particular directory, you can
pass on the directory name as a command-line argument. \QC looks for pass on the directory name as a command-line argument. \QC looks for
a \l{Managing Sessions}{session} that matches the directory name and a \l{Manage sessions}{session} that matches the directory name and
loads it. Or it looks for a project file in the directory and opens it. loads it. Or it looks for a project file in the directory and opens it.
For example, on Windows: For example, on Windows:

View File

@@ -13,11 +13,13 @@
\previouspage creator-project-managing-workspaces.html \previouspage creator-project-managing-workspaces.html
\nextpage creator-keyboard-shortcuts.html \nextpage creator-keyboard-shortcuts.html
\else \else
\previouspage creator-sharing-project-settings.html \previouspage creator-how-tos.html
\nextpage creator-design-mode.html
\endif \endif
\title Managing Sessions \ingroup creator-how-to-use
\ingroup studio-how-to
\title Manage sessions
When you exit \QC, it stores a snapshot of your current workspace as a When you exit \QC, it stores a snapshot of your current workspace as a
\e session. To restore the session automatically when you start \QC, \e session. To restore the session automatically when you start \QC,
@@ -61,6 +63,8 @@
To save a session under a new name, select \uicontrol Clone. To save a session under a new name, select \uicontrol Clone.
\section1 Create new sessions
To create a new session: To create a new session:
\list 1 \list 1
@@ -76,9 +80,12 @@
\endlist \endlist
\section1 Open sessions
To switch between sessions, select \uicontrol {Open}. To switch between sessions, select \uicontrol {Open}.
\if defined(qtcreator) \if defined(qtcreator)
The \uicontrol Projects tab in the \uicontrol Welcome mode lists existing The \uicontrol Projects tab in the \uicontrol Welcome mode lists existing
sessions. To open a session, select it or press sessions. To open a session, select it or press
\key Ctrl+Alt+<number>, where \e <number> is the number of the session to \key Ctrl+Alt+<number>, where \e <number> is the number of the session to
@@ -96,7 +103,7 @@
When you start \QC from the command line, you can give the name of When you start \QC from the command line, you can give the name of
a session as an argument and \QC will start with this session. a session as an argument and \QC will start with this session.
For more information, see \l{Command-Line Options}. \sa {Command-Line Options}, {Searching with the Locator}
\endif \endif
*/ */

View File

@@ -16,10 +16,6 @@
\image front-projects.png \image front-projects.png
You can share projects with other designers and developers across different
development platforms with a common tool for design, development, and
debugging.
\list \list
\li \l{Creating Projects} \li \l{Creating Projects}
@@ -42,14 +38,8 @@
configurations for \QC and your projects. You can modify configurations for \QC and your projects. You can modify
the settings in the \uicontrol Projects mode. the settings in the \uicontrol Projects mode.
\li \l{Managing Sessions}
Sessions store items such as open files, breakpoints, and evaluated
expressions, which you do not typically want to share across
platforms.
\endlist \endlist
\sa {Build Systems} \sa {Manage Projects}{How To: Manage Projects}, {Manage sessions},
{Build Systems}
*/ */

View File

@@ -46,6 +46,6 @@
\note You cannot use this view to specify subprojects for projects. \note You cannot use this view to specify subprojects for projects.
\sa {Add subprojects to projects}, {Managing Sessions} \sa {Add subprojects to projects}, {Manage sessions}
*/ */

View File

@@ -42,7 +42,6 @@
\li \l{Using Custom Output Parsers} \li \l{Using Custom Output Parsers}
\li \l{Sharing Project Settings} \li \l{Sharing Project Settings}
\endlist \endlist
\li \l{Managing Sessions}
\endlist \endlist
\li \l{Designing User Interfaces} \li \l{Designing User Interfaces}
\list \list

View File

@@ -53,7 +53,6 @@
\li \l{Creating Projects} \li \l{Creating Projects}
\li \l{Version Control Systems} \li \l{Version Control Systems}
\li \l{Configuring Projects} \li \l{Configuring Projects}
\li \l{Managing Sessions}
\endlist \endlist
\li \b {\l{Designing User Interfaces}} \li \b {\l{Designing User Interfaces}}
\list \list

View File

@@ -19,7 +19,7 @@
\if defined(qtcreator) \if defined(qtcreator)
The project tree has a list of all projects open in the current The project tree has a list of all projects open in the current
\l{Managing Sessions}{session}. For each project, the tree visualizes \l{Manage sessions}{session}. For each project, the tree visualizes
the build system structure of the project and lists all files that the build system structure of the project and lists all files that
are part of the project. are part of the project.

View File

@@ -36,7 +36,7 @@
\li \l{Qt Insight} \li \l{Qt Insight}
\endlist \endlist
\li \l{Managing Workspaces} \li \l{Managing Workspaces}
\li \l{Managing Sessions} \li \l{Manage sessions}
\li \l{Keyboard Shortcuts} \li \l{Keyboard Shortcuts}
\endlist \endlist
\li \l{Creating Projects} \li \l{Creating Projects}