Docs: Describe custom log directory setting in VS Code extension

This commit is contained in:
shati-patel
2021-05-21 21:41:09 +01:00
parent 7974e3ad38
commit 254c769089
2 changed files with 6 additions and 0 deletions

View File

@@ -46,6 +46,8 @@ The query history **Format** setting controls how the extension lists queries in
To override the default label, you can specify a different format for the query history items.
.. _configuring-settings-for-running-queries:
Configuring settings for running queries
-----------------------------------------
@@ -53,6 +55,8 @@ There are a number of settings for **Running Queries**. If your queries run too
.. include:: ../reusables/running-queries-debug.rst
To save CodeQL Query Server logs in a custom location, edit the **Running Queries: Custom Log Directory** setting. If you use a custom log directory, the extension doesn't automatically delete the CodeQL Query Server logs. This is useful if you want to investigate these logs to improve the performance of your queries.
Configuring settings for testing queries
-----------------------------------------

View File

@@ -38,6 +38,8 @@ You are most likely to need to restart the query server if you make external cha
To see the logs from running a particular query, right-click the query in the Query History and select **Show Query Log**.
If the log file is too large for the extension to open in the VS Code editor, the file will be displayed in your file explorer so you can open it with an external program.
By default, the extension deletes logs after each workspace session. To override this behavior, you can specify a custom directory for query server logs. For more information, see ":ref:`Customizing settings <configuring-settings-for-running-queries>`."
Exploring problems with running tests
----------------------------------------------