Skip to content

Commit c187ae0

Browse files
committed
Docs: Add CodeQL system requirements page
Add a table of platform requirements (OS, OS version, CPU architecture). Add a list of additional language-specific software requirements.
1 parent df2b586 commit c187ae0

File tree

4 files changed

+63
-0
lines changed

4 files changed

+63
-0
lines changed

docs/codeql/codeql-overview/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ Learn more about how CodeQL works, the languages and libraries supported by Code
99

1010
- :doc:`Supported languages and frameworks <supported-languages-and-frameworks>`: View the languages, libraries, and frameworks supported in the latest version of CodeQL.
1111

12+
- :doc:`System requirements <system-requirements>`: View the system requirements for running the latest version of CodeQL.
13+
1214
- :doc:`CodeQL tools <codeql-tools>`: GitHub provides the CodeQL command-line interface and CodeQL for Visual Studio Code for performing CodeQL analysis on open source codebases.
1315

1416
- :doc:`CodeQL glossary <codeql-glossary>`: An overview of the technical terms and concepts in CodeQL.
@@ -19,6 +21,7 @@ Learn more about how CodeQL works, the languages and libraries supported by Code
1921

2022
about-codeql
2123
supported-languages-and-frameworks
24+
system-requirements
2225
codeql-tools
2326
codeql-glossary
2427

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
:tocdepth: 1
2+
3+
.. _system-requirements:
4+
5+
System requirements
6+
-------------------
7+
8+
System requirements for running the latest version of CodeQL.
9+
10+
Supported platforms
11+
#######################
12+
13+
.. include:: ../support/reusables/platforms.rst
14+
15+
Additional software requirements
16+
################################
17+
18+
- For extraction of compiled languages on all platforms, the system must be configured so that it can successfully build and compile your code, independently of CodeQL.
19+
- On Linux, extraction of compiled languages (C/C++, C#, Go, Java) and Ruby requires ``glibc`` version 2.17 or greater.
20+
- Extraction of these languages on ``musl-c``-based Linux distributions, such as Alpine Linux, is not supported.
21+
- TypeScript extraction on all platforms requires Node.js to be installed and available on the ``PATH`` as ``node``.
22+
- On Linux and macOS, extraction of Python 2 or Python 3 requires Python 3 to be installed and available on the ``PATH`` as ``python3`` or ``python``.
23+
- For Python 2 extraction, we also recommend having Python 2 installed and available on the ``PATH`` as ``python2``.
24+
- On Windows, extraction of Python 2 or Python 3 requires the Python launcher to be installed and available on the ``PATH`` as ``py.exe``.

docs/codeql/index.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,13 @@ <h3 class="Box-title text-mono f3 text-center">
9797
<div class="Subhead-description">View the languages, libraries, and frameworks supported in the
9898
latest version of CodeQL...</div>
9999
</div>
100+
<div class="Subhead border-0">
101+
<a href="codeql-overview/system-requirements/">
102+
<div class="Subhead-heading f4 text-center">System requirements</div>
103+
</a>
104+
<div class="Subhead-description">View the system requirements for running the
105+
latest version of CodeQL...</div>
106+
</div>
100107
<div class="Subhead border-0">
101108
<a href="../publications">
102109
<div class="Subhead-heading f4 text-center">Academic publications</div>
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
.. csv-table::
2+
:header-rows: 1
3+
:widths: auto
4+
:stub-columns: 1
5+
6+
Operating system,Supported versions,Supported CPU architectures
7+
Linux,"Ubuntu 18.04
8+
9+
Ubuntu 20.04
10+
11+
Ubuntu 21.04
12+
13+
Ubuntu 22.04","x86-64"
14+
Windows,"Windows 10 / Windows Server 2019
15+
16+
Windows 11 / Windows Server 2022","x86-64"
17+
macOS,"macOS 10.15 Catalina
18+
19+
macOS 11 Big Sur
20+
21+
macOS 12 Monterey","x86-64
22+
23+
x86-64, arm64 (Apple Silicon) [1]_
24+
25+
x86-64, arm64 (Apple Silicon) [1]_"
26+
27+
.. container:: footnote-group
28+
29+
.. [1] Support for Apple Silicon is currently in beta.

0 commit comments

Comments
 (0)