Skip to content

Commit 42f2fc2

Browse files
Apply suggestions from code review
Co-authored-by: Felicity Chapman <[email protected]>
1 parent 4d74282 commit 42f2fc2

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ About QL packs
66
QL packs are used to organize the files used in CodeQL analysis. They
77
contain queries, library files, query suites, and important metadata.
88

9-
The `CodeQL repository <https://github.com/github/codeql>`__ contains QL packs for
10-
C/C++, C#, Go, Java, JavaScript, Python, and Ruby.
9+
The `CodeQL repository <https://github.com/github/codeql>`__ contains standard QL packs for all supported languages.
1110
You can also make custom QL packs to contain your own queries and libraries.
1211

1312
QL pack structure

docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -193,8 +193,7 @@ further options on the command line.
193193
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
194194

195195
The `CodeQL repository <https://github.com/github/codeql>`__ contains
196-
the queries and libraries required for CodeQL analysis of C/C++, C#, Go, Java,
197-
JavaScript/TypeScript, Python, and Ruby.
196+
the queries and libraries required for CodeQL analysis of all supported languages.
198197
Clone a copy of this repository into ``codeql-home``.
199198

200199
By default, the root of the cloned repository will be called ``codeql``.
@@ -212,9 +211,9 @@ For Go analysis, run ``codeql-repo/go/scripts/install-deps.sh`` to install its d
212211
These have been moved to the ``github/codeql`` repository.
213212
It is no longer necessary to clone the ``github/codeql-go`` into a separate ``codeql-home/codeql-go`` folder.
214213

215-
For more information, see `this announcement <https://github.com/github/codeql-go/issues/741>`__.
214+
For more information, see the `Relocation announcement <https://github.com/github/codeql-go/issues/741>`__.
216215

217-
Within these repositories, the queries and libraries are organized into QL
216+
Within this repository, the queries and libraries are organized into QL
218217
packs. Along with the queries themselves, QL packs contain important metadata
219218
that tells the CodeQL CLI how to process the query files. For more information,
220219
see ":doc:`About QL packs <about-ql-packs>`."

docs/codeql/codeql-for-visual-studio-code/setting-up-codeql-in-visual-studio-code.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,15 +69,15 @@ There are two ways to do this:
6969
This ensures that the queries and libraries you write in VS Code also work in the query console on LGTM Enterprise.
7070

7171
If you prefer to add the CodeQL queries and libraries to an :ref:`existing workspace <existing-workspace>` instead of the starter workspace, then you should
72-
clone the appropriate branch of the `general CodeQL repository <https://github.com/github/codeql>`__ and add it to your workspace.
72+
clone the appropriate branch of the `CodeQL repository <https://github.com/github/codeql>`__ and add it to your workspace.
7373

7474
.. _starter-workspace:
7575

7676
Using the starter workspace
7777
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7878
The starter workspace is a Git repository. It contains:
7979

80-
* The `repository of CodeQL libraries and queries <https://github.com/github/codeql>`__ for C/C++, C#, Go, Java, JavaScript, Python, and Ruby. This is included as a submodule, so it can be updated without affecting your custom queries.
80+
* The `repository of CodeQL libraries and queries <https://github.com/github/codeql>`__ all supported languages. This is included as a submodule, so it can be updated without affecting your custom queries.
8181
* A series of folders named ``codeql-custom-queries-<language>``. These are ready for you to start developing your own custom queries for each language, using the standard libraries. There are some example queries to get you started.
8282

8383
To use the starter workspace:

0 commit comments

Comments
 (0)