mirror of
https://github.com/github/codeql.git
synced 2026-04-30 19:26:02 +02:00
docs: fix a few more links
This commit is contained in:
@@ -1,7 +1,7 @@
|
||||
What's in a CodeQL database?
|
||||
============================
|
||||
|
||||
A CodeQL database contains a variety of data related to a particular code base at a particular point in time. For details of how the database is generated see `Database generation <https://lgtm.com/help/lgtm/generate-database>`__.
|
||||
A CodeQL database contains a variety of data related to a particular code base at a particular point in time. For details of how the database is generated see `Database generation <https://lgtm.com/help/lgtm/generate-database>`__ on LGTM.com.
|
||||
|
||||
The database contains a full, hierarchical representation of the program defined by the code base. The database schema varies according to the language analyzed. The schema provides an interface between the initial lexical analysis during the extraction process, and the actual complex analysis using CodeQL. When the source code languages being analyzed change (such as Java 7 evolving into Java 8), this interface between the analysis phases can also change.
|
||||
|
||||
|
||||
@@ -115,7 +115,7 @@ To simplify the query, we can introduce a class ``SmallInt`` representing the in
|
||||
➤ `See this in the query console on LGTM.com <https://lgtm.com/query/2101340747/>`__
|
||||
|
||||
Now that you've seen some general examples, let's use the CodeQL libraries to analyze projects.
|
||||
In particular, LGTM generates a database representing the code and then CodeQL is used to query this database. See `Database generation <https://lgtm.com/help/lgtm/generate-database>`__ for more details on how the database is built.
|
||||
In particular, LGTM generates a database representing the code and then CodeQL is used to query this database. For more information, ee `Database generation <https://lgtm.com/help/lgtm/generate-database>`__ on LGTM.com.
|
||||
|
||||
.. XX: Perhaps a link to the "CodeQL libraries for X"?
|
||||
|
||||
|
||||
@@ -55,7 +55,7 @@ Query metadata is used to identify your custom queries when they are added to th
|
||||
- If you are contributing a query to the GitHub repository, please read the `query metadata style guide <https://github.com/Semmle/ql/blob/master/docs/query-metadata-style-guide.md#metadata-area>`__.
|
||||
- If you are adding a custom query to a query pack for analysis using LGTM , see `Writing custom queries to include in LGTM analysis <https://lgtm.com/help/lgtm/writing-custom-queries>`__.
|
||||
- If you are analyzing a database using the `CodeQL CLI <https://help.semmle.com/codeql/codeql-cli.html>`__, your query metadata must contain ``@kind``.
|
||||
- If you are running a query in the query console on LGTM or with the CodeQL extension for VS Code, metadata is not mandatory. However, if you want your results to be displayed as either an 'alert' or a 'path', you must specify the correct ``@kind`` property, as explained below. For more information, see `Using the query console <https://lgtm.com/help/lgtm/using-query-console>`__ on LGTM.com.and `Using the extension <https://help.semmle.com/codeql/codeql-for-vscode/procedures/using-extension.html>`__ in the CodeQL for VS Code help.
|
||||
- If you are running a query in the query console on LGTM or with the CodeQL extension for VS Code, metadata is not mandatory. However, if you want your results to be displayed as either an 'alert' or a 'path', you must specify the correct ``@kind`` property, as explained below. For more information, see `Using the query console <https://lgtm.com/help/lgtm/using-query-console>`__ on LGTM.com and `Using the extension <https://help.semmle.com/codeql/codeql-for-vscode/procedures/using-extension.html>`__ in the CodeQL for VS Code help.
|
||||
|
||||
.. pull-quote::
|
||||
|
||||
|
||||
Reference in New Issue
Block a user