Skip to content

Commit fdd71d4

Browse files
committed
Docs: Address review feedback on system requirements
1 parent c187ae0 commit fdd71d4

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

docs/codeql/codeql-overview/system-requirements.rst

Lines changed: 18 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,21 @@ Supported platforms
1515
Additional software requirements
1616
################################
1717

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``.
18+
To generate a CodeQL database for a compiled language, you must ensure that the system can successfully build and compile your code, independently of CodeQL.
19+
20+
In addition, CodeQL extraction has the following requirements.
21+
22+
For extraction of compiled languages (C/C++, C#, Go, Java) and Ruby on Linux:
23+
24+
- ``glibc`` version 2.17 or greater must be installed.
25+
- ``musl-c``-based Linux distributions, such as Alpine Linux, are not supported.
26+
27+
For TypeScript extraction on all platforms:
28+
29+
- Node.js must be installed and available on the ``PATH`` as ``node``.
30+
31+
For Python extraction:
32+
33+
- On Linux and macOS, Python 3 must be installed and available on the ``PATH`` as ``python3`` or ``python``.
34+
- For Python 2 extraction on Linux and macOS, we also recommend having Python 2 installed and available on the ``PATH`` as ``python2``.
35+
- On Windows, the Python launcher must be installed and available on the ``PATH`` as ``py.exe``.

docs/codeql/support/reusables/platforms.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020

2121
macOS 12 Monterey","x86-64
2222

23-
x86-64, arm64 (Apple Silicon) [1]_
23+
x86-64, arm64 (Apple Silicon)
2424

2525
x86-64, arm64 (Apple Silicon) [1]_"
2626

0 commit comments

Comments
 (0)