Skip to content

Commit b794fcb

Browse files
authored
Merge pull request github#4925 from shati-patel/fix-links
Fix broken links in CodeQL documentation
2 parents e5b4975 + 53c46ed commit b794fcb

28 files changed

+65
-63
lines changed

docs/codeql/codeql-cli/about-ql-packs.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,8 @@ from any ___location in the pack by declaring ``import mycompany.java.CustomSinks``
5757
For more information, see ":ref:`Importing modules <importing-modules>`"
5858
in the QL language reference.
5959

60+
.. _qlpack-yml-properties:
61+
6062
``qlpack.yml`` properties
6163
~~~~~~~~~~~~~~~~~~~~~~~~~
6264

@@ -101,7 +103,7 @@ The following properties are supported in ``qlpack.yml`` files.
101103
* - ``upgrades``
102104
- ``.``
103105
- Packs with upgrades
104-
- The path to a directory within the pack that contains upgrade scripts, defined relative to the pack directory. The ``database upgrade`` action uses these scripts to update databases that were created by an older version of an extractor so they're compatible with the current extractor (see `Upgrade scripts for a language <upgrade-scripts-for-a-language>`__ below.)
106+
- The path to a directory within the pack that contains upgrade scripts, defined relative to the pack directory. The ``database upgrade`` action uses these scripts to update databases that were created by an older version of an extractor so they're compatible with the current extractor (see `Upgrade scripts for a language <#upgrade-scripts-for-a-language>`__ below.)
105107

106108

107109
.. _custom-ql-packs:

docs/codeql/codeql-cli/creating-codeql-query-suites.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ without providing their full path. This gives you a simple way of specifying a
254254
set of queries, without needing to search inside QL packs and distributions.
255255
To declare a directory that contains "well-known" query suites, add the directory
256256
to the ``suites`` property in the ``qlpack.yml`` file at the root of your QL pack.
257-
For more information, see "`About QL packs <qlpack-overview.html#qlpack-yml-properties>`__."
257+
For more information, see ":ref:`About QL packs <qlpack-yml-properties>`."
258258

259259
Using query suites with CodeQL
260260
------------------------------

docs/codeql/codeql-language-guides/analyzing-control-flow-in-python.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ You can write CodeQL queries to explore the control-flow graph of a Python progr
88
About analyzing control flow
99
--------------------------------------
1010

11-
To analyze the control-flow graph of a ``Scope`` we can use the two CodeQL classes ``ControlFlowNode`` and ``BasicBlock``. These classes allow you to ask such questions as "can you reach point A from point B?" or "Is it possible to reach point B *without* going through point A?". To report results we use the class ``AstNode``, which represents a syntactic element and corresponds to the source code - allowing the results of the query to be more easily understood. For more information, see `Control-flow graph <http://en.wikipedia.org/wiki/Control_flow_graph>`__ on Wikipedia.
11+
To analyze the control-flow graph of a ``Scope`` we can use the two CodeQL classes ``ControlFlowNode`` and ``BasicBlock``. These classes allow you to ask such questions as "can you reach point A from point B?" or "Is it possible to reach point B *without* going through point A?". To report results we use the class ``AstNode``, which represents a syntactic element and corresponds to the source code - allowing the results of the query to be more easily understood. For more information, see `Control-flow graph <https://en.wikipedia.org/wiki/Control_flow_graph>`__ on Wikipedia.
1212

1313
The ``ControlFlowNode`` class
1414
-----------------------------
@@ -65,7 +65,7 @@ Example finding unreachable statements
6565
The ``BasicBlock`` class
6666
------------------------
6767

68-
The ``BasicBlock`` class represents a basic block of control flow nodes. The ``BasicBlock`` class is not that useful for writing queries directly, but is very useful for building complex analyses, such as data flow. The reason it is useful is that it shares many of the interesting properties of control flow nodes, such as, what can reach what, and what dominates what, but there are fewer basic blocks than control flow nodes - resulting in queries that are faster and use less memory. For more information, see `Basic block <http://en.wikipedia.org/wiki/Basic_block>`__ and `Dominator <http://en.wikipedia.org/wiki/Dominator_%28graph_theory%29>`__ on Wikipedia.
68+
The ``BasicBlock`` class represents a basic block of control flow nodes. The ``BasicBlock`` class is not that useful for writing queries directly, but is very useful for building complex analyses, such as data flow. The reason it is useful is that it shares many of the interesting properties of control flow nodes, such as, what can reach what, and what dominates what, but there are fewer basic blocks than control flow nodes - resulting in queries that are faster and use less memory. For more information, see `Basic block <https://en.wikipedia.org/wiki/Basic_block>`__ and `Dominator <https://en.wikipedia.org/wiki/Dominator_%28graph_theory%29>`__ on Wikipedia.
6969

7070
Example finding mutually exclusive basic blocks
7171
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

docs/codeql/codeql-language-guides/codeql-library-for-cpp.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -703,8 +703,8 @@ Further reading
703703
.. _SizeofPackOperator: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Cast.qll/type.Cast$SizeofPackOperator.html
704704
.. _StmtExpr: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Expr.qll/type.Expr$StmtExpr.html
705705
.. _ThisExpr: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Expr.qll/type.Expr$ThisExpr.html
706-
.. _ThrowExpr: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Call.qll/type.Call$ThrowExpr.html
707-
.. _ReThrowExpr: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Call.qll/type.Call$ReThrowExpr.html
706+
.. _ThrowExpr: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Expr.qll/type.Expr$ThrowExpr.html
707+
.. _ReThrowExpr: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Expr.qll/type.Expr$ReThrowExpr.html
708708
.. _TypeidOperator: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Cast.qll/type.Cast$TypeidOperator.html
709709
.. _UuidofOperator: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/exprs/Cast.qll/type.Cast$UuidofOperator.html
710710
.. _VoidType: https://codeql.github.com/codeql-standard-libraries/cpp/semmle/code/cpp/Type.qll/type.Type$VoidType.html

docs/codeql/codeql-language-guides/codeql-library-for-go.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ library by beginning your query with:
2222
2323
Broadly speaking, the CodeQL library for Go provides two views of a Go code base: at the `syntactic
2424
level`, source code is represented as an `abstract syntax tree
25-
<https://wikipedia.org/wiki/Abstract_syntax_tree>`__ (AST), while at the `data-flow level` it is
25+
<https://en.wikipedia.org/wiki/Abstract_syntax_tree>`__ (AST), while at the `data-flow level` it is
2626
represented as a `data-flow graph <https://en.wikipedia.org/wiki/Data-flow_analysis>`__ (DFG). In
2727
between, there is also an intermediate representation of the program as a control-flow graph (CFG),
2828
though this representation is rarely useful on its own and mostly used to construct the higher-level

0 commit comments

Comments
 (0)