1
0
mirror of synced 2025-12-22 19:34:15 -05:00

Fix heading-increment violations (#43054)

This commit is contained in:
Rachael Sewell
2023-09-25 16:44:48 -07:00
committed by GitHub
parent 07f481fbe7
commit d9db1c32f2
80 changed files with 98 additions and 98 deletions

View File

@@ -37,7 +37,7 @@ The decoded output will be written to standard output, unless the
## Primary options
#### `<file>`
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] BQRS file to decode.

View File

@@ -34,7 +34,7 @@ Compute the difference between two result sets.
## Primary options
#### `<file1>`
#### `<file1>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] First BQRS file to compare.

View File

@@ -34,7 +34,7 @@ codeql bqrs hash <options>... -- <file>
## Primary options
#### `<file>`
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] BQRS file to hash.

View File

@@ -42,7 +42,7 @@ options of [codeql bqrs decode](/code-security/codeql-cli/codeql-cli-manual/bqrs
## Primary options
#### `<file>`
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] BQRS file to show information about.

View File

@@ -37,7 +37,7 @@ metadata and generates output in the specified format.
## Primary options
#### `<bqrs-file>`
#### `<bqrs-file>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The BQRS file to interpret.

View File

@@ -36,7 +36,7 @@ Available since `v2.12.6`.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database to bundle.

View File

@@ -45,7 +45,7 @@ being interpreted as source-code alerts, use
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database to query.

View File

@@ -38,7 +38,7 @@ that results, logs, TRAP, or similar should be included.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database to bundle.

View File

@@ -37,7 +37,7 @@ possible on disk without degrading its future usefulness.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database to clean up.

View File

@@ -37,7 +37,7 @@ one of the CodeQL products.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database to create. This directory will
be created, and _must not_ already exist (but its parent must).

View File

@@ -39,7 +39,7 @@ Available since `v2.12.6`.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database under construction. This must
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).

View File

@@ -36,7 +36,7 @@ Finalize a database that was created with [codeql database init](/code-security/
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database under construction. This must
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).

View File

@@ -50,7 +50,7 @@ meaningful.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database under construction. This must
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).

View File

@@ -49,7 +49,7 @@ patterns, which can use the following wildcard characters:
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database under construction. This must
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).

View File

@@ -43,7 +43,7 @@ extractors in the middle of an extraction operation anyway.)
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database to create. This directory will
be created, and _must not_ already exist (but its parent must).

View File

@@ -40,7 +40,7 @@ directory using [codeql database run-queries](/code-security/codeql-cli/codeql-c
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database that has been queried.

View File

@@ -45,7 +45,7 @@ source root.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database under construction. This must
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).

View File

@@ -45,7 +45,7 @@ Alternatively, if you have only a single query to run, you might prefer
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database to query.

View File

@@ -38,7 +38,7 @@ database.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database under construction. This must
have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init).

View File

@@ -36,7 +36,7 @@ This command extracts a CodeQL database archive created by [codeql database bund
## Primary options
#### `<archive>`
#### `<archive>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database archive to unzip.

View File

@@ -41,7 +41,7 @@ was created.
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the CodeQL database to upgrade.

View File

@@ -39,7 +39,7 @@ rule out issues in the underlying data as the cause.
## Primary options
#### `<dataset>`
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the raw QL dataset to check.

View File

@@ -37,7 +37,7 @@ will make it impossible to import further data into the dataset.
## Primary options
#### `<dataset>`
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the raw QL dataset to clean up.

View File

@@ -39,7 +39,7 @@ initial import.
## Primary options
#### `<dataset>`
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the raw QL dataset to create or update. The
directory will be created if it doesn't already exist.

View File

@@ -42,7 +42,7 @@ optimizer.
## Primary options
#### `<dataset>`
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the raw QL dataset to measure.

View File

@@ -37,7 +37,7 @@ This does the same as
## Primary options
#### `<dataset>`
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the raw QL dataset to upgrade.

View File

@@ -36,7 +36,7 @@ Available since `v2.12.6`.
## Primary options
#### `--markdown-message=<markdownMessage>`
#### `--markdown-message=<markdownMessage>` <!-- markdownlint-disable-line heading-increment -->
Message for the diagnostic, in GitHub-flavored Markdown format.

View File

@@ -36,7 +36,7 @@ Available since `v2.12.6`.
## Primary options
#### `--format=<format>`
#### `--format=<format>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The format in which to write the results. One of:

View File

@@ -39,7 +39,7 @@ and output streams.
## Primary options
#### `--check-errors=<checkErrors>`
#### `--check-errors=<checkErrors>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] How to check errors. One of: ON\_CHANGE, EXPLICIT.

View File

@@ -37,7 +37,7 @@ This command should not normally be invoked directly. Instead use either
## Primary options
#### `<dataset>`
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the raw QL dataset to query.

View File

@@ -41,7 +41,7 @@ Available since `v2.10.11`.
## Primary options
#### `--[no-]tuple-counting`
#### `--[no-]tuple-counting` <!-- markdownlint-disable-line heading-increment -->
\[Advanced] Display tuple counts for each evaluation step in the query
evaluator logs. If the `--evaluator-log` option is provided, tuple

View File

@@ -40,7 +40,7 @@ an error will be reported.
## Primary options
#### `<dataset>`
#### `<dataset>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the raw QL dataset to upgrade.

View File

@@ -34,7 +34,7 @@ found in the given pack.
## Primary options
#### `<pack-root-dir>`
#### `<pack-root-dir>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The pack root directory for which we are reporting
extensible predicate metadata.

View File

@@ -41,7 +41,7 @@ event logs directly.
## Primary options
#### `<input>`
#### `<input>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the event log file to produce a summary of.

View File

@@ -34,7 +34,7 @@ Generate end-user query help from .qhelp files.
## Primary options
#### `<qhelpdir|suite>...`
#### `<qhelpdir|suite>...` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Query help files to render. Each argument is one of:

View File

@@ -44,7 +44,7 @@ This token must have the `security_events` scope.
## Primary options
#### `-s, --sarif=<file>`
#### `-s, --sarif=<file>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Path to the SARIF file to upload. This should be the
output of [codeql database analyze](/code-security/codeql-cli/codeql-cli-manual/database-analyze) (or [codeql database interpret-results](/code-security/codeql-cli/codeql-cli-manual/database-interpret-results)) with `--format sarif-latest` for upload to github.com or

View File

@@ -42,7 +42,7 @@ Available since `v2.6.0`.
## Primary options
#### `<scope/name[@range]>...`
#### `<scope/name[@range]>...` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The scope, name, and optional version range of the pack to
add to the dependency list.

View File

@@ -39,7 +39,7 @@ Available since `v2.6.3`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package.

View File

@@ -50,7 +50,7 @@ Available since `v2.12.4`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package.

View File

@@ -43,7 +43,7 @@ Available since `v2.6.0`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package.

View File

@@ -44,7 +44,7 @@ Available since `v2.6.0`.
## Primary options
#### `<scope/name[@version]|suite.qls>...`
#### `<scope/name[@version]|suite.qls>...` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] List of CodeQL packs and query suites to download. If a
query suite is provided, its instructions will be inspected and all

View File

@@ -39,7 +39,7 @@ Available since `v2.6.0`.
## Primary options
#### `<package-name>`
#### `<package-name>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The scope and name of the pack to create. Scope is only
required if this pack is to be published.

View File

@@ -46,7 +46,7 @@ Available since `v2.6.0`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package.

View File

@@ -41,7 +41,7 @@ Available since `v2.7.1`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package or workspace, defaults to the current
working directory. If this parameter points to a directory containing a

View File

@@ -43,7 +43,7 @@ Available since `v2.6.0`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package.

View File

@@ -39,7 +39,7 @@ Available since `v2.6.0`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package or workspace, defaults to the current
working directory. If this parameter points to a directory containing a

View File

@@ -42,7 +42,7 @@ Available since `v2.6.0`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package.

View File

@@ -43,7 +43,7 @@ Available since `v2.6.3`.
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The root directory of the package.

View File

@@ -39,7 +39,7 @@ output options are mostly for debugging.
## Primary options
#### `<file>...`
#### `<file>...` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Queries to compile. Each argument is one of:

View File

@@ -40,7 +40,7 @@ option is specified.
## Primary options
#### `<file>`
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] QLO file to read from.

View File

@@ -34,7 +34,7 @@ Autoformat QL source code.
## Primary options
#### `<file>...`
#### `<file>...` <!-- markdownlint-disable-line heading-increment -->
One or more `.ql` or `.qll` source files to autoformat. A dash can be
specified to read from standard input.

View File

@@ -49,7 +49,7 @@ To run multiple queries in parallel, see [codeql database run-queries](/code-sec
## Primary options
#### `<file.ql>`
#### `<file.ql>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] QL source of the query to execute.

View File

@@ -34,7 +34,7 @@ codeql resolve database <options>... -- <database>
## Primary options
#### `<database>`
#### `<database>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The database for which to load the metadata.

View File

@@ -42,7 +42,7 @@ Available since `v2.13.3`.
## Primary options
#### `<pack>...`
#### `<pack>...` <!-- markdownlint-disable-line heading-increment -->
The path to the root of the packs to resolve extensions for.

View File

@@ -41,7 +41,7 @@ specifiers passed in as command line arguments.
## Primary options
#### `<querysuite|pack>...`
#### `<querysuite|pack>...` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Queries to execute. Each argument is in the form
`scope/name@range:path` where:

View File

@@ -37,7 +37,7 @@ language.
## Primary options
#### `-l, --language=<lang>`
#### `-l, --language=<lang>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The name of the extractor to locate.

View File

@@ -50,7 +50,7 @@ patterns, which can use the following wildcard characters:
## Primary options
#### `<dir>`
#### `<dir>` <!-- markdownlint-disable-line heading-increment -->
The directory to be searched.

View File

@@ -40,7 +40,7 @@ format an appropriate error message.
## Primary options
#### `--search-path=<dir>[:<dir>...]`
#### `--search-path=<dir>[:<dir>...]` <!-- markdownlint-disable-line heading-increment -->
A list of directories under which extractor packs may be found. The
directories can either be the extractor packs themselves or directories

View File

@@ -48,7 +48,7 @@ change without much notice as the QL language ecosystem evolves.**
## Primary options
#### `--[no-]find-extractors`
#### `--[no-]find-extractors` <!-- markdownlint-disable-line heading-increment -->
\[Advanced] Include in the output a summary of `extractor` fields from
the QL packs that the query depends on. This is used only for a few rare

View File

@@ -37,7 +37,7 @@ query source file.
## Primary options
#### `<file>`
#### `<file>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Query source file from which to extract metadata.

View File

@@ -43,7 +43,7 @@ This command is deprecated. Use [codeql resolve extensions](/code-security/codeq
## Primary options
#### `<querysuite|pack>...`
#### `<querysuite|pack>...` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Queries to execute. Each argument is in the form
`scope/name@range:path` where:

View File

@@ -43,7 +43,7 @@ an error message.
## Primary options
#### `--search-path=<dir>[:<dir>...]`
#### `--search-path=<dir>[:<dir>...]` <!-- markdownlint-disable-line heading-increment -->
A list of directories under which QL packs may be found. Each directory
can either be a QL pack (or bundle of packs containing a

View File

@@ -36,7 +36,7 @@ Accepts a .qlref file and returns the .ql file that it points to.
## Primary options
#### `<qlref>`
#### `<qlref>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] .qlref file to dereference.

View File

@@ -43,7 +43,7 @@ list of queries.
## Primary options
#### `<querysuite|pack>...`
#### `<querysuite|pack>...` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] Queries to execute. Each argument is in the form
`scope/name@range:path` where:

View File

@@ -43,7 +43,7 @@ desired _total_ RAM amount.
## Primary options
#### `--format=<fmt>`
#### `--format=<fmt>` <!-- markdownlint-disable-line heading-increment -->
Select output format. Choices include:

View File

@@ -38,7 +38,7 @@ individual .ql and .qlref files to execute.
## Primary options
#### `<test|dir>...`
#### `<test|dir>...` <!-- markdownlint-disable-line heading-increment -->
Each argument is one of:

View File

@@ -41,7 +41,7 @@ in extraordinary cases where exact control is needed.
## Primary options
#### `--dbscheme=<file>`
#### `--dbscheme=<file>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The _current_ dbscheme of the dataset we want to upgrade.

View File

@@ -46,7 +46,7 @@ results of _failing_ tests from a previous run.
## Primary options
#### `<test|dir>...`
#### `<test|dir>...` <!-- markdownlint-disable-line heading-increment -->
Each argument is one of:

View File

@@ -38,7 +38,7 @@ execute test queries against.
## Primary options
#### `<testDir>`
#### `<testDir>` <!-- markdownlint-disable-line heading-increment -->
\[Mandatory] The path to the test directory.

View File

@@ -34,7 +34,7 @@ Run unit tests for QL queries.
## Primary options
#### `<test|dir>...`
#### `<test|dir>...` <!-- markdownlint-disable-line heading-increment -->
Each argument is one of:

View File

@@ -34,7 +34,7 @@ Show the version of the CodeQL toolchain.
## Primary options
#### `--format=<fmt>`
#### `--format=<fmt>` <!-- markdownlint-disable-line heading-increment -->
Select output format. Choices include `text` _(default)_ ,`terse`, and
`json`.