diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp-new.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp-new.rst index 92af2679dc2..003bc8c0aef 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp-new.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp-new.rst @@ -2,7 +2,7 @@ .. pull-quote:: Note - The data flow library described here is available from CodeQL 2.12.5 onwards. For information on the previous version of the library, see :ref:`Analyzing data flow in C and C++ `. + The data flow library described here is available from CodeQL 2.12.5 onwards. With the release of CodeQL 2.13.0 the library uses the new modular API for data flow. For information on the previous version of the library, see :ref:`Analyzing data flow in C and C++ ` and for information about the new modular API and how to migrate any existing queries to the updated data flow library, see `New dataflow API for CodeQL query writing `__. Analyzing data flow in C and C++ (new) ====================================== diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst index 3440f3129e4..f9ed5af0db8 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst @@ -2,7 +2,7 @@ .. pull-quote:: Note - The data flow library used in this article has been replaced with an improved library which is available from CodeQL 2.12.5 onwards, see :ref:`Analyzing data flow in C and C++ (new) `. The old library has been deprecated in CodeQL 2.14.1 and will be removed in a later release. + The data flow library used in this article has been replaced with an improved library which is available from CodeQL 2.12.5 onwards, see :ref:`Analyzing data flow in C and C++ (new) `. The old library has been deprecated in CodeQL 2.14.1 and will be removed in a later release. With the release of CodeQL 2.13.0 both libraries use the new modular API for data flow. Analyzing data flow in C and C++ ================================ diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst index 5bfc939aa76..61eb803bdc9 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst @@ -12,6 +12,8 @@ This article describes how data flow analysis is implemented in the CodeQL libra The following sections describe how to use the libraries for local data flow, global data flow, and taint tracking. For a more general introduction to modeling data flow, see ":ref:`About data flow analysis `." +.. include:: ../reusables/new-data-flow-api.rst + Local data flow --------------- diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst index dc08ae11e79..06ca7fe413f 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst @@ -17,6 +17,8 @@ The following sections describe how to use the libraries for local data flow, gl For a more general introduction to modeling data flow, see ":ref:`About data flow analysis `." +.. include:: ../reusables/new-data-flow-api.rst + Local data flow --------------- diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst index 61422153735..e93f2df3b73 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst @@ -12,6 +12,8 @@ This article describes how data flow analysis is implemented in the CodeQL libra The following sections describe how to use the libraries for local data flow, global data flow, and taint tracking. For a more general introduction to modeling data flow, see ":ref:`About data flow analysis `." +.. include:: ../reusables/new-data-flow-api.rst + Local data flow --------------- diff --git a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst index 6a603229376..95744747cbc 100644 --- a/docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst @@ -12,6 +12,8 @@ This article describes how data flow analysis is implemented in the CodeQL libra The following sections describe how to use the libraries for local data flow, global data flow, and taint tracking. For a more general introduction to modeling data flow, see ":ref:`About data flow analysis `." +.. include:: ../reusables/new-data-flow-api.rst + Local data flow --------------- diff --git a/docs/codeql/reusables/new-data-flow-api.rst b/docs/codeql/reusables/new-data-flow-api.rst new file mode 100644 index 00000000000..dab3cca5c4f --- /dev/null +++ b/docs/codeql/reusables/new-data-flow-api.rst @@ -0,0 +1,4 @@ +.. pull-quote:: Note + + The new modular API for data flow described here is available alongside the previous library from CodeQL 2.13.0 onwards. For information about how the library has changed and how to migrate any existing queries to the modular API, see `New dataflow API for CodeQL query writing `__. + \ No newline at end of file diff --git a/docs/codeql/writing-codeql-queries/creating-path-queries.rst b/docs/codeql/writing-codeql-queries/creating-path-queries.rst index 2c5b1ff57d7..9d2e5eee687 100644 --- a/docs/codeql/writing-codeql-queries/creating-path-queries.rst +++ b/docs/codeql/writing-codeql-queries/creating-path-queries.rst @@ -5,6 +5,8 @@ Creating path queries You can create path queries to visualize the flow of information through a codebase. +.. include:: ../reusables/new-data-flow-api.rst + Overview ======== diff --git a/docs/codeql/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow.rst b/docs/codeql/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow.rst index 6eba58837ee..d2b09e2d92f 100644 --- a/docs/codeql/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow.rst +++ b/docs/codeql/writing-codeql-queries/debugging-data-flow-queries-using-partial-flow.rst @@ -3,6 +3,8 @@ Debugging data-flow queries using partial flow ============================================== +.. include:: ../reusables/new-data-flow-api.rst + If a data-flow query doesn't produce the results you expect to see, you can use partial flow to debug the problem. In CodeQL, you can use :ref:`data flow analysis ` to compute the possible values that a variable can hold at various points in a program.