Expand documentation to cover the generalized system information view

KDAB · Jun 25, 2018 · 95f59a0 · 95f59a0
1 parent 988abb2
commit 95f59a0
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 8 deletions.
diff --git a/docs/manual/gammaray-codec-browser.qdoc b/docs/manual/gammaray-codec-browser.qdoc
@@ -18,7 +18,7 @@
 /*!
     \contentspage {Tools}
     \previouspage {Network}
-    \nextpage {Standard Paths}
+    \nextpage {System Information}
     \page gammaray-codec-browser.html
 
     \title Text Codecs

diff --git a/docs/manual/gammaray-manual.qdoc b/docs/manual/gammaray-manual.qdoc
@@ -93,7 +93,7 @@
             \li \l{Mime Types}
             \li \l{Network}
             \li \l{Text Codecs}
-            \li \l{Standard Paths}
+            \li \l{System Information}
         \endlist
         \li \l{Object Inspection}
         \list

diff --git a/docs/manual/gammaray-object-inspection.qdoc b/docs/manual/gammaray-object-inspection.qdoc
@@ -17,7 +17,7 @@
 
 /*!
     \contentspage {GammaRay User Manual}
-    \previouspage {Standard Paths}
+    \previouspage {System Information}
     \nextpage {Properties}
     \page gammaray-object-inspection.html
 

diff --git a/docs/manual/gammaray-standard-paths.qdoc b/docs/manual/gammaray-standard-paths.qdoc
@@ -16,20 +16,38 @@
 */
 
 /*!
-    \contentspage {Standard Paths}
+    \contentspage {System Information}
     \previouspage {Text Codecs}
     \nextpage {Object Inspection}
     \page gammaray-standard-paths.html
 
-    \title Standard Paths
+    \title System Information
 
     \section1 Overview
 
-    The standard paths view provides access to the infromation of QStandardPaths. For each
+    The system information view shows a number of information about the environment the
+    inspected application runs in, such as the used Qt build, the standard paths and the
+    environment variables.
+
+    \section2 Qt Installation
+
+    The \uicontrol Qt tab shows information about the Qt build used by the inspected application.
+    This includes the version as well as information about the build configuration and architecture,
+    as well as the installation location of Qt. You can also find details about the platform the
+    application runs on (OS, version, architecture, etc) here. All information here is retrieved
+    via QLibraryInfo and QSysInfo and therefore reflects Qt's view.
+
+    \section2 Standard Paths
+
+    The standard paths view provides access to the information of QStandardPaths. For each
     standard location (see QStandardPaths::StandardLocation) it shows the readable and writable
     locations as seen by the target process.
 
     \image gammaray-standard-paths.png
 
+    \section2 Environment Variables
+
+    The \uicontrol Environment tab shows a table of all environment variables and their corresponding
+    value, as seen by QProcessEnvironment::systemEnvironment() in the target process.
 */
 
diff --git a/docs/manual/gammaray-tools.qdoc b/docs/manual/gammaray-tools.qdoc
@@ -80,6 +80,6 @@
         \li \l{Mime Types}
         \li \l{Network}
         \li \l{Text Codecs}
-        \li \l{Standard Paths}
+        \li \l{System Information}
     \endlist
 */
diff --git a/docs/manual/style/qt5-sidebar.html b/docs/manual/style/qt5-sidebar.html
@@ -42,6 +42,6 @@ <h2>Tools</h2>
         <li><a href="gammaray-mime-types.html">Mime Types</a></li>
         <li><a href="gammaray-network.html">Network</a></li>
         <li><a href="gammaray-codec-browser.html">Text Codecs</a></li>
-        <li><a href="gammaray-standard-paths.html">Standard Paths</a></li>
+        <li><a href="gammaray-standard-paths.html">System</a></li>
     </ul>
 </div>