Skip to content

Commit f737e07

Browse files
aeisenbergDave Bartolomeo
andauthored
Apply suggestions from code review
Co-authored-by: Dave Bartolomeo <dbartol@github.com>
1 parent 2ad0b28 commit f737e07

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ find query suite definitions.
4444

4545
The contents of the CodeQL pack (queries or libraries used in CodeQL analysis) is included in the same directory as ``qlpack.yml``, or its subdirectories.
4646

47-
The location of ``qlpack.yml`` defines the library path for the content of the CodeQL pack. That is, for all ``.ql`` and ``.qll`` files in the pack, CodeQL will resolve all import statements relative to the ``qlpack.yml`` at the pack's root.
47+
The directory containing the ``qlpack.yml`` file serves as the root directory for the content of the CodeQL pack. That is, for all ``.ql`` and ``.qll`` files in the pack, CodeQL will resolve all import statements relative to the directory containing ``qlpack.yml`` at the pack's root.
4848

4949
.. _codeqlpack-yml-properties:
5050

@@ -119,14 +119,14 @@ The following properties are supported in ``qlpack.yml`` files.
119119

120120
extractor: javascript
121121

122-
- All test packs
123-
- The CodeQL language extractor to use when the CLI creates a database in the pack. For more information about testing queries, see ":doc:`Testing custom queries <testing-custom-queries>`."
122+
- All packs containing CodeQL tests
123+
- The CodeQL language extractor to use when running the CodeQL tests in the pack. For more information about testing queries, see ":doc:`Testing custom queries <testing-custom-queries>`."
124124
* - ``tests``
125125
- .. code-block:: yaml
126126

127127
tests: .
128128

129-
- Optional for test packs. Ignored for non-test packs.
129+
- Optional for packs containing CodeQL tests. Ignored for packs without tests.
130130
- The path to a directory within the pack that contains tests, defined relative to the pack directory. Use ``.`` to specify the whole pack. Any queries in this directory are run as tests when ``test run`` is run with the ``--strict-test-discovery`` option. These queries are ignored by query suite definitions that use ``queries`` or ``qlpack`` instructions to ask for all queries in a particular pack. If this property is missing, then ``.`` is assumed.
131131
* - ``dbscheme``
132132
- .. code-block:: yaml
@@ -176,7 +176,7 @@ The following properties are supported in ``qlpack.yml`` files.
176176
About ``codeql-pack.lock.yml`` files
177177
------------------------------------
178178

179-
``codeql-pack.lock.yml`` files store the versions of the resolved transitive dependencies of a CodeQL pack. This file is created by the ``codeql pack install`` if it does not already exist and should be added to your version control system. The ``dependencies`` section of the ``qlpack.yml`` file contains version ranges that are compatible with the pack. The ``codeql-pack.lock.yml`` file locks the versions to precise dependencies. This ensures that anyone running ``codeql pack install`` on this the pack will always retrieve the same versions of dependencies even if newer compatible versions exist. Only query packs can have ``codeql-pack.lock.yml`` files. This is because library packs are not compiled independently of query packs. Without being compiled, there is no need to specify precise versions of their dependencies.
179+
``codeql-pack.lock.yml`` files store the versions of the resolved transitive dependencies of a CodeQL pack. This file is created by the ``codeql pack install`` command if it does not already exist and should be added to your version control system. The ``dependencies`` section of the ``qlpack.yml`` file contains version ranges that are compatible with the pack. The ``codeql-pack.lock.yml`` file locks the versions to precise dependencies. This ensures that anyone running ``codeql pack install`` on this the pack will always retrieve the same versions of dependencies even if newer compatible versions exist.
180180

181181
For example, if a ``qlpack.yml`` file contains the following dependencies:
182182

0 commit comments

Comments
 (0)