Doc: Document the Restart Now button that appears when needed

Typically, when users enable or disable plugins. Change-Id: I1d9588e662613d6c061756d247bf12f7c1ace4ba Reviewed-by: Eike Ziller <eike.ziller@qt.io>
2020-02-26 15:29:17 +01:00
parent 07fae31f3c
commit da5d53b89b
17 changed files with 47 additions and 41 deletions
--- a/doc/qtcreator/src/analyze/creator-cppcheck.qdoc
+++ b/doc/qtcreator/src/analyze/creator-cppcheck.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -44,7 +44,7 @@
        \li Select \uicontrol Help > \uicontrol {About Plugins} >
            \uicontrol {Code Analyzer} > \uicontrol Cppcheck to enable the
            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
            > \uicontrol Cppcheck to specify settings for running Cppcheck.
            \image qtcreator-cppcheck-options.png "Cppcheck options"
--- a/doc/qtcreator/src/baremetal/creator-baremetal-dev.qdoc
+++ b/doc/qtcreator/src/baremetal/creator-baremetal-dev.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -49,7 +49,7 @@
            \uicontrol {Device Support} > \uicontrol {Bare Metal} to enable the
            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 >
            \uicontrol {Bare Metal} > \uicontrol Add > \uicontrol Default,
--- a/doc/qtcreator/src/editors/creator-clangformat.qdocinc
+++ b/doc/qtcreator/src/editors/creator-clangformat.qdocinc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -33,8 +33,8 @@
    library for automatic formatting and indentation.

    To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} >
-    \uicontrol {C++} > \uicontrol {ClangFormat}. Then restart \QC to load the
-    plugin.
+    \uicontrol {C++} > \uicontrol {ClangFormat}. Then select
+    \uicontrol {Restart Now} to restart \QC and load the plugin.

    \note If you enable the plugin, do not use the \l{Beautifying Source Code}
    {Beautifier}, because combining the two can provide unexpected results.
--- a/doc/qtcreator/src/editors/creator-only/creator-beautifier.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-beautifier.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -74,7 +74,7 @@
        \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol {C++} >
            \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 >
            \uicontrol Beautifier to specify settings for beautifying files.
--- a/doc/qtcreator/src/editors/creator-only/creator-clang-codemodel.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-clang-codemodel.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -105,8 +105,8 @@

    To use the built-in code model instead, select \uicontrol Help >
    \uicontrol {About Plugins} > \uicontrol C++, and deselect the
-    \uicontrol ClangCodeModel check box. The changes take effect after
-    you restart \QC.
+    \uicontrol ClangCodeModel check box. Select \uicontrol {Restart Now}
+    to restart \QC and have the changes take effect.

    You can configure Clang diagnostics either globally or separately for:

--- a/doc/qtcreator/src/editors/creator-only/creator-compilation-database.qdocinc
+++ b/doc/qtcreator/src/editors/creator-only/creator-compilation-database.qdocinc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -56,7 +56,7 @@

    To enable the plugin, select \uicontrol Help > \uicontrol {About Plugins} >
    \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]
 */
--- a/doc/qtcreator/src/editors/creator-only/creator-scxml.qdoc
+++ b/doc/qtcreator/src/editors/creator-only/creator-scxml.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -107,8 +107,9 @@
    \list 1

        \li Select \uicontrol Help > \uicontrol {About Plugins} >
-            \uicontrol Modeling > \uicontrol ScxmlEditor and restart \QC to
-            enable the plugin.
+            \uicontrol Modeling > \uicontrol ScxmlEditor.
+
+        \li Select \uicontrol {Restart Now} to restart \QC and load the plugin.

        \li Select \uicontrol File > \uicontrol {New File or Project} >
            \uicontrol {Files and Classes} > \uicontrol Modeling >
--- a/doc/qtcreator/src/editors/creator-search.qdoc
+++ b/doc/qtcreator/src/editors/creator-search.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2018 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -245,7 +245,7 @@
            \uicontrol {Utilities} > \uicontrol {SilverSearcher} 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 {Silver Searcher} in the
            \uicontrol {Search engine} field.
@@ -267,7 +267,7 @@
        \li Select \uicontrol Help > \uicontrol {About Plugins} > \uicontrol C++
            > \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
            \uicontrol {Scope} field.
--- a/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/qtcreator-faq.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -67,8 +67,8 @@
    \QC has been localized into several languages. If the system
    language is one of the supported languages, it is automatically selected.
    To change the language, select \uicontrol {Tools > Options > Environment} and
-    select a language in the \uicontrol Language field. The change takes effect after
-    you restart \QC.
+    select a language in the \uicontrol Language field. Select
+    \uicontrol {Restart Now} to restart \QC and have the change take effect.

    \b {Has a reported issue been addressed?}

--- a/doc/qtcreator/src/howto/creator-ui.qdoc
+++ b/doc/qtcreator/src/howto/creator-ui.qdoc
@@ -118,7 +118,8 @@
    is one of the supported languages, it is automatically selected. To
    change the language, select \uicontrol Tools > \uicontrol Options >
    \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

@@ -612,8 +613,8 @@

    The Todo plugin is disabled by default. To enable the plugin, select
    \uicontrol Help > \uicontrol {About Plugins} > \uicontrol Utilities >
-    \uicontrol Todo and restart
-    \QC.
+    \uicontrol Todo. Then select \uicontrol {Restart Now} to restart \QC
+    and load the plugin.

    In addition, you can open task list files generated by code scanning and
    analysis tools in the \uicontrol Issues pane. For more information, see
--- a/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
+++ b/doc/qtcreator/src/mcu/creator-mcu-dev.qdoc
@@ -103,7 +103,7 @@
            \uicontrol {Device Support} > \uicontrol {Bare Metal} and
            \uicontrol {MCU Support} to enable the Bare Metal and MCU
            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
            \l{Connecting Bare Metal Devices}.
    \endlist
--- a/doc/qtcreator/src/projects/creator-only/creator-projects-autotools.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-autotools.qdoc
@@ -36,9 +36,8 @@
    The AutotoolsProjectManager is a plugin for autotools support. It is
    disabled by default. To enable the plugin, select \uicontrol Help >
    \uicontrol {About Plugins} > \uicontrol {Build Systems} >
-    \uicontrol AutotoolsProjectManager.
-
-    To use the plugin, restart \QC.
+    \uicontrol AutotoolsProjectManager.Then select \uicontrol {Restart Now}
+    to restart \QC and load the plugin.

    To work with your Autotools project in \QC:

--- a/doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc
+++ b/doc/qtcreator/src/projects/creator-only/creator-projects-nimble.qdoc
@@ -38,7 +38,8 @@

    To use \QC for Nim development, you need to enable the experimental
    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 \QC.
--- a/doc/qtcreator/src/qtquick/qtquick-timeline.qdoc
+++ b/doc/qtcreator/src/qtquick/qtquick-timeline.qdoc
@@ -60,8 +60,9 @@

    The \uicontrol Timeline view is not visible in \QC by default. To enable
    it, select \uicontrol Tools > \uicontrol Options > \uicontrol {Qt Quick} >
-    \uicontrol {Qt Quick Designer} > \uicontrol {Enable Timeline editor}. You
-    need to restart \QC for the \uicontrol Timeline view to appear.
+    \uicontrol {Qt Quick Designer} > \uicontrol {Enable Timeline editor}.
+    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}
    module, which is delivered with Qt 5.14, and later. For more
--- a/doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc
+++ b/doc/qtcreator/src/vcs/creator-only/creator-vcs-perforce.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** 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
    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

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

                Disabled by default. To enable the plugin, 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.
        \row
            \li \l{Using Subversion}{Subversion}
            \li \l{http://subversion.apache.org/}
--- a/doc/qtcreator/src/webassembly/creator-webassembly.qdoc
+++ b/doc/qtcreator/src/webassembly/creator-webassembly.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2019 The Qt Company Ltd.
+** Copyright (C) 2020 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -80,7 +80,7 @@
        \li In \QC, select \uicontrol Help > \uicontrol {About Plugins} >
            \uicontrol {Device Support} > \uicontrol {WebAssembly} 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 > \uicontrol Kits >
            \uicontrol {Qt Versions} > \uicontrol Add to add Qt for WebAssembly
            (wasm_32).