Doc: Document logging viewer

Task-number: QTCREATORBUG-26929
Change-Id: I67e7ab32ab92e28c1d9b018801872d0e111e1971
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@qt.io>
Reviewed-by: Christian Stenger <christian.stenger@qt.io>

10 files changed, 106 insertions, 3 deletions

diff --git a/doc/qtcreator/images/icons/message.png b/doc/qtcreator/images/icons/message.png
new file mode 100644
index 0000000000..4cf36b6092
--- /dev/null
+++ b/doc/qtcreator/images/icons/message.png
diff --git a/doc/qtcreator/images/icons/qtlogo-16.png b/doc/qtcreator/images/icons/qtlogo-16.png
new file mode 100644
index 0000000000..e4623bb7fb
--- /dev/null
+++ b/doc/qtcreator/images/icons/qtlogo-16.png
diff --git a/doc/qtcreator/images/icons/savefile.png b/doc/qtcreator/images/icons/savefile.png
new file mode 100644
index 0000000000..d23d62adc4
--- /dev/null
+++ b/doc/qtcreator/images/icons/savefile.png
diff --git a/doc/qtcreator/images/icons/stopwatch.png b/doc/qtcreator/images/icons/stopwatch.png
new file mode 100644
index 0000000000..5363b789e8
--- /dev/null
+++ b/doc/qtcreator/images/icons/stopwatch.png
diff --git a/doc/qtcreator/images/qtcreator-logging-category-viewer.png b/doc/qtcreator/images/qtcreator-logging-category-viewer.png
new file mode 100644
index 0000000000..4a88efd9b5
--- /dev/null
+++ b/doc/qtcreator/images/qtcreator-logging-category-viewer.png
diff --git a/doc/qtcreator/src/howto/creator-only/creator-logging-viewer.qdoc b/doc/qtcreator/src/howto/creator-only/creator-logging-viewer.qdoc
new file mode 100644
index 0000000000..963449be58
--- /dev/null
+++ b/doc/qtcreator/src/howto/creator-only/creator-logging-viewer.qdoc
@@ -0,0 +1,97 @@
+/****************************************************************************
+**
+** Copyright (C) 2022 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the Qt Creator documentation.
+**
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Free Documentation License Usage
+** Alternatively, this file may be used under the terms of the GNU Free
+** Documentation License version 1.3 as published by the Free Software
+** Foundation and appearing in the file included in the packaging of
+** this file. Please review the following information to ensure
+** the GNU Free Documentation License version 1.3 requirements
+** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
+**
+****************************************************************************/
+
+/*!
+    \page creator-logging-viewer.html
+    \if defined(qtdesignstudio)
+    \previouspage creator-quick-ui-forms.html
+    \else
+    \previouspage creator-task-lists.html
+    \endif
+    \nextpage creator-telemetry.html
+
+    \title Inspecting Internal Logs
+
+    You can inspect internal log messages of \QC at runtime without having to
+    restart it or configure the logging rules. Log messages are helpful when
+    you develop \QC, need to investigate some problem you are facing, or want
+    to take a look behind the scenes.
+
+    To open the log viewer and start collecting log information, select
+    \uicontrol Tools > \uicontrol {Debug \QC} > \uicontrol {Show Logs}.
+
+    \image qtcreator-logging-category-viewer.png
+
+    The viewer displays log messages from the selected logging categories.
+    If you have logging rules defined, they might be listed on startup.
+    Otherwise, the list of categories is extended while you are using \QC.
+
+    \note Messages are not cached, so the viewer displays only messages that
+    are recorded after you enabled a category.
+
+    \section1 Viewing Logs
+
+    To enable logging categories, select them in \uicontrol Category.
+    \uicontrol Type specifies the minimum level of messages to display from
+    the respective category. To change the minimum level, double-click the
+    type and select another value.
+
+    If you enable more than one category, you can specify different colors for
+    the messages in each category. Double-click the value of \uicontrol Color to
+    pick colors for the categories.
+
+    To store information about the currently enabled categories, select
+    \uicontrol {Save Enabled as Preset} in the context-menu. To load the
+    saved information, select \uicontrol {Update from Preset}.
+
+    To save the content of the displayed messages, select
+    \inlineimage icons/savefile.png
+    (\uicontrol {Save Log}). To copy all or selected messages, select
+    \uicontrol {Copy All} or \uicontrol {Copy Selected Logs} in the
+    context menu.
+
+    To clean the content of displayed messages select
+    \inlineimage icons/clean_pane_small.png
+    (\uicontrol Clear).
+
+    To temporarily stop logging, select \inlineimage icons/stop_small.png
+    (\uicontrol {Stop Logging}). To continue logging, select
+    \inlineimage icons/run_small.png
+    (\uicontrol {Start Logging}).
+
+    By default, logging categories and messages coming directly from Qt are
+    disabled. To display them, select \inlineimage icons/qtlogo-16.png
+    (\uicontrol {Toggle logging of Qt internal loggings.})
+
+    New messages automatically scroll the message display to the bottom.
+    To stop automatic scrolling, toggle \inlineimage icons/arrowdown.png
+    (\uicontrol {Auto Scroll}).
+
+    By default, messages are listed with a timestamp, without message
+    type. To hide and show this information, toggle
+    \inlineimage icons/stopwatch.png
+    (\uicontrol Timestamps) and \inlineimage icons/message.png
+    (\uicontrol {Message Types}).
+*/
diff --git a/doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc b/doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc
index cc61374e7c..e337a15573 100644
--- a/doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc
+++ b/doc/qtcreator/src/howto/creator-only/creator-task-lists.qdoc
@@ -32,7 +32,7 @@
 /*!
     \previouspage creator-editor-external.html
     \page creator-task-lists.html
-    \nextpage creator-telemetry.html
+    \nextpage creator-logging-viewer.html
 
     \title Showing Task List Files in Issues Pane
 
diff --git a/doc/qtcreator/src/howto/creator-telemetry.qdoc b/doc/qtcreator/src/howto/creator-telemetry.qdoc
index 8ae161c74e..23e01ca7b8 100644
--- a/doc/qtcreator/src/howto/creator-telemetry.qdoc
+++ b/doc/qtcreator/src/howto/creator-telemetry.qdoc
@@ -28,7 +28,7 @@
     \if defined(qtdesignstudio)
     \previouspage creator-quick-ui-forms.html
     \else
-    \previouspage creator-task-lists.html
+    \previouspage creator-logging-viewer.html
     \endif
     \nextpage collecting-usage-statistics.html
 
diff --git a/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc b/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc
index c5eb81598c..b64bc84267 100644
--- a/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc
+++ b/doc/qtcreator/src/overview/creator-only/creator-advanced.qdoc
@@ -1,6 +1,6 @@
 /****************************************************************************
 **
-** Copyright (C) 2021 The Qt Company Ltd.
+** Copyright (C) 2022 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the Qt Creator documentation.
@@ -95,6 +95,11 @@
             corresponding source code by clicking the error message or by using
             keyboard shortcuts.
 
+        \li \l{Inspecting Internal Logs}
+
+            You can inspect internal log messages of \QC. They may be
+            helpful when developing \QC or investigating problems.
+
         \li \l{Managing Data Collection}
 
             If you agreed to pseudonymous data collection during \QC
diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc
index bab4568bba..ed38c906cf 100644
--- a/doc/qtcreator/src/qtcreator-toc.qdoc
+++ b/doc/qtcreator/src/qtcreator-toc.qdoc
@@ -228,6 +228,7 @@
             \li \l{Keyboard Shortcuts}
             \li \l{Using External Tools}
             \li \l{Showing Task List Files in Issues Pane}
+            \li \l{Inspecting Internal Logs}
             \li \l{Managing Data Collection}
                 \list
                     \li \l {Collecting Usage Statistics}