diff --git a/docs/codeql/codeql-cli/codeql-cli-reference/about-ql-packs.rst b/docs/codeql/codeql-cli/about-ql-packs.rst similarity index 96% rename from docs/codeql/codeql-cli/codeql-cli-reference/about-ql-packs.rst rename to docs/codeql/codeql-cli/about-ql-packs.rst index 39769f1f79c..ed9c9319bdf 100644 --- a/docs/codeql/codeql-cli/codeql-cli-reference/about-ql-packs.rst +++ b/docs/codeql/codeql-cli/about-ql-packs.rst @@ -85,11 +85,11 @@ The following properties are supported in ``qlpack.yml`` files. * - ``suites`` - ``suites`` - Optional - - The path to a directory that contains the "well-known" query suites in the pack, defined relative to the pack directory. You can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. To use query suites stored in other directories in the pack, you must provide their full path. For more information about query suites, see ":doc:`Creating CodeQL query suites <../using-the-codeql-cli/creating-codeql-query-suites>`." + - The path to a directory that contains the "well-known" query suites in the pack, defined relative to the pack directory. You can run "well-known" suites stored in this directory by specifying the pack name, without providing their full path. To use query suites stored in other directories in the pack, you must provide their full path. For more information about query suites, see ":doc:`Creating CodeQL query suites `." * - ``extractor`` - ``javascript`` - All test packs - - The CodeQL language extractor to use when the CLI creates a database from test files in the pack. For more information about testing queries, see ":doc:`Testing custom queries <../using-the-codeql-cli/testing-custom-queries>`." + - The CodeQL language extractor to use when the CLI creates a database from test files in the pack. For more information about testing queries, see ":doc:`Testing custom queries `." * - ``tests`` - ``.`` - Optional for test packs @@ -124,7 +124,7 @@ and ``libraryPathDependencies`` properties. If the pack contains query suites, y use the ``suites`` property to define their location. Query suites defined here are called "well-known" suites, and can be used on the command line by referring to their name only, rather than their full path. -For more information about query suites, see ":doc:`Creating CodeQL query suites <../using-the-codeql-cli/creating-codeql-query-suites>`." +For more information about query suites, see ":doc:`Creating CodeQL query suites `." For example, a ``qlpack.yml`` file for a QL pack featuring custom C++ queries and libraries may contain: @@ -154,10 +154,10 @@ For custom QL packs containing test files, you also need to include an ``extractor`` property so that the ``test run`` command knows how to create test databases. You may also wish to specify the ``tests`` property. -.. include:: ../../reusables/test-qlpack.rst +.. include:: ../reusables/test-qlpack.rst For more information about running tests, see ":doc:`Testing custom queries -<../using-the-codeql-cli/testing-custom-queries>`." +`." .. _standard-ql-packs: diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst b/docs/codeql/codeql-cli/about-the-codeql-cli.rst similarity index 100% rename from docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst rename to docs/codeql/codeql-cli/about-the-codeql-cli.rst diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst similarity index 96% rename from docs/codeql/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst rename to docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst index daf92ceb4bb..956a6e31b4b 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst @@ -11,7 +11,7 @@ CodeQL analyses produce :ref:`interpreted results For information about writing queries to run with ``database analyze``, see ":doc:`Using custom queries with the CodeQL CLI `." -.. include:: ../../reusables/advanced-query-execution.rst +.. include:: ../reusables/advanced-query-execution.rst Before starting an analysis you must: @@ -55,7 +55,7 @@ You must specify: You can also specify: -- .. include:: ../../reusables/threads-query-execution.rst +- .. include:: ../reusables/threads-query-execution.rst .. pull-quote:: @@ -149,7 +149,7 @@ recursively, so any queries contained in subfolders will also be executed. Important You shouldn't specify the root of a :doc:`QL pack - <../codeql-cli-reference/about-ql-packs>` when executing ``database analyze`` + ` when executing ``database analyze`` as it contains some special queries that aren't designed to be used with the command. Rather, to run a wide range of useful queries, run one of the LGTM.com query suites. @@ -171,7 +171,7 @@ You can save analysis results in a number of different formats, including SARIF and CSV. The SARIF format is designed to represent the output of a broad range of static -analysis tools. For more information, see :doc:`SARIF output <../codeql-cli-reference/sarif-output>`. +analysis tools. For more information, see :doc:`SARIF output `. If you choose to generate results in CSV format, then each line in the output file corresponds to an alert. Each line is a comma-separated list with the following information: diff --git a/docs/codeql/codeql-cli/codeql-cli-reference/index.rst b/docs/codeql/codeql-cli/codeql-cli-reference.rst similarity index 100% rename from docs/codeql/codeql-cli/codeql-cli-reference/index.rst rename to docs/codeql/codeql-cli/codeql-cli-reference.rst diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst b/docs/codeql/codeql-cli/creating-codeql-databases.rst similarity index 98% rename from docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst rename to docs/codeql/codeql-cli/creating-codeql-databases.rst index e7248e5725f..5dc12ed03b9 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst +++ b/docs/codeql/codeql-cli/creating-codeql-databases.rst @@ -35,7 +35,7 @@ You must specify: - ``--language``: the identifier for the language to create a database for. CodeQL supports creating databases for the following languages: - .. include:: ../../reusables/extractors.rst + .. include:: ../reusables/extractors.rst Other options may be specified depending on the location of your source file and the language you want to analyze: @@ -75,7 +75,7 @@ CodeQL. For each project on LGTM.com, you can download an archived CodeQL database corresponding to the most recently analyzed revision of the code. These databases can also be analyzed using the CodeQL CLI. -.. include:: ../../reusables/download-lgtm-database.rst +.. include:: ../reusables/download-lgtm-database.rst Before running an analysis, unzip the databases and try :doc:`upgrading ` the unzipped databases to ensure they are compatible with your local copy of the @@ -85,7 +85,7 @@ CodeQL queries and libraries. Note - .. include:: ../../reusables/index-files-note.rst + .. include:: ../reusables/index-files-note.rst Creating databases for non-compiled languages --------------------------------------------- diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst b/docs/codeql/codeql-cli/creating-codeql-query-suites.rst similarity index 98% rename from docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst rename to docs/codeql/codeql-cli/creating-codeql-query-suites.rst index 75c7113b4a9..9c8f42683ea 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst +++ b/docs/codeql/codeql-cli/creating-codeql-query-suites.rst @@ -19,7 +19,7 @@ suite definition have been executed, the result is a set of selected queries. .. note:: Any custom queries that you want to add to a query suite must be in a :doc:`QL - pack <../codeql-cli-reference/about-ql-packs>` and contain the correct query metadata. + pack ` and contain the correct query metadata. For more information, see ":doc:`Using custom queries with the CodeQL CLI `." @@ -254,7 +254,7 @@ without providing their full path. This gives you a simple way of specifying a set of queries, without needing to search inside QL packs and distributions. To declare a directory that contains "well-known" query suites, add the directory to the ``suites`` property in the ``qlpack.yml`` file at the root of your QL pack. -For more information, see "`About QL packs <../codeql-cli-reference/qlpack-overview.html#qlpack-yml-properties>`__." +For more information, see "`About QL packs `__." Using query suites with CodeQL ------------------------------ diff --git a/docs/codeql/codeql-cli/codeql-cli-reference/exit-codes.rst b/docs/codeql/codeql-cli/exit-codes.rst similarity index 100% rename from docs/codeql/codeql-cli/codeql-cli-reference/exit-codes.rst rename to docs/codeql/codeql-cli/exit-codes.rst diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst similarity index 98% rename from docs/codeql/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.rst rename to docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst index 1cd0ce63eee..c0f5282e4f8 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst @@ -6,7 +6,7 @@ Getting started with the CodeQL CLI To run CodeQL commands, you need to set up the CLI so that it can access the tools, queries, and libraries required to create and analyze databases. -.. include:: ../../reusables/license-note.rst +.. include:: ../reusables/license-note.rst .. _setting-up-cli: @@ -115,7 +115,7 @@ repository should be ``$HOME/codeql-home/codeql-go``. Within these repositories, the queries and libraries are organized into QL packs. Along with the queries themselves, QL packs contain important metadata that tells the CodeQL CLI how to process the query files. For more information, -see ":doc:`About QL packs <../codeql-cli-reference/about-ql-packs>`." +see ":doc:`About QL packs `." .. pull-quote:: Important diff --git a/docs/codeql/codeql-cli/index.rst b/docs/codeql/codeql-cli/index.rst index a27b1aa70c3..233253673af 100644 --- a/docs/codeql/codeql-cli/index.rst +++ b/docs/codeql/codeql-cli/index.rst @@ -10,12 +10,12 @@ CodeQL CLI - :ref:`CodeQL CLI reference `: Learn more about the files you can use when running CodeQL processes and the results format and exit codes that CodeQL generates. -- `CodeQL CLI manual `__: Detailed information about all the commands available with the CodeQL CLI. +- `CodeQL CLI manual <../codeql-cli-manual>`__: Detailed information about all the commands available with the CodeQL CLI. .. toctree:: :titlesonly: :hidden: - using-the-codeql-cli/index - codeql-cli-reference/index + using-the-codeql-cli + codeql-cli-reference diff --git a/docs/codeql/codeql-cli/codeql-cli-reference/query-reference-files.rst b/docs/codeql/codeql-cli/query-reference-files.rst similarity index 95% rename from docs/codeql/codeql-cli/codeql-cli-reference/query-reference-files.rst rename to docs/codeql/codeql-cli/query-reference-files.rst index e4bea0df72f..5c629723548 100644 --- a/docs/codeql/codeql-cli/codeql-cli-reference/query-reference-files.rst +++ b/docs/codeql/codeql-cli/query-reference-files.rst @@ -44,4 +44,4 @@ to the ``codeql-javascript`` QL pack:: AngularJS/DeadAngularJSEventListener.ql -For another example, see `Testing custom queries <../using-the-codeql-cli/test-queries.html#example>`__. +For another example, see `Testing custom queries `__. diff --git a/docs/codeql/codeql-cli/codeql-cli-reference/sarif-output.rst b/docs/codeql/codeql-cli/sarif-output.rst similarity index 100% rename from docs/codeql/codeql-cli/codeql-cli-reference/sarif-output.rst rename to docs/codeql/codeql-cli/sarif-output.rst diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst b/docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst similarity index 100% rename from docs/codeql/codeql-cli/using-the-codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst rename to docs/codeql/codeql-cli/specifying-command-options-in-a-codeql-configuration-file.rst diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst b/docs/codeql/codeql-cli/testing-custom-queries.rst similarity index 96% rename from docs/codeql/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst rename to docs/codeql/codeql-cli/testing-custom-queries.rst index 5746158e1de..9007e96677b 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/testing-custom-queries.rst +++ b/docs/codeql/codeql-cli/testing-custom-queries.rst @@ -44,7 +44,7 @@ file that defines: The ``libraryPathDependencies`` value specifies the CodeQL queries to test. The ``extractor`` defines which language the CLI will use to create test databases from the code files stored in this QL pack. -For more information, see ":doc:`About QL packs <../codeql-cli-reference/about-ql-packs>`." +For more information, see ":doc:`About QL packs `." You may find it useful to look at the way query tests are organized in the `CodeQL repository `__. @@ -70,7 +70,7 @@ Then add the following files to the subdirectory before you run the test command The location is defined relative to the root of the QL pack that contains the query. Usually, this is a QL pack specified by the ``libraryPathDependencies`` for the test pack. - For more information, see ":doc:`Query reference files <../codeql-cli-reference/query-reference-files>`." + For more information, see ":doc:`Query reference files `." You don't need to add a query reference file if the query you want to test is stored in the test directory, @@ -127,7 +127,7 @@ The ```` argument can be one or more of the following: You can also specify: -- .. include:: ../../reusables/threads-query-execution.rst +- .. include:: ../reusables/threads-query-execution.rst For full details of all the options you can use when testing queries, see the `test run reference documentation <../codeql-cli-manual/test-run.html>`__. @@ -172,13 +172,13 @@ Prepare a query and test files libraryPathDependencies: codeql-java For more information about QL packs, see ":doc:`About QL packs - <../codeql-cli-reference/about-ql-packs>`." + `." #. Create a QL pack for your Java tests by adding a ``qlpack.yml`` file with the following contents to ``custom-queries/java/tests``, updating ``libraryPathDependencies`` to match the name of your QL pack of custom queries: - .. include:: ../../reusables/test-qlpack.rst + .. include:: ../reusables/test-qlpack.rst #. Within the Java test pack, create a directory to contain the test files associated with ``EmptyThen.ql``. diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/testing-query-help-files.rst b/docs/codeql/codeql-cli/testing-query-help-files.rst similarity index 100% rename from docs/codeql/codeql-cli/using-the-codeql-cli/testing-query-help-files.rst rename to docs/codeql/codeql-cli/testing-query-help-files.rst diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst b/docs/codeql/codeql-cli/upgrading-codeql-databases.rst similarity index 100% rename from docs/codeql/codeql-cli/using-the-codeql-cli/upgrading-codeql-databases.rst rename to docs/codeql/codeql-cli/upgrading-codeql-databases.rst diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst similarity index 98% rename from docs/codeql/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst rename to docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst index b3f2d02ca1b..50271c24eef 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/using-custom-queries-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst @@ -10,7 +10,7 @@ This topic is specifically about writing queries to use with the `database analyze <../codeql-cli-manual/database-analyze.html>`__ command to produce :ref:`interpreted results `. -.. include:: ../../reusables/advanced-query-execution.rst +.. include:: ../reusables/advanced-query-execution.rst Writing a valid query --------------------- diff --git a/docs/codeql/codeql-cli/using-the-codeql-cli/index.rst b/docs/codeql/codeql-cli/using-the-codeql-cli.rst similarity index 97% rename from docs/codeql/codeql-cli/using-the-codeql-cli/index.rst rename to docs/codeql/codeql-cli/using-the-codeql-cli.rst index 95a1f412fe2..064f6369eca 100644 --- a/docs/codeql/codeql-cli/using-the-codeql-cli/index.rst +++ b/docs/codeql/codeql-cli/using-the-codeql-cli.rst @@ -3,7 +3,7 @@ Using the CodeQL CLI ==================== -.. include:: ../../reusables/codeql-cli-overview.rst +.. include:: ../reusables/codeql-cli-overview.rst See the following links to learn how to get set up and run CodeQL commands: diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/abstract-syntax-tree-classes-for-working-with-go-programs.rst b/docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-go-programs.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-go/abstract-syntax-tree-classes-for-working-with-go-programs.rst rename to docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-go-programs.rst index 22a1722b8a6..516cb86b753 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-go/abstract-syntax-tree-classes-for-working-with-go-programs.rst +++ b/docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-go-programs.rst @@ -5,7 +5,7 @@ Abstract syntax tree classes for working with Go programs CodeQL has a large selection of classes for representing the abstract syntax tree of Go programs. -.. include:: ../../reusables/abstract-syntax-tree.rst +.. include:: ../reusables/abstract-syntax-tree.rst Statement classes ----------------- @@ -481,5 +481,5 @@ The following classes organize expressions by the kind of entity they refer to. Further reading --------------- -.. include:: ../../reusables/go-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file +.. include:: ../reusables/go-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/abstract-syntax-tree-classes-for-working-with-java-programs.rst b/docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-java-programs.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-java/abstract-syntax-tree-classes-for-working-with-java-programs.rst rename to docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-java-programs.rst index aae621d8314..9e5ab4cd706 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/abstract-syntax-tree-classes-for-working-with-java-programs.rst +++ b/docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-java-programs.rst @@ -5,7 +5,7 @@ Abstract syntax tree classes for working with Java programs CodeQL has a large selection of classes for representing the abstract syntax tree of Java programs. -.. include:: ../../reusables/abstract-syntax-tree.rst +.. include:: ../reusables/abstract-syntax-tree.rst Statement classes ----------------- @@ -274,8 +274,8 @@ Miscellaneous Further reading --------------- -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst .. _Expr: https://help.semmle.com/qldoc/java/semmle/code/java/Expr.qll/type.Expr$Expr.html .. _Stmt: https://help.semmle.com/qldoc/java/semmle/code/java/Statement.qll/type.Statement$Stmt.html diff --git a/docs/codeql/codeql-language-guides/codeql-for-javascript/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst b/docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-javascript/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst rename to docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst index 351e608b01a..1eb21c7a666 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-javascript/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst +++ b/docs/codeql/codeql-language-guides/abstract-syntax-tree-classes-for-working-with-javascript-and-typescript-programs.rst @@ -5,7 +5,7 @@ Abstract syntax tree classes for working with JavaScript and TypeScript programs CodeQL has a large selection of classes for representing the abstract syntax tree of JavaScript and TypeScript programs. -.. include:: ../../reusables/abstract-syntax-tree.rst +.. include:: ../reusables/abstract-syntax-tree.rst Statement classes ----------------- @@ -364,5 +364,5 @@ All classes in this table are subclasses of `Expr `, :doc:`C# <../codeql-for-csharp/analyzing-data-flow-in-csharp>`, :doc:`Java <../codeql-for-java/analyzing-data-flow-in-java>`, and :doc:`JavaScript <../codeql-for-javascript/analyzing-data-flow-in-javascript>`. You can access the appropriate classes and predicates that reason about these different modes of data flow by importing the appropriate library in your query. +Separate CodeQL libraries have been written to handle 'normal' data flow and taint tracking in :doc:`C/C++ `, :doc:`C# `, :doc:`Java `, and :doc:`JavaScript `. You can access the appropriate classes and predicates that reason about these different modes of data flow by importing the appropriate library in your query. In Python analysis, we can use the same taint tracking library to model both 'normal' data flow and taint flow, but we are still able make the distinction between steps that preserve values and those that don't by defining additional data flow properties. For further information on data flow and taint tracking with CodeQL, see ":ref:`Introduction to data flow `." @@ -264,6 +264,6 @@ Further reading - ":ref:`Exploring data flow with path queries `" -.. include:: ../../reusables/python-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/python-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/analyzing-data-flow-in-cpp.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/analyzing-data-flow-in-cpp.rst rename to docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst index 09e0ebbb6ff..815425a425a 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/analyzing-data-flow-in-cpp.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst @@ -143,7 +143,7 @@ Global data flow tracks data flow throughout the entire program, and is therefor .. pull-quote:: Note - .. include:: ../../reusables/path-problem.rst + .. include:: ../reusables/path-problem.rst Using global data flow ~~~~~~~~~~~~~~~~~~~~~~ @@ -395,5 +395,5 @@ Further reading - ":ref:`Exploring data flow with path queries `" -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file diff --git a/docs/codeql/codeql-language-guides/codeql-for-csharp/analyzing-data-flow-in-csharp.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-csharp/analyzing-data-flow-in-csharp.rst rename to docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst index 6a9304925dc..71cf519fae3 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-csharp/analyzing-data-flow-in-csharp.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst @@ -141,7 +141,7 @@ Global data flow tracks data flow throughout the entire program, and is therefor .. pull-quote:: Note - .. include:: ../../reusables/path-problem.rst + .. include:: ../reusables/path-problem.rst Using global data flow ~~~~~~~~~~~~~~~~~~~~~~ @@ -558,5 +558,5 @@ Further reading - ":ref:`Exploring data flow with path queries `" -.. include:: ../../reusables/csharp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/csharp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/analyzing-data-flow-in-java.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-java/analyzing-data-flow-in-java.rst rename to docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst index ebcdb91cad9..75309842ad5 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/analyzing-data-flow-in-java.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst @@ -151,7 +151,7 @@ Global data flow tracks data flow throughout the entire program, and is therefor .. pull-quote:: Note - .. include:: ../../reusables/path-problem.rst + .. include:: ../reusables/path-problem.rst Using global data flow ~~~~~~~~~~~~~~~~~~~~~~ @@ -363,5 +363,5 @@ Further reading - ":ref:`Exploring data flow with path queries `" -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file diff --git a/docs/codeql/codeql-language-guides/codeql-for-javascript/analyzing-data-flow-in-javascript.rst b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-javascript.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-javascript/analyzing-data-flow-in-javascript.rst rename to docs/codeql/codeql-language-guides/analyzing-data-flow-in-javascript.rst index 6e4c9c2a32a..198b4ff0aec 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-javascript/analyzing-data-flow-in-javascript.rst +++ b/docs/codeql/codeql-language-guides/analyzing-data-flow-in-javascript.rst @@ -192,7 +192,7 @@ more time and memory than local analysis. .. pull-quote:: Note - .. include:: ../../reusables/path-problem.rst + .. include:: ../reusables/path-problem.rst Using global data flow ~~~~~~~~~~~~~~~~~~~~~~ @@ -559,5 +559,5 @@ Further reading - ":ref:`Exploring data flow with path queries `" -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/annotations-in-java.rst b/docs/codeql/codeql-language-guides/annotations-in-java.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-java/annotations-in-java.rst rename to docs/codeql/codeql-language-guides/annotations-in-java.rst index a9d8fcee923..3439fb6ff0e 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/annotations-in-java.rst +++ b/docs/codeql/codeql-language-guides/annotations-in-java.rst @@ -242,5 +242,5 @@ Now we can extend our query to filter out calls in methods carrying a ``Suppress Further reading --------------- -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/basic-query-for-cpp-code.rst b/docs/codeql/codeql-language-guides/basic-query-for-cpp-code.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/basic-query-for-cpp-code.rst rename to docs/codeql/codeql-language-guides/basic-query-for-cpp-code.rst index b0068587fb7..a2be15c2fed 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/basic-query-for-cpp-code.rst +++ b/docs/codeql/codeql-language-guides/basic-query-for-cpp-code.rst @@ -48,7 +48,7 @@ Running the query The name of the project you are querying, and the ID of the most recently analyzed commit to the project, are listed below the query box. To the right of this is an icon that indicates the progress of the query operation: - .. image:: ../../images/query-progress.png + .. image:: ../images/query-progress.png :align: center .. pull-quote:: @@ -143,5 +143,5 @@ To exclude ``if`` statements that have an ``else`` branch: Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-csharp/basic-query-for-csharp-code.rst b/docs/codeql/codeql-language-guides/basic-query-for-csharp-code.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-csharp/basic-query-for-csharp-code.rst rename to docs/codeql/codeql-language-guides/basic-query-for-csharp-code.rst index 8439c424d19..f61edbac0f9 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-csharp/basic-query-for-csharp-code.rst +++ b/docs/codeql/codeql-language-guides/basic-query-for-csharp-code.rst @@ -48,7 +48,7 @@ Running the query The name of the project you are querying, and the ID of the most recently analyzed commit to the project, are listed below the query box. To the right of this is an icon that indicates the progress of the query operation: - .. image:: ../../images/query-progress.png + .. image:: ../images/query-progress.png :align: center .. pull-quote:: @@ -148,5 +148,5 @@ To exclude ``if`` statements that have an ``else`` branch: Further reading --------------- -.. include:: ../../reusables/csharp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/csharp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/basic-query-for-go-code.rst b/docs/codeql/codeql-language-guides/basic-query-for-go-code.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-go/basic-query-for-go-code.rst rename to docs/codeql/codeql-language-guides/basic-query-for-go-code.rst index 32a41e44a24..15ae9caee7d 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-go/basic-query-for-go-code.rst +++ b/docs/codeql/codeql-language-guides/basic-query-for-go-code.rst @@ -58,7 +58,7 @@ Running the query The name of the project you are querying, and the ID of the most recently analyzed commit to the project, are listed below the query box. To the right of this is an icon that indicates the progress of the query operation: - .. image:: ../../images/query-progress.png + .. image:: ../images/query-progress.png :align: center .. pull-quote:: @@ -149,5 +149,5 @@ To exclude these values: Further reading --------------- -.. include:: ../../reusables/go-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/go-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/basic-query-for-java-code.rst b/docs/codeql/codeql-language-guides/basic-query-for-java-code.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-java/basic-query-for-java-code.rst rename to docs/codeql/codeql-language-guides/basic-query-for-java-code.rst index 56e03e07ca1..bc721ce9371 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/basic-query-for-java-code.rst +++ b/docs/codeql/codeql-language-guides/basic-query-for-java-code.rst @@ -48,7 +48,7 @@ Running the query The name of the project you are querying, and the ID of the most recently analyzed commit to the project, are listed below the query box. To the right of this is an icon that indicates the progress of the query operation: - .. image:: ../../images/query-progress.png + .. image:: ../images/query-progress.png :align: center .. pull-quote:: @@ -143,5 +143,5 @@ To exclude ``if`` statements that have an ``else`` branch: Further reading --------------- -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-javascript/basic-query-for-javascript-code.rst b/docs/codeql/codeql-language-guides/basic-query-for-javascript-code.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-javascript/basic-query-for-javascript-code.rst rename to docs/codeql/codeql-language-guides/basic-query-for-javascript-code.rst index ac79cb3c8c7..123336d699e 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-javascript/basic-query-for-javascript-code.rst +++ b/docs/codeql/codeql-language-guides/basic-query-for-javascript-code.rst @@ -46,7 +46,7 @@ Running the query The name of the project you are querying, and the ID of the most recently analyzed commit to the project, are listed below the query box. To the right of this is an icon that indicates the progress of the query operation: - .. image:: ../../images/query-progress.png + .. image:: ../images/query-progress.png :align: center .. pull-quote:: @@ -134,5 +134,5 @@ As written, this statement compares ``point.bias`` against ``-1`` and then disca Further reading --------------- -.. include:: ../../reusables/javascript-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/javascript-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-python/basic-query-for-python-code.rst b/docs/codeql/codeql-language-guides/basic-query-for-python-code.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-python/basic-query-for-python-code.rst rename to docs/codeql/codeql-language-guides/basic-query-for-python-code.rst index 1519054e0f3..f8424b00d4e 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-python/basic-query-for-python-code.rst +++ b/docs/codeql/codeql-language-guides/basic-query-for-python-code.rst @@ -48,7 +48,7 @@ Running the query The name of the project you are querying, and the ID of the most recently analyzed commit to the project, are listed below the query box. To the right of this is an icon that indicates the progress of the query operation: - .. image:: ../../images/query-progress.png + .. image:: ../images/query-progress.png :align: center .. pull-quote:: @@ -142,5 +142,5 @@ To exclude ``if`` statements that have an ``else`` branch: Further reading --------------- -.. include:: ../../reusables/python-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/python-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/index.rst b/docs/codeql/codeql-language-guides/codeql-for-cpp.rst similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-cpp.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-csharp/index.rst b/docs/codeql/codeql-language-guides/codeql-for-csharp.rst similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-csharp/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-csharp.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/index.rst b/docs/codeql/codeql-language-guides/codeql-for-go.rst similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-go.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/index.rst b/docs/codeql/codeql-language-guides/codeql-for-java.rst similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-java/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-java.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-javascript/index.rst b/docs/codeql/codeql-language-guides/codeql-for-javascript.rst similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-javascript/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-javascript.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-python/index.rst b/docs/codeql/codeql-language-guides/codeql-for-python.rst similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-python/index.rst rename to docs/codeql/codeql-language-guides/codeql-for-python.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/codeql-library-for-cpp.rst b/docs/codeql/codeql-language-guides/codeql-library-for-cpp.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/codeql-library-for-cpp.rst rename to docs/codeql/codeql-language-guides/codeql-library-for-cpp.rst index 95d88e6cdc5..bd1f19be859 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/codeql-library-for-cpp.rst +++ b/docs/codeql/codeql-language-guides/codeql-library-for-cpp.rst @@ -527,5 +527,5 @@ This table lists `Preprocessor `__ on LG Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-javascript/data-flow-cheat-sheet-for-javascript.rst b/docs/codeql/codeql-language-guides/data-flow-cheat-sheet-for-javascript.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-javascript/data-flow-cheat-sheet-for-javascript.rst rename to docs/codeql/codeql-language-guides/data-flow-cheat-sheet-for-javascript.rst index 78c3bc0c811..77092e7d939 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-javascript/data-flow-cheat-sheet-for-javascript.rst +++ b/docs/codeql/codeql-language-guides/data-flow-cheat-sheet-for-javascript.rst @@ -225,5 +225,5 @@ Further reading - ":ref:`Exploring data flow with path queries `" -.. include:: ../../reusables/javascript-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file +.. include:: ../reusables/javascript-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/detecting-a-potential-buffer-overflow.rst b/docs/codeql/codeql-language-guides/detecting-a-potential-buffer-overflow.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/detecting-a-potential-buffer-overflow.rst rename to docs/codeql/codeql-language-guides/detecting-a-potential-buffer-overflow.rst index b3471128049..6b315860dcf 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/detecting-a-potential-buffer-overflow.rst +++ b/docs/codeql/codeql-language-guides/detecting-a-potential-buffer-overflow.rst @@ -226,5 +226,5 @@ The completed query will now identify cases where the result of ``strlen`` is st Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-python/expressions-and-statements-in-python.rst b/docs/codeql/codeql-language-guides/expressions-and-statements-in-python.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-python/expressions-and-statements-in-python.rst rename to docs/codeql/codeql-language-guides/expressions-and-statements-in-python.rst index 7c856ee8506..48cca630660 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-python/expressions-and-statements-in-python.rst +++ b/docs/codeql/codeql-language-guides/expressions-and-statements-in-python.rst @@ -258,6 +258,6 @@ Here is the relevant part of the class hierarchy: Further reading --------------- -.. include:: ../../reusables/python-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/python-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/expressions-types-and-statements-in-cpp.rst b/docs/codeql/codeql-language-guides/expressions-types-and-statements-in-cpp.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/expressions-types-and-statements-in-cpp.rst rename to docs/codeql/codeql-language-guides/expressions-types-and-statements-in-cpp.rst index fcd35768698..d7adc22c2cd 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/expressions-types-and-statements-in-cpp.rst +++ b/docs/codeql/codeql-language-guides/expressions-types-and-statements-in-cpp.rst @@ -134,5 +134,5 @@ Note that we replaced ``e.getEnclosingStmt()`` with ``e.getEnclosingStmt().getPa Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/functions-in-cpp.rst b/docs/codeql/codeql-language-guides/functions-in-cpp.rst similarity index 97% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/functions-in-cpp.rst rename to docs/codeql/codeql-language-guides/functions-in-cpp.rst index abf04311873..84d72e5376a 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/functions-in-cpp.rst +++ b/docs/codeql/codeql-language-guides/functions-in-cpp.rst @@ -94,5 +94,5 @@ The LGTM version of this query is considerably more complicated, but if you look Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-python/functions-in-python.rst b/docs/codeql/codeql-language-guides/functions-in-python.rst similarity index 96% rename from docs/codeql/codeql-language-guides/codeql-for-python/functions-in-python.rst rename to docs/codeql/codeql-language-guides/functions-in-python.rst index 3314bb7494c..cbbfe459f75 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-python/functions-in-python.rst +++ b/docs/codeql/codeql-language-guides/functions-in-python.rst @@ -83,6 +83,6 @@ In a later tutorial we will see how to use the type-inference library to find ca Further reading --------------- -.. include:: ../../reusables/python-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/python-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/hash-consing-and-value-numbering.rst b/docs/codeql/codeql-language-guides/hash-consing-and-value-numbering.rst similarity index 97% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/hash-consing-and-value-numbering.rst rename to docs/codeql/codeql-language-guides/hash-consing-and-value-numbering.rst index 1a064d9f27b..80f063386b8 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/hash-consing-and-value-numbering.rst +++ b/docs/codeql/codeql-language-guides/hash-consing-and-value-numbering.rst @@ -116,5 +116,5 @@ Example query Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst \ No newline at end of file diff --git a/docs/codeql/codeql-language-guides/index.rst b/docs/codeql/codeql-language-guides/index.rst index abd20af89e0..440b706a02a 100644 --- a/docs/codeql/codeql-language-guides/index.rst +++ b/docs/codeql/codeql-language-guides/index.rst @@ -7,10 +7,10 @@ Experiment and learn how to write effective and efficient queries for CodeQL dat .. toctree:: - codeql-for-cpp/index - codeql-for-csharp/index - codeql-for-go/index - codeql-for-java/index - codeql-for-javascript/index - codeql-for-python/index + codeql-for-cpp + codeql-for-csharp + codeql-for-go + codeql-for-java + codeql-for-javascript + codeql-for-python \ No newline at end of file diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/javadoc.rst b/docs/codeql/codeql-language-guides/javadoc.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-java/javadoc.rst rename to docs/codeql/codeql-language-guides/javadoc.rst index bed07e015e0..7e16cc6ce36 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/javadoc.rst +++ b/docs/codeql/codeql-language-guides/javadoc.rst @@ -223,5 +223,5 @@ Currently, ``visibleIn`` only considers single-type imports, but you could exten Further reading --------------- -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/modeling-data-flow-in-go-libraries.rst b/docs/codeql/codeql-language-guides/modeling-data-flow-in-go-libraries.rst similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/modeling-data-flow-in-go-libraries.rst rename to docs/codeql/codeql-language-guides/modeling-data-flow-in-go-libraries.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/navigating-the-call-graph.rst b/docs/codeql/codeql-language-guides/navigating-the-call-graph.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-java/navigating-the-call-graph.rst rename to docs/codeql/codeql-language-guides/navigating-the-call-graph.rst index f2490e58a6e..8b73b49153b 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/navigating-the-call-graph.rst +++ b/docs/codeql/codeql-language-guides/navigating-the-call-graph.rst @@ -166,5 +166,5 @@ Finally, on many Java projects there are methods that are invoked indirectly by Further reading --------------- -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/overflow-prone-comparisons-in-java.rst b/docs/codeql/codeql-language-guides/overflow-prone-comparisons-in-java.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-java/overflow-prone-comparisons-in-java.rst rename to docs/codeql/codeql-language-guides/overflow-prone-comparisons-in-java.rst index cd73cd1512a..b0762a5c139 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/overflow-prone-comparisons-in-java.rst +++ b/docs/codeql/codeql-language-guides/overflow-prone-comparisons-in-java.rst @@ -127,5 +127,5 @@ Now we rewrite our query to make use of these new classes: Further reading --------------- -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-python/pointer-analysis-and-type-inference-in-python.rst b/docs/codeql/codeql-language-guides/pointer-analysis-and-type-inference-in-python.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-python/pointer-analysis-and-type-inference-in-python.rst rename to docs/codeql/codeql-language-guides/pointer-analysis-and-type-inference-in-python.rst index 7ff754483b4..934fd9943c8 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-python/pointer-analysis-and-type-inference-in-python.rst +++ b/docs/codeql/codeql-language-guides/pointer-analysis-and-type-inference-in-python.rst @@ -228,6 +228,6 @@ Then we can use ``Value.getACall()`` to identify calls to the ``eval`` function, Further reading --------------- -.. include:: ../../reusables/python-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/python-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/refining-a-query-to-account-for-edge-cases.rst b/docs/codeql/codeql-language-guides/refining-a-query-to-account-for-edge-cases.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/refining-a-query-to-account-for-edge-cases.rst rename to docs/codeql/codeql-language-guides/refining-a-query-to-account-for-edge-cases.rst index cabefa4388f..d2a6cee326a 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/refining-a-query-to-account-for-edge-cases.rst +++ b/docs/codeql/codeql-language-guides/refining-a-query-to-account-for-edge-cases.rst @@ -151,5 +151,5 @@ Finally we can simplify the query by using the transitive closure operator. In t Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst b/docs/codeql/codeql-language-guides/types-in-java.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst rename to docs/codeql/codeql-language-guides/types-in-java.rst index 515bb2e7080..04cc716b961 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/types-in-java.rst +++ b/docs/codeql/codeql-language-guides/types-in-java.rst @@ -301,5 +301,5 @@ Adding these three improvements, our final query becomes: Further reading --------------- -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-javascript/using-flow-labels-for-precise-data-flow-analysis.rst b/docs/codeql/codeql-language-guides/using-flow-labels-for-precise-data-flow-analysis.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-javascript/using-flow-labels-for-precise-data-flow-analysis.rst rename to docs/codeql/codeql-language-guides/using-flow-labels-for-precise-data-flow-analysis.rst index 357b4638805..8bdecad86c3 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-javascript/using-flow-labels-for-precise-data-flow-analysis.rst +++ b/docs/codeql/codeql-language-guides/using-flow-labels-for-precise-data-flow-analysis.rst @@ -403,5 +403,5 @@ Further reading - ":ref:`Exploring data flow with path queries `" -.. include:: ../../reusables/javascript-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/javascript-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/using-range-analsis-in-cpp.rst b/docs/codeql/codeql-language-guides/using-range-analsis-in-cpp.rst similarity index 94% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/using-range-analsis-in-cpp.rst rename to docs/codeql/codeql-language-guides/using-range-analsis-in-cpp.rst index e8f8ce156f1..11f1da1259c 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/using-range-analsis-in-cpp.rst +++ b/docs/codeql/codeql-language-guides/using-range-analsis-in-cpp.rst @@ -47,5 +47,5 @@ This query uses ``upperBound`` to determine whether the result of ``snprintf`` i Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-cpp/using-the-guards-library-in-cpp.rst b/docs/codeql/codeql-language-guides/using-the-guards-library-in-cpp.rst similarity index 97% rename from docs/codeql/codeql-language-guides/codeql-for-cpp/using-the-guards-library-in-cpp.rst rename to docs/codeql/codeql-language-guides/using-the-guards-library-in-cpp.rst index b3cf98b96c2..250c9dd0c02 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-cpp/using-the-guards-library-in-cpp.rst +++ b/docs/codeql/codeql-language-guides/using-the-guards-library-in-cpp.rst @@ -98,6 +98,6 @@ The ``comparesLt`` predicate Further reading --------------- -.. include:: ../../reusables/cpp-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/cpp-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-javascript/using-type-tracking-for-api-modeling.rst b/docs/codeql/codeql-language-guides/using-type-tracking-for-api-modeling.rst similarity index 99% rename from docs/codeql/codeql-language-guides/codeql-for-javascript/using-type-tracking-for-api-modeling.rst rename to docs/codeql/codeql-language-guides/using-type-tracking-for-api-modeling.rst index fa52ce3d00b..88ab9536db7 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-javascript/using-type-tracking-for-api-modeling.rst +++ b/docs/codeql/codeql-language-guides/using-type-tracking-for-api-modeling.rst @@ -523,5 +523,5 @@ Type tracking is used in a few places in the standard libraries: Further reading --------------- -.. include:: ../../reusables/javascript-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/javascript-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-java/working-with-source-locations.rst b/docs/codeql/codeql-language-guides/working-with-source-locations.rst similarity index 98% rename from docs/codeql/codeql-language-guides/codeql-for-java/working-with-source-locations.rst rename to docs/codeql/codeql-language-guides/working-with-source-locations.rst index 7b570ce7d0e..9b55b95df52 100644 --- a/docs/codeql/codeql-language-guides/codeql-for-java/working-with-source-locations.rst +++ b/docs/codeql/codeql-language-guides/working-with-source-locations.rst @@ -188,5 +188,5 @@ Whitespace suggests that the programmer meant to toggle ``i`` between zero and o Further reading --------------- -.. include:: ../../reusables/java-further-reading.rst -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/java-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/ast.dot b/docs/codeql/images/codeql-for-go/ast.dot similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/ast.dot rename to docs/codeql/images/codeql-for-go/ast.dot diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/ast.png b/docs/codeql/images/codeql-for-go/ast.png similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/ast.png rename to docs/codeql/images/codeql-for-go/ast.png diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/cfg.dot b/docs/codeql/images/codeql-for-go/cfg.dot similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/cfg.dot rename to docs/codeql/images/codeql-for-go/cfg.dot diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/cfg.png b/docs/codeql/images/codeql-for-go/cfg.png similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/cfg.png rename to docs/codeql/images/codeql-for-go/cfg.png diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/cfg2.dot b/docs/codeql/images/codeql-for-go/cfg2.dot similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/cfg2.dot rename to docs/codeql/images/codeql-for-go/cfg2.dot diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/cfg2.png b/docs/codeql/images/codeql-for-go/cfg2.png similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/cfg2.png rename to docs/codeql/images/codeql-for-go/cfg2.png diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/dfg.dot b/docs/codeql/images/codeql-for-go/dfg.dot similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/dfg.dot rename to docs/codeql/images/codeql-for-go/dfg.dot diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/dfg.png b/docs/codeql/images/codeql-for-go/dfg.png similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/dfg.png rename to docs/codeql/images/codeql-for-go/dfg.png diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/ssa.dot b/docs/codeql/images/codeql-for-go/ssa.dot similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/ssa.dot rename to docs/codeql/images/codeql-for-go/ssa.dot diff --git a/docs/codeql/codeql-language-guides/codeql-for-go/ssa.png b/docs/codeql/images/codeql-for-go/ssa.png similarity index 100% rename from docs/codeql/codeql-language-guides/codeql-for-go/ssa.png rename to docs/codeql/images/codeql-for-go/ssa.png diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/about-codeql-queries.rst b/docs/codeql/writing-codeql-queries/about-codeql-queries.rst similarity index 100% rename from docs/codeql/writing-codeql-queries/codeql-queries/about-codeql-queries.rst rename to docs/codeql/writing-codeql-queries/about-codeql-queries.rst diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/about-data-flow-analysis.rst b/docs/codeql/writing-codeql-queries/about-data-flow-analysis.rst similarity index 100% rename from docs/codeql/writing-codeql-queries/codeql-queries/about-data-flow-analysis.rst rename to docs/codeql/writing-codeql-queries/about-data-flow-analysis.rst diff --git a/docs/codeql/writing-codeql-queries/ql-tutorials/catch-the-fire-starter.rst b/docs/codeql/writing-codeql-queries/catch-the-fire-starter.rst similarity index 99% rename from docs/codeql/writing-codeql-queries/ql-tutorials/catch-the-fire-starter.rst rename to docs/codeql/writing-codeql-queries/catch-the-fire-starter.rst index 0f40ba87a9a..60840e8bc9f 100644 --- a/docs/codeql/writing-codeql-queries/ql-tutorials/catch-the-fire-starter.rst +++ b/docs/codeql/writing-codeql-queries/catch-the-fire-starter.rst @@ -149,4 +149,4 @@ You have found the two fire starters! They are arrested and the villagers are on Further reading --------------- -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/index.rst b/docs/codeql/writing-codeql-queries/codeql-queries.rst similarity index 100% rename from docs/codeql/writing-codeql-queries/codeql-queries/index.rst rename to docs/codeql/writing-codeql-queries/codeql-queries.rst diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/creating-path-queries.rst b/docs/codeql/writing-codeql-queries/creating-path-queries.rst similarity index 100% rename from docs/codeql/writing-codeql-queries/codeql-queries/creating-path-queries.rst rename to docs/codeql/writing-codeql-queries/creating-path-queries.rst diff --git a/docs/codeql/writing-codeql-queries/ql-tutorials/cross-the-river.rst b/docs/codeql/writing-codeql-queries/cross-the-river.rst similarity index 99% rename from docs/codeql/writing-codeql-queries/ql-tutorials/cross-the-river.rst rename to docs/codeql/writing-codeql-queries/cross-the-river.rst index 0a69ff852cf..31d2913f590 100644 --- a/docs/codeql/writing-codeql-queries/ql-tutorials/cross-the-river.rst +++ b/docs/codeql/writing-codeql-queries/cross-the-river.rst @@ -269,4 +269,4 @@ Here are some more example queries that solve the river crossing puzzle: Further reading --------------- -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/writing-codeql-queries/ql-tutorials/crown-the-rightful-heir.rst b/docs/codeql/writing-codeql-queries/crown-the-rightful-heir.rst similarity index 99% rename from docs/codeql/writing-codeql-queries/ql-tutorials/crown-the-rightful-heir.rst rename to docs/codeql/writing-codeql-queries/crown-the-rightful-heir.rst index 9e987d7635d..a9a8ace0775 100644 --- a/docs/codeql/writing-codeql-queries/ql-tutorials/crown-the-rightful-heir.rst +++ b/docs/codeql/writing-codeql-queries/crown-the-rightful-heir.rst @@ -163,4 +163,4 @@ You could also try writing more of your own QL queries to find interesting facts Further reading --------------- -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/defining-the-results-of-a-query.rst b/docs/codeql/writing-codeql-queries/defining-the-results-of-a-query.rst similarity index 97% rename from docs/codeql/writing-codeql-queries/codeql-queries/defining-the-results-of-a-query.rst rename to docs/codeql/writing-codeql-queries/defining-the-results-of-a-query.rst index 347bb66576d..9b17b257ac9 100644 --- a/docs/codeql/writing-codeql-queries/codeql-queries/defining-the-results-of-a-query.rst +++ b/docs/codeql/writing-codeql-queries/defining-the-results-of-a-query.rst @@ -53,7 +53,7 @@ This basic select statement has two columns: #. Element to display the alert on: ``f`` corresponds to ``File``. #. String message to display: ``"This file is similar to another file."`` -.. image:: ../../images/ql-select-statement-basic.png +.. image:: ../images/ql-select-statement-basic.png :alt: Results of basic select statement :class: border @@ -69,7 +69,7 @@ The alert message defined by the basic select statement is constant and doesn't #. Element: ``f`` as before. #. String message: ``"This file is similar to "``—the string text is combined with the file name for the ``other``, similar file, returned by ``getBaseName()``. -.. image:: ../../images/ql-select-statement-filename.png +.. image:: ../images/ql-select-statement-filename.png :alt: Results of extended select statement :class: border @@ -104,7 +104,7 @@ You could go further and change the ``select`` statement to report on the simila The new elements added here don't need to be clickable, so we added them directly to the description string. -.. image:: ../../images/ql-select-statement-similarity.png +.. image:: ../images/ql-select-statement-similarity.png :alt: Results showing the extent of similarity :class: border diff --git a/docs/codeql/writing-codeql-queries/ql-tutorials/find-the-thief.rst b/docs/codeql/writing-codeql-queries/find-the-thief.rst similarity index 99% rename from docs/codeql/writing-codeql-queries/ql-tutorials/find-the-thief.rst rename to docs/codeql/writing-codeql-queries/find-the-thief.rst index c4ae5679ce1..d49406f90ca 100644 --- a/docs/codeql/writing-codeql-queries/ql-tutorials/find-the-thief.rst +++ b/docs/codeql/writing-codeql-queries/find-the-thief.rst @@ -294,4 +294,4 @@ Have you found the thief? Further reading --------------- -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst diff --git a/docs/codeql/writing-codeql-queries/index.rst b/docs/codeql/writing-codeql-queries/index.rst index f2aea92c4e5..2e6c8752ef0 100644 --- a/docs/codeql/writing-codeql-queries/index.rst +++ b/docs/codeql/writing-codeql-queries/index.rst @@ -12,5 +12,5 @@ Get to know more about queries and learn some key query-writing skills by solvin .. toctree:: :hidden: - ql-tutorials/index - codeql-queries/index + ql-tutorials + codeql-queries diff --git a/docs/codeql/writing-codeql-queries/ql-tutorials/introduction-to-ql.rst b/docs/codeql/writing-codeql-queries/introduction-to-ql.rst similarity index 100% rename from docs/codeql/writing-codeql-queries/ql-tutorials/introduction-to-ql.rst rename to docs/codeql/writing-codeql-queries/introduction-to-ql.rst diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/metadata-for-codeql-queries.rst b/docs/codeql/writing-codeql-queries/metadata-for-codeql-queries.rst similarity index 99% rename from docs/codeql/writing-codeql-queries/codeql-queries/metadata-for-codeql-queries.rst rename to docs/codeql/writing-codeql-queries/metadata-for-codeql-queries.rst index fc00f63216a..60a0dde85ad 100644 --- a/docs/codeql/writing-codeql-queries/codeql-queries/metadata-for-codeql-queries.rst +++ b/docs/codeql/writing-codeql-queries/metadata-for-codeql-queries.rst @@ -62,6 +62,6 @@ Here is the metadata for one of the standard Java queries: |image0| -.. |image0| image:: ../../images/query-metadata.png +.. |image0| image:: ../images/query-metadata.png For more examples of query metadata, see the standard CodeQL queries in our `GitHub repository `__. diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/providing-locations-in-codeql-queries.rst b/docs/codeql/writing-codeql-queries/providing-locations-in-codeql-queries.rst similarity index 100% rename from docs/codeql/writing-codeql-queries/codeql-queries/providing-locations-in-codeql-queries.rst rename to docs/codeql/writing-codeql-queries/providing-locations-in-codeql-queries.rst diff --git a/docs/codeql/writing-codeql-queries/ql-tutorials/index.rst b/docs/codeql/writing-codeql-queries/ql-tutorials.rst similarity index 100% rename from docs/codeql/writing-codeql-queries/ql-tutorials/index.rst rename to docs/codeql/writing-codeql-queries/ql-tutorials.rst diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/query-help-files.rst b/docs/codeql/writing-codeql-queries/query-help-files.rst similarity index 100% rename from docs/codeql/writing-codeql-queries/codeql-queries/query-help-files.rst rename to docs/codeql/writing-codeql-queries/query-help-files.rst diff --git a/docs/codeql/writing-codeql-queries/ql-tutorials/river-crossing-1.ql b/docs/codeql/writing-codeql-queries/river-crossing-1.ql similarity index 100% rename from docs/codeql/writing-codeql-queries/ql-tutorials/river-crossing-1.ql rename to docs/codeql/writing-codeql-queries/river-crossing-1.ql diff --git a/docs/codeql/writing-codeql-queries/ql-tutorials/river-crossing.ql b/docs/codeql/writing-codeql-queries/river-crossing.ql similarity index 100% rename from docs/codeql/writing-codeql-queries/ql-tutorials/river-crossing.ql rename to docs/codeql/writing-codeql-queries/river-crossing.ql diff --git a/docs/codeql/writing-codeql-queries/codeql-queries/troubleshooting-query-performance.rst b/docs/codeql/writing-codeql-queries/troubleshooting-query-performance.rst similarity index 99% rename from docs/codeql/writing-codeql-queries/codeql-queries/troubleshooting-query-performance.rst rename to docs/codeql/writing-codeql-queries/troubleshooting-query-performance.rst index ebe0d24d876..9444677917c 100644 --- a/docs/codeql/writing-codeql-queries/codeql-queries/troubleshooting-query-performance.rst +++ b/docs/codeql/writing-codeql-queries/troubleshooting-query-performance.rst @@ -153,4 +153,4 @@ Now the structure we want is clearer. We've separated out the easy part into its Further reading --------------- -.. include:: ../../reusables/codeql-ref-tools-further-reading.rst +.. include:: ../reusables/codeql-ref-tools-further-reading.rst