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

Doc: Document the Restart Now button that appears when needed

Browse Source 
Typically, when users enable or disable plugins.

Change-Id: I1d9588e662613d6c061756d247bf12f7c1ace4ba
Reviewed-by: Eike Ziller <eike.ziller@qt.io>
This commit is contained in:
Leena Miettinen
2020-02-26 15:29:17 +01:00
parent 07fae31f3c
commit da5d53b89b
17 changed files with 47 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/qtcreator/src/analyze/creator-cppcheck.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -44,7 +44,7 @@
\li Select \uicontrol Help > \uicontrol {About Plugins} > \li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Code Analyzer} > \uicontrol Cppcheck to enable the \uicontrol {Code Analyzer} > \uicontrol Cppcheck to enable the
plugin. plugin.
\li Restart \QC to load the plugin. \li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Analyzer \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Analyzer
> \uicontrol Cppcheck to specify settings for running Cppcheck. > \uicontrol Cppcheck to specify settings for running Cppcheck.
\image qtcreator-cppcheck-options.png "Cppcheck options" \image qtcreator-cppcheck-options.png "Cppcheck options"

4
doc/qtcreator/src/baremetal/creator-baremetal-dev.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -49,7 +49,7 @@
\uicontrol {Device Support} > \uicontrol {Bare Metal} to enable the \uicontrol {Device Support} > \uicontrol {Bare Metal} to enable the
Bare Metal Device plugin. Bare Metal Device plugin.
\li Restart \QC to be able to use the plugin. \li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Devices >
\uicontrol {Bare Metal} > \uicontrol Add > \uicontrol Default, \uicontrol {Bare Metal} > \uicontrol Add > \uicontrol Default,

6
doc/qtcreator/src/editors/creator-clangformat.qdocinc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -33,8 +33,8 @@
library for automatic formatting and indentation. library for automatic formatting and indentation.
To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} > To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {C++} > \uicontrol {ClangFormat}. Then restart \QC to load the \uicontrol {C++} > \uicontrol {ClangFormat}. Then select
plugin. \uicontrol {Restart Now} to restart \QC and load the plugin.
\note If you enable the plugin, do not use the \l{Beautifying Source Code} \note If you enable the plugin, do not use the \l{Beautifying Source Code}
{Beautifier}, because combining the two can provide unexpected results. {Beautifier}, because combining the two can provide unexpected results.

4
doc/qtcreator/src/editors/creator-only/creator-beautifier.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2018 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -74,7 +74,7 @@
\li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {C++} > \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {C++} >
\uicontrol Beautifier to enable the plugin. \uicontrol Beautifier to enable the plugin.
\li Restart \QC to be able to use the plugin. \li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li Select \uicontrol Tools > \uicontrol Options > \li Select \uicontrol Tools > \uicontrol Options >
\uicontrol Beautifier to specify settings for beautifying files. \uicontrol Beautifier to specify settings for beautifying files.

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

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2018 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -105,8 +105,8 @@
To use the built-in code model instead, select \uicontrol Help > To use the built-in code model instead, select \uicontrol Help >
\uicontrol {About Plugins} > \uicontrol C++, and deselect the \uicontrol {About Plugins} > \uicontrol C++, and deselect the
\uicontrol ClangCodeModel check box. The changes take effect after \uicontrol ClangCodeModel check box. Select \uicontrol {Restart Now}
you restart \QC. to restart \QC and have the changes take effect.
You can configure Clang diagnostics either globally or separately for: You can configure Clang diagnostics either globally or separately for:

4
doc/qtcreator/src/editors/creator-only/creator-compilation-database.qdocinc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -56,7 +56,7 @@
To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} > To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Build Systems} > \uicontrol {Compilation Database Project Manager}. \uicontrol {Build Systems} > \uicontrol {Compilation Database Project Manager}.
Then restart \QC to load the plugin. Then select \uicontrol {Restart Now} to restart \QC and load the plugin.
//! [using compilation databases] //! [using compilation databases]
*/ */

7
doc/qtcreator/src/editors/creator-only/creator-scxml.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2018 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -107,8 +107,9 @@
\list 1 \list 1
\li Select \uicontrol Help > \uicontrol {About Plugins} > \li Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol Modeling > \uicontrol ScxmlEditor and restart \QC to \uicontrol Modeling > \uicontrol ScxmlEditor.
enable the plugin.
\li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li Select \uicontrol File > \uicontrol {New File or Project} > \li Select \uicontrol File > \uicontrol {New File or Project} >
\uicontrol {Files and Classes} > \uicontrol Modeling > \uicontrol {Files and Classes} > \uicontrol Modeling >

6
doc/qtcreator/src/editors/creator-search.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2018 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -245,7 +245,7 @@
\uicontrol {Utilities} > \uicontrol {SilverSearcher} to enable the \uicontrol {Utilities} > \uicontrol {SilverSearcher} to enable the
plugin. plugin.
\li Restart \QC to be able to use the plugin. \li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li When searching, select \uicontrol {Silver Searcher} in the \li When searching, select \uicontrol {Silver Searcher} in the
\uicontrol {Search engine} field. \uicontrol {Search engine} field.
@@ -267,7 +267,7 @@
\li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol C++ \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol C++
> \uicontrol {ClangRefactoring} to enable the plugin. > \uicontrol {ClangRefactoring} to enable the plugin.
\li Restart \QC to be able to use the plugin. \li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li When searching, select \uicontrol {Clang Query Project} in the \li When searching, select \uicontrol {Clang Query Project} in the
\uicontrol {Scope} field. \uicontrol {Scope} field.

6
doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -67,8 +67,8 @@
\QC has been localized into several languages. If the system \QC has been localized into several languages. If the system
language is one of the supported languages, it is automatically selected. language is one of the supported languages, it is automatically selected.
To change the language, select \uicontrol {Tools > Options > Environment} and To change the language, select \uicontrol {Tools > Options > Environment} and
select a language in the \uicontrol Language field. The change takes effect after select a language in the \uicontrol Language field. Select
you restart \QC. \uicontrol {Restart Now} to restart \QC and have the change take effect.
\b {Has a reported issue been addressed?} \b {Has a reported issue been addressed?}

7
doc/qtcreator/src/howto/creator-ui.qdoc
View File

@@ -118,7 +118,8 @@
is one of the supported languages, it is automatically selected. To is one of the supported languages, it is automatically selected. To
change the language, select \uicontrol Tools > \uicontrol Options > change the language, select \uicontrol Tools > \uicontrol Options >
\uicontrol Environment and select a language in the \uicontrol Language \uicontrol Environment and select a language in the \uicontrol Language
field. The change takes effect after you restart \QC. field. Select \uicontrol {Restart Now} to restart \QC and have the change
take effect.
\section1 Viewing Images \section1 Viewing Images
@@ -612,8 +613,8 @@
The Todo plugin is disabled by default. To enable the plugin, select The Todo plugin is disabled by default. To enable the plugin, select
\uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities > \uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities >
\uicontrol Todo and restart \uicontrol Todo. Then select \uicontrol {Restart Now} to restart \QC
\QC. and load the plugin.
In addition, you can open task list files generated by code scanning and In addition, you can open task list files generated by code scanning and
analysis tools in the \uicontrol Issues pane. For more information, see analysis tools in the \uicontrol Issues pane. For more information, see

2
doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
View File

@@ -103,7 +103,7 @@
\uicontrol {Device Support} > \uicontrol {Bare Metal} and \uicontrol {Device Support} > \uicontrol {Bare Metal} and
\uicontrol {MCU Support} to enable the Bare Metal and MCU \uicontrol {MCU Support} to enable the Bare Metal and MCU
plugins. plugins.
\li Restart \QC to be able to use the plugins. \li Select \uicontrol {Restart Now} to restart \QC and load the plugins.
\li Create connections for debugging on the MCU board, as described in \li Create connections for debugging on the MCU board, as described in
\l{Connecting Bare Metal Devices}. \l{Connecting Bare Metal Devices}.
\endlist \endlist

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

@@ -36,9 +36,8 @@
The AutotoolsProjectManager is a plugin for autotools support. It is The AutotoolsProjectManager is a plugin for autotools support. It is
disabled by default. To enable the plugin, select \uicontrol Help > disabled by default. To enable the plugin, select \uicontrol Help >
\uicontrol {About Plugins} > \uicontrol {Build Systems} > \uicontrol {About Plugins} > \uicontrol {Build Systems} >
\uicontrol AutotoolsProjectManager. \uicontrol AutotoolsProjectManager.Then select \uicontrol {Restart Now}
to restart \QC and load the plugin.
To use the plugin, restart \QC.
To work with your Autotools project in \QC: To work with your Autotools project in \QC:

3
doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc
View File

@@ -38,7 +38,8 @@
To use \QC for Nim development, you need to enable the experimental To use \QC for Nim development, you need to enable the experimental
Nim plugin. Select \uicontrol Help > \uicontrol {About Plugins} > Nim plugin. Select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Other Languages} > \uicontrol Nim, and then restart \QC. \uicontrol {Other Languages} > \uicontrol Nim. Then select
\uicontrol {Restart Now} to restart \QC and load the plugin.
In addition, you have to download and install Nim and set up a Nim kit In addition, you have to download and install Nim and set up a Nim kit
in \QC. in \QC.

5
doc/qtcreator/src/qtquick/qtquick-timeline.qdoc
View File

@@ -60,8 +60,9 @@
The \uicontrol Timeline view is not visible in \QC by default. To enable The \uicontrol Timeline view is not visible in \QC by default. To enable
it, select \uicontrol Tools > \uicontrol Options > \uicontrol {Qt Quick} > it, select \uicontrol Tools > \uicontrol Options > \uicontrol {Qt Quick} >
\uicontrol {Qt Quick Designer} > \uicontrol {Enable Timeline editor}. You \uicontrol {Qt Quick Designer} > \uicontrol {Enable Timeline editor}.
need to restart \QC for the \uicontrol Timeline view to appear. Select \uicontrol {Restart Now} to restart \QC with the \uicontrol Timeline
view visible.
To be able to create timelines, you also need the \l {Qt Quick Timeline} To be able to create timelines, you also need the \l {Qt Quick Timeline}
module, which is delivered with Qt 5.14, and later. For more module, which is delivered with Qt 5.14, and later. For more

5
doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -42,7 +42,8 @@
Since \QC 4.9, the Perforce plugin is disabled by default. To enable Since \QC 4.9, the Perforce plugin is disabled by default. To enable
it, select \uicontrol Help > \uicontrol {About Plugins} > it, select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol Perforce, and then restart \QC. \uicontrol {Version Control} > \uicontrol Perforce. Then select
\uicontrol {Restart Now} to restart \QC and load the plugin.
\section1 Configuring Perforce \section1 Configuring Perforce

10
doc/qtcreator/src/vcs/creator-only/creator-vcs.qdoc
View File

@@ -52,8 +52,9 @@
\li \l{http://www-01.ibm.com/software/awdtools/clearcase/} \li \l{http://www-01.ibm.com/software/awdtools/clearcase/}
\li Disabled by default. To enable the plugin, select \li Disabled by default. To enable the plugin, select
\uicontrol Help > \uicontrol {About Plugins} > \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol ClearCase, and then \uicontrol {Version Control} > \uicontrol ClearCase.
restart \QC. Then select \uicontrol {Restart Now} to restart \QC
and load the plugin.
\row \row
\li \l{Using CVS}{CVS} \li \l{Using CVS}{CVS}
\li \l{http://www.nongnu.org/cvs/} \li \l{http://www.nongnu.org/cvs/}
@@ -75,8 +76,9 @@
Disabled by default. To enable the plugin, select Disabled by default. To enable the plugin, select
\uicontrol Help > \uicontrol {About Plugins} > \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Version Control} > \uicontrol Perforce, \uicontrol {Version Control} > \uicontrol Perforce.
and then restart \QC. Then select \uicontrol {Restart Now} to restart \QC
and load the plugin.
\row \row
\li \l{Using Subversion}{Subversion} \li \l{Using Subversion}{Subversion}
\li \l{http://subversion.apache.org/} \li \l{http://subversion.apache.org/}

4
doc/qtcreator/src/webassembly/creator-webassembly.qdoc
View File

@@ -1,6 +1,6 @@
/**************************************************************************** /****************************************************************************
** **
** Copyright (C) 2019 The Qt Company Ltd. ** Copyright (C) 2020 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/ ** Contact: https://www.qt.io/licensing/
** **
** This file is part of the Qt Creator documentation. ** This file is part of the Qt Creator documentation.
@@ -80,7 +80,7 @@
\li In \QC, select \uicontrol Help > \uicontrol {About Plugins} > \li In \QC, select \uicontrol Help > \uicontrol {About Plugins} >
\uicontrol {Device Support} > \uicontrol {WebAssembly} to enable \uicontrol {Device Support} > \uicontrol {WebAssembly} to enable
the plugin. the plugin.
\li Restart \QC to be able to use the plugin. \li Select \uicontrol {Restart Now} to restart \QC and load the plugin.
\li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits > \li Select \uicontrol Tools > \uicontrol Options > \uicontrol Kits >
\uicontrol {Qt Versions} > \uicontrol Add to add Qt for WebAssembly \uicontrol {Qt Versions} > \uicontrol Add to add Qt for WebAssembly
(wasm_32). (wasm_32).