doc: add debugging section to troubleshooting

dlech · May 4, 2024 · 68fda66 · 68fda66
1 parent 2c62bd9
commit 68fda66
Show file tree

Hide file tree

Showing 6 changed files with 42 additions and 0 deletions.
diff --git a/doc/images/vs-attach-to-process-keepass.png b/doc/images/vs-attach-to-process-keepass.png
diff --git a/doc/images/vs-attach.png b/doc/images/vs-attach.png
diff --git a/doc/images/vs-continue-without-code.png b/doc/images/vs-continue-without-code.png
diff --git a/doc/images/vs-dotnet-desktop-development.png b/doc/images/vs-dotnet-desktop-development.png
diff --git a/doc/images/vs-output-tab.png b/doc/images/vs-output-tab.png
diff --git a/doc/troubleshooting.rst b/doc/troubleshooting.rst
@@ -80,3 +80,45 @@ Report your issues on `GitHub`_ (preferred) or send me a `message`_.
 
 .. _`GitHub`: https://github.com/dlech/keeagent/issues
 .. _`message`: https://lechnology.com/contact
+
+
+Debugging
+=========
+
+You can use Visual Studio to see a limited amount of debug information.
+
+Prerequisite: `Visual Studio 2022 <https://visualstudio.microsoft.com/vs/>`_
+with the *.NET desktop development* workload installed.
+
+    .. figure:: images/vs-dotnet-desktop-development.png
+        :alt: screenshot of Visual Studio Installer with .NET desktop development workload selected
+
+1. Start *KeePass*.
+
+2. Start *Visual Studio*.
+
+3. Select *Continue without code*.
+
+    .. figure:: images/vs-continue-without-code.png
+        :alt: screenshot of Visual Studio 2022 start screen "Continue without code" hyperlink
+
+4. Click the *Attach* button.
+
+    .. figure:: images/vs-attach.png
+        :alt: screenshot of Visual Studio 2022 start screen "Attach" button
+
+5. Select *KeePass* from the list of processes. Use the filter to find it quickly.
+
+    .. figure:: images/vs-attach-to-process-keepass.png
+        :alt: screenshot of Visual Studio 2022 "Attach to Process" dialog with "KeePass.exe" selected.
+
+6. Click the *Attach* button.
+
+7. Select the *Output* tab.
+
+        .. figure:: images/vs-output-tab.png
+            :alt: screenshot of Visual Studio 2022 "Output" tab
+
+8. Reproduce the issue in KeePass/KeeAgent.
+
+9. Look for any useful information in the *Output* tab.