Skip to content

Commit 5292051

Browse files
author
james
committed
docs: further reading for codeql queries section
1 parent 29eed68 commit 5292051

File tree

8 files changed

+18
-28
lines changed

8 files changed

+18
-28
lines changed

docs/language/learn-ql/intro-to-data-flow.rst

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,7 @@ However, since ``y`` is derived from ``x``, it is influenced by the untrusted or
7979
In QL, taint tracking extends data flow analysis by including steps in which the data values are not necessarily preserved, but the potentially insecure object is still propagated.
8080
These flow steps are modeled in the taint-tracking library using predicates that hold if taint is propagated between nodes.
8181

82-
What next?
83-
**********
82+
Further reading
83+
***************
8484

85-
- Search for ``DataFlow`` and ``TaintTracking`` in the `standard CodeQL libraries <https://help.semmle.com/QL/ql-libraries.html>`__ to learn more about the technical implementation of data flow analysis for specific programming languages.
86-
- Visit `Learning CodeQL <https://help.semmle.com/QL/learn-ql/>`__ to find language-specific tutorials on data flow and other topics.
85+
- `Exploring data flow with path queries <https://help.semmle.com/codeql/codeql-for-vscode/procedures/exploring-paths.html>`__

docs/language/learn-ql/locations.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,3 +115,8 @@ The ``toString()`` predicate
115115
----------------------------
116116

117117
All classes except those that extend primitive types, must provide a ``string toString()`` member predicate. The query compiler will complain if you don't. The uniqueness warning, noted above for locations, applies here too.
118+
119+
Further reading
120+
---------------
121+
122+
- `CodeQL repository <https://github.com/github/codeql>`__

docs/language/learn-ql/writing-queries/debugging-queries.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,4 +151,4 @@ Now the structure we want is clearer. We've separated out the easy part into its
151151
Further information
152152
-------------------
153153

154-
- Find out more about QL in the `QL language reference <https://help.semmle.com/QL/ql-handbook/index.html>`__.
154+
.. include:: ../../reusables/codeql-ref-tools-further-reading.rst

docs/language/learn-ql/writing-queries/introduction-to-queries.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -150,12 +150,3 @@ Query help files
150150
****************
151151

152152
When you write a custom query, we also recommend that you write a query help file to explain the purpose of the query to other users. For more information, see the `Query help style guide <https://github.com/github/codeql/blob/master/docs/query-help-style-guide.md>`__ on GitHub, and the :doc:`Query help files <query-help>`.
153-
154-
What next?
155-
==========
156-
157-
- See the queries used in real-life variant analysis on the `GitHub Security Lab website <https://securitylab.github.com/research>`__.
158-
- To learn more about writing path queries, see :doc:`Creating path queries <path-queries>`.
159-
- Take a look at the `built-in queries <https://help.semmle.com/wiki/display/QL/Built-in+queries>`__ to see examples of the queries included in CodeQL.
160-
- Explore the `query cookbooks <https://help.semmle.com/wiki/display/QL/QL+cookbooks>`__ to see how to access the basic language elements contained in the CodeQL libraries.
161-
- For a full list of resources to help you learn CodeQL, including beginner tutorials and language-specific examples, visit `Learning CodeQL <https://help.semmle.com/QL/learn-ql/>`__.

docs/language/learn-ql/writing-queries/path-queries.rst

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -189,9 +189,8 @@ The ``element`` that you select in the first column depends on the purpose of th
189189

190190
The alert message defined in the final column in the ``select`` statement can be developed to give more detail about the alert or path found by the query using links and placeholders. For more information, see :doc:`Defining the results of a query <select-statement>`.
191191

192-
What next?
193-
**********
192+
Further reading
193+
***************
194194

195-
- Take a look at the path queries for `C/C++ <https://help.semmle.com/wiki/label/CCPPOBJ/path-problem>`__, `C# <https://help.semmle.com/wiki/label/CSHARP/path-problem>`__, `Java <https://help.semmle.com/wiki/label/java/path-problem>`__, `JavaScript <https://help.semmle.com/wiki/label/js/path-problem>`__, and `Python <https://help.semmle.com/wiki/label/python/path-problem>`__ to see examples of these queries.
196-
- Explore the `query cookbooks <https://help.semmle.com/wiki/display/QL/QL+cookbooks>`__ to see how to access the basic language elements contained in the CodeQL libraries.
197-
- For a full list of resources to help you learn CodeQL, including beginner tutorials and language-specific examples, visit `Learning CodeQL <https://help.semmle.com/QL/learn-ql/>`__.
195+
- `Exploring data flow with path queries <https://help.semmle.com/codeql/codeql-for-vscode/procedures/exploring-paths.html>`__
196+
- `CodeQL repository <https://github.com/github/codeql>`__

docs/language/learn-ql/writing-queries/query-help.rst

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -206,8 +206,3 @@ The included file, `ThreadUnsafeICryptoTransformOverview.qhelp <https://github.
206206
</fragment>
207207
</qhelp>
208208
209-
Further information
210-
===================
211-
212-
- To learn more about contributing to the standard CodeQL queries and libraries, see our `Contributing guidelines <https://github.com/github/codeql/blob/master/CONTRIBUTING.md>`__ on GitHub.
213-
- To learn more about writing custom queries, and how to format your code for clarity and consistency, see `Writing CodeQL queries <https://help.semmle.com/QL/learn-ql/writing-queries/writing-queries.html>`__.

docs/language/learn-ql/writing-queries/query-metadata.rst

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,3 @@ Here is the metadata for one of the standard Java queries:
9999
.. |image0| image:: ../../images/query-metadata.png
100100

101101
For more examples of query metadata, see the standard CodeQL queries in our `GitHub repository <https://github.com/github/codeql>`__.
102-
103-
104-
105-

docs/language/learn-ql/writing-queries/select-statement.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,3 +105,8 @@ The new elements added here don't need to be clickable, so we added them directl
105105
.. image:: ../../images/ql-select-statement-similarity.png
106106
:alt: Results showing the extent of similarity
107107
:class: border
108+
109+
Further reading
110+
---------------
111+
112+
- `CodeQL repository <https://github.com/github/codeql>`__

0 commit comments

Comments
 (0)