Skip to content

Commit 070554e

Browse files
committed
Update description of 'suites'
1 parent de5d14d commit 070554e

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/codeql/codeql-cli/about-codeql-packs.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The following properties are supported in ``qlpack.yml`` files.
7373
* - ``suites``
7474
- ``octo-org-query-suites``
7575
- Optional
76-
- The path to a directory that contains the "well-known" query suites in the pack, defined relative to the pack directory. You can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. For more information about query suites, see ":doc:`Creating CodeQL query suites <creating-codeql-query-suites>`."
76+
- The path to a directory in the pack that contains the query suites you want to make known to the CLI, defined relative to the pack directory. QL pack users can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. This is not supported for CodeQL packs downloaded from a package registry. For more information about query suites, see ":doc:`Creating CodeQL query suites <creating-codeql-query-suites>`."
7777
* - ``extractor``
7878
- ``javascript``
7979
- All test packs

docs/codeql/codeql-cli/about-ql-packs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ The following properties are supported in ``qlpack.yml`` files.
8787
* - ``suites``
8888
- ``suites``
8989
- Optional
90-
- The path to a directory that contains the "well-known" query suites in the pack, defined relative to the pack directory. You can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. To use query suites stored in other directories in the pack, you must provide their full path. For more information about query suites, see ":doc:`Creating CodeQL query suites <creating-codeql-query-suites>`."
90+
- The path to a directory in the pack that contains the query suites you want to make known to the CLI, defined relative to the pack directory. QL pack users can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. For more information about query suites, see ":doc:`Creating CodeQL query suites <creating-codeql-query-suites>`."
9191
* - ``extractor``
9292
- ``javascript``
9393
- All test packs
@@ -124,7 +124,7 @@ A custom QL pack for queries must include a ``qlpack.yml`` file at
124124
the pack root, containing ``name``, ``version``,
125125
and ``libraryPathDependencies`` properties. If the pack contains query suites, you can
126126
use the ``suites`` property to define their location. Query suites defined
127-
here are called "well-known" suites, and can be used on the command line by referring to
127+
here are called "known" suites, and can be used on the command line by referring to
128128
their name only, rather than their full path.
129129
For more information about query suites, see ":doc:`Creating CodeQL query suites <creating-codeql-query-suites>`."
130130

0 commit comments

Comments
 (0)