Skip to content

Commit ec2008d

Browse files
authored
Merge pull request #2275 from jf205/sd-4017
Learn CodeQL docs: add short note about new terminology
2 parents e65271d + 8178e3e commit ec2008d

2 files changed

Lines changed: 40 additions & 1 deletion

File tree

docs/language/learn-ql/index.rst

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,18 @@ Here, you can query open source projects directly, without having to download Co
99

1010
CodeQL is based on a powerful query language called QL. The following topics help you understand QL in general, as well as how to use it when analyzing code with CodeQL.
1111

12+
.. pull-quote::
13+
14+
Important
15+
16+
If you've previously used QL, you may notice slight changes in terms we use to describe some important concepts. For more information, see our note about :doc:`Recent terminology changes <terminology-note>`.
17+
18+
.. toctree::
19+
:hidden:
20+
21+
terminology-note
22+
23+
1224
.. _getting-started:
1325

1426
Getting started
@@ -86,4 +98,4 @@ Search
8698

8799
.. * :ref:`genindex` remove index for the time being as we currently have no tags
88100
89-
* :ref:`search`
101+
* :ref:`search`
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
Recent terminology changes
2+
===========================
3+
4+
We recently started using new terminology to make it clearer to users what our products do.
5+
This note gives some information about what has changed.
6+
7+
CodeQL
8+
------
9+
10+
CodeQL is the code analysis platform formerly known as QL.
11+
CodeQL treats code as data, and CodeQL analysis is based on running queries against your code to check for errors and find bugs and vulnerabilities.
12+
The CodeQL product includes the tools, scripts, queries, and libraries used in CodeQL analysis.
13+
14+
QL
15+
---
16+
17+
Previously we used the term QL to refer to the whole code analysis platform, which has been renamed CodeQL.
18+
The name QL now only refers to the query language that powers CodeQL analysis.
19+
20+
The CodeQL queries and libraries used to analyze source code are written in QL.
21+
These queries and libraries are open source, and can be found in the `CodeQL repository <https://github.com/semmle/ql>`__.
22+
QL is a general-purpose, object-oriented language that can be used to query any kind of data.
23+
24+
CodeQL databases
25+
----------------
26+
27+
QL snapshots have been renamed CodeQL databases. :doc:`CodeQL databases <database>` contain relational data created and analyzed using CodeQL. They are the equivalent of QL snapshots, but have been optimized for use with the CodeQL tools.

0 commit comments

Comments
 (0)