Skip to content

Commit 457ece1

Browse files
committed
Fix list formatting
1 parent 5bfe0ff commit 457ece1

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

docs/codeql/codeql-cli/extractor-options.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Each extractor defines its own set of configuration options. To find out which o
3737
}
3838
}
3939

40-
The extractor option names and descriptions are listed under ``extractor_options``. Each option may contain the following fields::
40+
The extractor option names and descriptions are listed under ``extractor_options``. Each option may contain the following fields:
4141

42-
- ``title`` (required): The title of the option
43-
- ``description`` (required): The description of the option
44-
- ``type`` (required): The type of the option, which can be
42+
* ``title`` (required): The title of the option
43+
* ``description`` (required): The description of the option
44+
* ``type`` (required): The type of the option, which can be
4545

4646
* ``string``: indicating that the option can have a single string value
4747
* ``array``: indicating that the option can have a sequence of string values
@@ -50,22 +50,22 @@ The extractor option names and descriptions are listed under ``extractor_options
5050
* ``pattern`` (optional): The regular expression patterns that all values of the option should match. Note that the extractor may impose additional constraints on option values that are not or cannot be expressed in this regular expression pattern. Such constraints, if they exist, would be explained under the description field.
5151
* ``properties`` (optional): A map from extractor option names in the option group to the corresponding extractor option descriptions. This field can only be present for option groups. For example, options of ``object`` type.
5252

53-
In the example above, the extractor declares two options::
53+
In the example above, the extractor declares two options:
5454

5555
* ``option1`` is a ``string`` option with value matching ``[a-z]+``
5656
* ``group1.option2`` is an ``array`` option with values matching ``[1-9][0-9]*``
5757

5858
Setting extractor options with the CodeQL CLI
5959
---------------------------------------------
6060

61-
The CodeQL CLI supports setting extractor options in subcommands that directly or indirectly invoke extractors. These commands are::
61+
The CodeQL CLI supports setting extractor options in subcommands that directly or indirectly invoke extractors. These commands are:
6262

6363
* ``codeql database create``
6464
* ``codeql database start-tracing``
6565
* ``codeql database trace-command``
6666
* ``codeql database index-files``
6767

68-
When running these subcommands, you can set extractor options with the ``--extractor-option`` CLI option. For example::
68+
When running these subcommands, you can set extractor options with the ``--extractor-option`` CLI option. For example:
6969

7070
* ``codeql database create --extractor-option java.option1=abc ...``
7171
* ``codeql database start-tracing --extractor-option java.group1.option2=102 ...``
@@ -76,7 +76,7 @@ Using ``--extractor-option`` to assign an extractor option that does not exist i
7676

7777
The CodeQL CLI accepts multiple ``--extractor-option`` options in the same invocation. If you set a ``string`` extractor option multiple times, the last option value overwrites all previous ones. If you set an `array` extractor option multiple times, all option values are concatenated in order.
7878

79-
You can also specify extractor option names without the extractor name. For example::
79+
You can also specify extractor option names without the extractor name. For example:
8080

8181
* ``codeql database create --extractor-option option1=abc ...``
8282
* ``codeql database start-tracing --extractor-option group1.option2=102 ...``
@@ -86,7 +86,7 @@ If you do not specify an extractor name, the extractor option settings will appl
8686
Setting extractor options from files
8787
------------------------------------
8888

89-
You can also set extractor options through a file. The CodeQL CLI subcommands that accept ``--extractor-option`` also accept ``--extractor-options-file``, which has a required argument of the path to a YAML file (with extension ``.yaml`` or ``.yml``) or a JSON file (with extension ``.json``). For example::
89+
You can also set extractor options through a file. The CodeQL CLI subcommands that accept ``--extractor-option`` also accept ``--extractor-options-file``, which has a required argument of the path to a YAML file (with extension ``.yaml`` or ``.yml``) or a JSON file (with extension ``.json``). For example:
9090

9191
# ``codeql database create --extractor-options-file options.yml ...``
9292
# ``codeql database start-tracing --extractor-options-file options.json ...``
@@ -132,7 +132,7 @@ Assigning an extractor option that does not exist is an error. You can make the
132132
__allow_unknown_properties: true
133133
option2: [ 102 ]
134134

135-
You can specify ``--extractor-options-file`` multiple times. The extractor option assignments are processed in the following order::
135+
You can specify ``--extractor-options-file`` multiple times. The extractor option assignments are processed in the following order:
136136

137137
# All extractor option files specified by ``--extractor-options-file`` are processed in the order they appear on the command line, then
138138
# All extractor option assignments specified by ``--extractor-option`` are processed in the order they appear on the command line

0 commit comments

Comments
 (0)