hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2025-12-17 01:03:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Address review feedback on system requirements

Browse Source
This commit is contained in:
Aditya Sharad
2022-09-30 14:11:47 -07:00
parent c187ae04f4
commit fdd71d4647
2 changed files with 19 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
docs/codeql/codeql-overview/system-requirements.rst
View File

@@ -15,10 +15,21 @@ Supported platforms
Additional software requirements
################################
- 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.
- On Linux, extraction of compiled languages (C/C++, C#, Go, Java) and Ruby requires ``glibc`` version 2.17 or greater.
- Extraction of these languages on ``musl-c``-based Linux distributions, such as Alpine Linux, is not supported.
- TypeScript extraction on all platforms requires Node.js to be installed and available on the ``PATH`` as ``node``.
- 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``.
- For Python 2 extraction, we also recommend having Python 2 installed and available on the ``PATH`` as ``python2``.
- On Windows, extraction of Python 2 or Python 3 requires the Python launcher to be installed and available on the ``PATH`` as ``py.exe``.
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.
In addition, CodeQL extraction has the following requirements.
For extraction of compiled languages (C/C++, C#, Go, Java) and Ruby on Linux:
- ``glibc`` version 2.17 or greater must be installed.
- ``musl-c``-based Linux distributions, such as Alpine Linux, are not supported.
For TypeScript extraction on all platforms:
- Node.js must be installed and available on the ``PATH`` as ``node``.
For Python extraction:
- On Linux and macOS, Python 3 must be installed and available on the ``PATH`` as ``python3`` or ``python``.
- For Python 2 extraction on Linux and macOS, we also recommend having Python 2 installed and available on the ``PATH`` as ``python2``.
- On Windows, the Python launcher must be installed and available on the ``PATH`` as ``py.exe``.

2
docs/codeql/support/reusables/platforms.rst
View File

@@ -20,7 +20,7 @@
macOS 12 Monterey","x86-64
x86-64, arm64 (Apple Silicon) [1]_
x86-64, arm64 (Apple Silicon)
x86-64, arm64 (Apple Silicon) [1]_"