From 68ce233e621228f78fc2ae5a4737e238599816dc Mon Sep 17 00:00:00 2001 From: docs-bot <77750099+docs-bot@users.noreply.github.com> Date: Thu, 11 Jul 2024 01:45:51 -0700 Subject: [PATCH] Update CodeQL CLI manual (#51557) Co-authored-by: Felicity Chapman --- .../codeql-cli-manual/database-bundle.md | 14 ++++++++++---- .../codeql-cli-manual/database-create.md | 11 +++++++++-- .../codeql-cli/codeql-cli-manual/database-init.md | 11 +++++++++-- 3 files changed, 28 insertions(+), 8 deletions(-) diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md b/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md index d44005eecb..6ff34e8a50 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md @@ -47,24 +47,30 @@ that results, logs, TRAP, or similar should be included. \[Mandatory] The output file, typically with the extension ".zip". -#### `--include-diagnostics` +#### `--[no-]include-diagnostics` Include diagnostics in the bundle. Available since `v2.16.0`. -#### `--include-results` +#### `--[no-]include-results` Include any precomputed query results in the bundle. -#### `--include-temp` +#### `--[no-]include-logs` + +Include the logs directory in the bundle. + +Available since `v2.17.6`. + +#### `--[no-]include-temp` Includes the "temp" directory, where any generated packs, queries, and suites are located. Available since `v2.13.3`. -#### `--include-uncompressed-source` +#### `--[no-]include-uncompressed-source` Include an uncompressed version of the source archive directory. This is necessary for legacy CodeQL plugins (like CodeQL for Eclipse). diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md b/content/code-security/codeql-cli/codeql-cli-manual/database-create.md index 3e1de32e3f..5ae01ed0ef 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-create.md @@ -54,8 +54,15 @@ Maven project would not be a suitable choice. #### `--[no-]overwrite` \[Advanced] If the database already exists, delete it and proceed with -this command instead of failing. This option should be used with caution -as it may recursively delete the entire database directory. +this command instead of failing. If the directory exists, but it does +not look like a database, an error will be thrown. + +#### `--[no-]force-overwrite` + +\[Advanced] If the database already exists, delete it even if it does +not look like a database and proceed with this command instead of +failing. This option should be used with caution as it may recursively +delete the entire database directory. #### `--codescanning-config=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md b/content/code-security/codeql-cli/codeql-cli-manual/database-init.md index 08ec630707..628b65a9f8 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-init.md @@ -67,8 +67,15 @@ referred to by their relative path from this directory. #### `--[no-]overwrite` \[Advanced] If the database already exists, delete it and proceed with -this command instead of failing. This option should be used with caution -as it may recursively delete the entire database directory. +this command instead of failing. If the directory exists, but it does +not look like a database, an error will be thrown. + +#### `--[no-]force-overwrite` + +\[Advanced] If the database already exists, delete it even if it does +not look like a database and proceed with this command instead of +failing. This option should be used with caution as it may recursively +delete the entire database directory. #### `--codescanning-config=`