hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: Felicity Chapman <felicitymay@github.com>
This commit is contained in:
Aditya Sharad
2022-05-23 10:55:50 -07:00
committed by GitHub
parent 4d74282175
commit 42f2fc2287
3 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
docs/codeql/codeql-cli/about-ql-packs.rst
View File

@@ -6,8 +6,7 @@ About QL packs
QL packs are used to organize the files used in CodeQL analysis. They
contain queries, library files, query suites, and important metadata.
The `CodeQL repository <https://github.com/github/codeql>`__ contains QL packs for
C/C++, C#, Go, Java, JavaScript, Python, and Ruby.
The `CodeQL repository <https://github.com/github/codeql>`__ contains standard QL packs for all supported languages.
You can also make custom QL packs to contain your own queries and libraries.
QL pack structure

7
docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst
View File

@@ -193,8 +193,7 @@ further options on the command line.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The `CodeQL repository <https://github.com/github/codeql>`__ contains
the queries and libraries required for CodeQL analysis of C/C++, C#, Go, Java,
JavaScript/TypeScript, Python, and Ruby.
the queries and libraries required for CodeQL analysis of all supported languages.
Clone a copy of this repository into ``codeql-home``.
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
These have been moved to the ``github/codeql`` repository.
It is no longer necessary to clone the ``github/codeql-go`` into a separate ``codeql-home/codeql-go`` folder.
For more information, see `this announcement <https://github.com/github/codeql-go/issues/741>`__.
For more information, see the `Relocation announcement <https://github.com/github/codeql-go/issues/741>`__.
Within these repositories, the queries and libraries are organized into QL
Within this repository, the queries and libraries are organized into QL
packs. Along with the queries themselves, QL packs contain important metadata
that tells the CodeQL CLI how to process the query files. For more information,
see ":doc:`About QL packs <about-ql-packs>`."

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

@@ -69,7 +69,7 @@ There are two ways to do this:
This ensures that the queries and libraries you write in VS Code also work in the query console on LGTM Enterprise.
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
clone the appropriate branch of the `general CodeQL repository <https://github.com/github/codeql>`__ and add it to your workspace.
clone the appropriate branch of the `CodeQL repository <https://github.com/github/codeql>`__ and add it to your workspace.
.. _starter-workspace:
@@ -77,7 +77,7 @@ Using the starter workspace
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
The starter workspace is a Git repository. It contains:
* 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.
* 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.
* 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.
To use the starter workspace: