Update CodeQL CLI manual (#52306)

github · Sep 18, 2024 · cb7352c · cb7352c
1 parent 7dac56a
commit cb7352c
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 10 deletions.
diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md
@@ -145,6 +145,11 @@ as a plain string.
 \[SARIF formats only] Produce pretty-printed SARIF output. By default,
 SARIF output is minified to reduce the size of the output file.
 
+#### `--sarif-run-property=<String=String>`
+
+\[SARIF formats only] A key value pair to add to the generated SARIF
+'run' property bag. Can be repeated.
+
 #### `--no-group-results`
 
 \[SARIF formats only] Produce one result per message, rather than one
@@ -197,11 +202,6 @@ Defaults to 1. You can pass 0 to use one thread per core on the machine,
 or -_N_ to leave _N_ cores unused (except still use at least one
 thread).
 
-#### `--sarif-run-property=<String=String>`
-
-\[SARIF only] A key value pair to add to the generated SARIF 'run'
-property bag. Can be repeated.
-
 #### `--column-kind=<columnKind>`
 
 \[SARIF only] The column kind used to interpret location columns. One

diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md b/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md
@@ -191,6 +191,11 @@ as a plain string.
 \[SARIF formats only] Produce pretty-printed SARIF output. By default,
 SARIF output is minified to reduce the size of the output file.
 
+#### `--sarif-run-property=<String=String>`
+
+\[SARIF formats only] A key value pair to add to the generated SARIF
+'run' property bag. Can be repeated.
+
 #### `--no-group-results`
 
 \[SARIF formats only] Produce one result per message, rather than one

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
@@ -101,8 +101,7 @@ The build mode that will be used to create the database.
 Choose your build mode based on the language you are analyzing:
 
 `none`: The database will be created without building the source root.
-Available for JavaScript/TypeScript, Python, and Ruby. Also available in
-beta for C# and Java.
+Available for C#, Java, JavaScript/TypeScript, Python, and Ruby.
 
 `autobuild`: The database will be created by attempting to automatically
 build the source root. Available for C/C++, C#, Go, Java/Kotlin, and

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
@@ -114,8 +114,7 @@ The build mode that will be used to create the database.
 Choose your build mode based on the language you are analyzing:
 
 `none`: The database will be created without building the source root.
-Available for JavaScript/TypeScript, Python, and Ruby. Also available in
-beta for C# and Java.
+Available for C#, Java, JavaScript/TypeScript, Python, and Ruby.
 
 `autobuild`: The database will be created by attempting to automatically
 build the source root. Available for C/C++, C#, Go, Java/Kotlin, and

diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md b/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md
@@ -153,6 +153,11 @@ as a plain string.
 \[SARIF formats only] Produce pretty-printed SARIF output. By default,
 SARIF output is minified to reduce the size of the output file.
 
+#### `--sarif-run-property=<String=String>`
+
+\[SARIF formats only] A key value pair to add to the generated SARIF
+'run' property bag. Can be repeated.
+
 #### `--no-group-results`
 
 \[SARIF formats only] Produce one result per message, rather than one

diff --git a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md b/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md
@@ -61,7 +61,7 @@ checkout path if it is omitted.
 #### `-f, --ref=<ref>`
 
 Name of the ref that was analyzed. If this ref is a pull request merge
-commit, then use _refs/pulls/1234/merge_ or _refs/pulls/1234/head_
+commit, then use _refs/pull/1234/merge_ or _refs/pull/1234/head_
 (depending on whether or not this commit corresponds to the HEAD or
 MERGE commit of the PR). Otherwise, this should be a branch:
 _refs/heads/branch-name_. If omitted, the CLI will attempt to