mirror of
https://github.com/github/codeql.git
synced 2025-12-30 07:36:34 +01:00
add/improve intro text and add links to example queries
This commit is contained in:
@@ -1,5 +1,9 @@
|
||||
C and C++ query help
|
||||
=====================
|
||||
|
||||
.. include:: ../reusables/query-help-overview.rst
|
||||
|
||||
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/cpp/ql/examples>`__.
|
||||
|
||||
.. include:: toc-cpp.rst
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
C# query help
|
||||
=============
|
||||
|
||||
.. include:: ../reusables/query-help-overview.rst
|
||||
|
||||
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/csharp/ql/examples>`__.
|
||||
|
||||
.. include:: toc-csharp.rst
|
||||
@@ -1,4 +1,8 @@
|
||||
Go query help
|
||||
=============
|
||||
|
||||
.. include:: ../reusables/query-help-overview.rst
|
||||
|
||||
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql-go/tree/main/ql/examples>`__.
|
||||
|
||||
.. include:: toc-go.rst
|
||||
@@ -1,17 +1,17 @@
|
||||
CodeQL query help
|
||||
-----------------
|
||||
|
||||
Use the sidebar to view the query help for the queries included in the "code scanning" and "security extended" query suites for a single language.
|
||||
View the query help for the queries included in the ``code-scanning``, ``security-extended``, and ``security-and-quality`` query suites for the languages supported by CodeQL.
|
||||
|
||||
Each query help page includes:
|
||||
Each query help article includes:
|
||||
|
||||
- A summary of key metadata for the query
|
||||
- A summary of key metadata for the query.
|
||||
- Information about which query suites the query is included in.
|
||||
- A link to the query in the `CodeQL repository <https://github.com/gitub/codeql>`__
|
||||
- Help information to explain what potential vulnerability the query identifies and a recommendation for how to avoid introducing the problem in your code
|
||||
- Help information to explain what potential vulnerability the query identifies and a recommendation for how to avoid introducing the problem to your code.
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
:hidden:
|
||||
|
||||
cpp
|
||||
csharp
|
||||
|
||||
@@ -1,4 +1,8 @@
|
||||
Java query help
|
||||
===============
|
||||
|
||||
.. include:: ../reusables/query-help-overview.rst
|
||||
|
||||
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/java/ql/examples>`__.
|
||||
|
||||
.. include:: toc-java.rst
|
||||
@@ -1,4 +1,8 @@
|
||||
JavaScript query help
|
||||
=====================
|
||||
|
||||
.. include:: ../reusables/query-help-overview.rst
|
||||
|
||||
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/javascript/ql/examples>`__.
|
||||
|
||||
.. include:: toc-javascript.rst
|
||||
@@ -1,4 +1,8 @@
|
||||
Python query help
|
||||
=================
|
||||
|
||||
.. include:: ../reusables/query-help-overview.rst
|
||||
|
||||
For shorter queries that you can use as building blocks when writing your own queries, see the `example queries in the CodeQL repository <https://github.com/github/codeql/tree/main/python/ql/examples>`__.
|
||||
|
||||
.. include:: toc-python.rst
|
||||
5
docs/codeql/reusables/query-help-overview.rst
Normal file
5
docs/codeql/reusables/query-help-overview.rst
Normal file
@@ -0,0 +1,5 @@
|
||||
Visit the articles below to see the documentation for the queries included in the following query suites:
|
||||
|
||||
- ``code-scanning``: queries run by default in code scanning.
|
||||
- ``security-extended``: queries from ``code-scanning``, plus extra security queries with slightly lower precision and severity.
|
||||
- ``security-and-quality``: queries from ``code-scanning``, ``security-and-quality``, plus extra maintainability and reliability queries.
|
||||
Reference in New Issue
Block a user