Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 5002968

Browse files
author
james
committed
restructure codeql docs
1 parent 4d89838 commit 5002968

95 files changed

Lines changed: 149 additions & 149 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/codeql/codeql-cli/codeql-cli-reference/about-ql-packs.rst renamed to docs/codeql/codeql-cli/about-ql-packs.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -85,11 +85,11 @@ The following properties are supported in ``qlpack.yml`` files.
8585
* - ``suites``
8686
- ``suites``
8787
- Optional
88-
- 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>`."
88+
- 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 <creating-codeql-query-suites>`."
8989
* - ``extractor``
9090
- ``javascript``
9191
- All test packs
92-
- 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>`."
92+
- 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 <testing-custom-queries>`."
9393
* - ``tests``
9494
- ``.``
9595
- Optional for test packs
@@ -124,7 +124,7 @@ and ``libraryPathDependencies`` properties. If the pack contains query suites, y
124124
use the ``suites`` property to define their location. Query suites defined
125125
here are called "well-known" suites, and can be used on the command line by referring to
126126
their name only, rather than their full path.
127-
For more information about query suites, see ":doc:`Creating CodeQL query suites <../using-the-codeql-cli/creating-codeql-query-suites>`."
127+
For more information about query suites, see ":doc:`Creating CodeQL query suites <creating-codeql-query-suites>`."
128128

129129
For example, a ``qlpack.yml`` file for a QL pack featuring custom C++ queries
130130
and libraries may contain:
@@ -154,10 +154,10 @@ For custom QL packs containing test files, you also need to include an
154154
``extractor`` property so that the ``test run`` command knows how to create test
155155
databases. You may also wish to specify the ``tests`` property.
156156

157-
.. include:: ../../reusables/test-qlpack.rst
157+
.. include:: ../reusables/test-qlpack.rst
158158

159159
For more information about running tests, see ":doc:`Testing custom queries
160-
<../using-the-codeql-cli/testing-custom-queries>`."
160+
<testing-custom-queries>`."
161161

162162
.. _standard-ql-packs:
163163

docs/codeql/codeql-cli/using-the-codeql-cli/about-the-codeql-cli.rst renamed to docs/codeql/codeql-cli/about-the-codeql-cli.rst

File renamed without changes.

docs/codeql/codeql-cli/using-the-codeql-cli/analyzing-databases-with-the-codeql-cli.rst renamed to docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ CodeQL analyses produce :ref:`interpreted results
1111
For information about writing queries to run with ``database analyze``, see
1212
":doc:`Using custom queries with the CodeQL CLI <using-custom-queries-with-the-codeql-cli>`."
1313

14-
.. include:: ../../reusables/advanced-query-execution.rst
14+
.. include:: ../reusables/advanced-query-execution.rst
1515

1616
Before starting an analysis you must:
1717

@@ -55,7 +55,7 @@ You must specify:
5555

5656
You can also specify:
5757

58-
- .. include:: ../../reusables/threads-query-execution.rst
58+
- .. include:: ../reusables/threads-query-execution.rst
5959

6060

6161
.. pull-quote::
@@ -149,7 +149,7 @@ recursively, so any queries contained in subfolders will also be executed.
149149
Important
150150

151151
You shouldn't specify the root of a :doc:`QL pack
152-
<../codeql-cli-reference/about-ql-packs>` when executing ``database analyze``
152+
<about-ql-packs>` when executing ``database analyze``
153153
as it contains some special queries that aren't designed to be used with
154154
the command. Rather, to run a wide range of useful queries, run one of the
155155
LGTM.com query suites.
@@ -171,7 +171,7 @@ You can save analysis results in a number of different formats, including SARIF
171171
and CSV.
172172

173173
The SARIF format is designed to represent the output of a broad range of static
174-
analysis tools. For more information, see :doc:`SARIF output <../codeql-cli-reference/sarif-output>`.
174+
analysis tools. For more information, see :doc:`SARIF output <sarif-output>`.
175175

176176
If you choose to generate results in CSV format, then each line in the output file
177177
corresponds to an alert. Each line is a comma-separated list with the following information:

docs/codeql/codeql-cli/codeql-cli-reference/index.rst renamed to docs/codeql/codeql-cli/codeql-cli-reference.rst

File renamed without changes.

docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-databases.rst renamed to docs/codeql/codeql-cli/creating-codeql-databases.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ You must specify:
3535
- ``--language``: the identifier for the language to create a database for.
3636
CodeQL supports creating databases for the following languages:
3737

38-
.. include:: ../../reusables/extractors.rst
38+
.. include:: ../reusables/extractors.rst
3939

4040
Other options may be specified depending on the location of your source file and
4141
the language you want to analyze:
@@ -75,7 +75,7 @@ CodeQL. For each project on LGTM.com, you can download an archived CodeQL
7575
database corresponding to the most recently analyzed revision of the code. These
7676
databases can also be analyzed using the CodeQL CLI.
7777

78-
.. include:: ../../reusables/download-lgtm-database.rst
78+
.. include:: ../reusables/download-lgtm-database.rst
7979

8080
Before running an analysis, unzip the databases and try :doc:`upgrading <upgrading-codeql-databases>` the
8181
unzipped databases to ensure they are compatible with your local copy of the
@@ -85,7 +85,7 @@ CodeQL queries and libraries.
8585

8686
Note
8787

88-
.. include:: ../../reusables/index-files-note.rst
88+
.. include:: ../reusables/index-files-note.rst
8989

9090
Creating databases for non-compiled languages
9191
---------------------------------------------

docs/codeql/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.rst renamed to docs/codeql/codeql-cli/creating-codeql-query-suites.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ suite definition have been executed, the result is a set of selected queries.
1919
.. note::
2020

2121
Any custom queries that you want to add to a query suite must be in a :doc:`QL
22-
pack <../codeql-cli-reference/about-ql-packs>` and contain the correct query metadata.
22+
pack <about-ql-packs>` and contain the correct query metadata.
2323
For more information, see
2424
":doc:`Using custom queries with the CodeQL CLI <using-custom-queries-with-the-codeql-cli>`."
2525

@@ -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 <../codeql-cli-reference/qlpack-overview.html#qlpack-yml-properties>`__."
257+
For more information, see "`About QL packs <qlpack-overview.html#qlpack-yml-properties>`__."
258258

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

docs/codeql/codeql-cli/codeql-cli-reference/exit-codes.rst renamed to docs/codeql/codeql-cli/exit-codes.rst

File renamed without changes.

docs/codeql/codeql-cli/using-the-codeql-cli/getting-started-with-the-codeql-cli.rst renamed to docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Getting started with the CodeQL CLI
66
To run CodeQL commands, you need to set up the CLI so that it can access
77
the tools, queries, and libraries required to create and analyze databases.
88

9-
.. include:: ../../reusables/license-note.rst
9+
.. include:: ../reusables/license-note.rst
1010

1111
.. _setting-up-cli:
1212

@@ -115,7 +115,7 @@ repository should be ``$HOME/codeql-home/codeql-go``.
115115
Within these repositories, the queries and libraries are organized into QL
116116
packs. Along with the queries themselves, QL packs contain important metadata
117117
that tells the CodeQL CLI how to process the query files. For more information,
118-
see ":doc:`About QL packs <../codeql-cli-reference/about-ql-packs>`."
118+
see ":doc:`About QL packs <about-ql-packs>`."
119119

120120
.. pull-quote:: Important
121121

‎docs/codeql/codeql-cli/index.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ CodeQL CLI
1010

1111
- :ref:`CodeQL CLI reference <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.
1212

13-
- `CodeQL CLI manual <codeql-cli-manual>`__: Detailed information about all the commands available with the CodeQL CLI.
13+
- `CodeQL CLI manual <../codeql-cli-manual>`__: Detailed information about all the commands available with the CodeQL CLI.
1414

1515
.. toctree::
1616
:titlesonly:
1717
:hidden:
1818

19-
using-the-codeql-cli/index
20-
codeql-cli-reference/index
19+
using-the-codeql-cli
20+
codeql-cli-reference
2121

docs/codeql/codeql-cli/codeql-cli-reference/query-reference-files.rst renamed to docs/codeql/codeql-cli/query-reference-files.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ to the ``codeql-javascript`` QL pack::
4444

4545
AngularJS/DeadAngularJSEventListener.ql
4646

47-
For another example, see `Testing custom queries <../using-the-codeql-cli/test-queries.html#example>`__.
47+
For another example, see `Testing custom queries <test-queries.html#example>`__.

0 commit comments

Comments
 (0)