diff --git a/docs/codeql/codeql-cli/about-codeql-packs.rst b/docs/codeql/codeql-cli/about-codeql-packs.rst index e4460370405..5f59e84c360 100644 --- a/docs/codeql/codeql-cli/about-codeql-packs.rst +++ b/docs/codeql/codeql-cli/about-codeql-packs.rst @@ -141,7 +141,7 @@ The following properties are supported in ``qlpack.yml`` files. upgrades: . - Core language packs only - - The path to a directory within the pack that contains database upgrade scripts, defined relative to the pack directory. Database upgrades are used internally to ensure a databasae created with a different version of the CodeQL CLI is compatible with the current version. + - The path to a directory within the pack that contains database upgrade scripts, defined relative to the pack directory. Database upgrades are used internally to ensure a database created with a different version of the CodeQL CLI is compatible with the current version. * - ``authors`` - .. code-block:: yaml @@ -275,7 +275,7 @@ Each of the languages in the CodeQL repository has four main CodeQL packs: Core library pack ~~~~~~~~~~~~~~~~~ -Here is an example ``qlpack.yml`` file for `C/C++ analysis libraries +Here is an example ``qlpack.yml`` file for the `C/C++ analysis libraries `__ core language pack: @@ -290,7 +290,7 @@ core language pack: Some extra notes on the following properties: - ``library``: Indicates that this is a library pack with no executable queries. It is only meant to be used as a dependency for other packs. -- ``dbscheme`` and ``upgrades``: Properties internal to the CodeQL CLI and should only be defined in the core QL pack for a language. +- ``dbscheme`` and ``upgrades``: These properties are internal to the CodeQL CLI and should only be defined in the core QL pack for a language. Core query pack diff --git a/docs/codeql/reusables/test-qlpack.rst b/docs/codeql/reusables/test-qlpack.rst index c2f96e84306..30315739c21 100644 --- a/docs/codeql/reusables/test-qlpack.rst +++ b/docs/codeql/reusables/test-qlpack.rst @@ -6,4 +6,4 @@ extractor: java tests: . -This ``qlpack.yml`` file states that ``my-github-user/my-query-tests`` depends on ``my-github-user/my-custom-queries`` at a version greater than or equal to 1.2.3 and less than 2.0.0. It also declares that the CLI should use the Java ``extractor`` when creating test databases. The ``tests: .`` line declares that all ``.ql`` files in the pack should be run as tests when ``codeql test run`` is run with the ``--strict-test-discovery`` option. Typically, test packs do not contain a ``version`` property. This prevents them from being inadvertently not published. +This ``qlpack.yml`` file states that ``my-github-user/my-query-tests`` depends on ``my-github-user/my-custom-queries`` at a version greater than or equal to 1.2.3 and less than 2.0.0. It also declares that the CLI should use the Java ``extractor`` when creating test databases. The ``tests: .`` line declares that all ``.ql`` files in the pack should be run as tests when ``codeql test run`` is run with the ``--strict-test-discovery`` option. Typically, test packs do not contain a ``version`` property. This prevents them from being inadvertently published.