Docs: Add CodeQL system requirements page#10612
Merged
Merged
Conversation
Add a table of platform requirements (OS, OS version, CPU architecture). Add a list of additional language-specific software requirements.
adityasharad
added
the
ready-for-doc-review
felicitymay
previously approved these changes
Sep 30, 2022
felicitymay
left a comment
felicitymay
left a comment
Contributor
There was a problem hiding this comment.
@adityasharad - thank you so much for rounding up this missing information 💖
I've made a couple of formatting suggestions, but generally this looks good 👍🏻
Comment on lines
+23
to
+29
| x86-64, arm64 (Apple Silicon) [1]_ | ||
|
|
||
| x86-64, arm64 (Apple Silicon) [1]_" | ||
|
|
||
| .. container:: footnote-group | ||
|
|
||
| .. [1] Support for Apple Silicon is currently in beta. |
Contributor
There was a problem hiding this comment.
I can see that this data correctly conveys the information, but sadly the interpretation from Sphinx is a little confusing.
I think that the best way around this might be to delete the footnote marker from lines 23 and 25, and instead attach it to the Operating system in line 17.
Collaborator
Author
There was a problem hiding this comment.
Or just put it on 25, so it appears below both mentions of Apple Silicon?
Comment on lines
+18
to
+24
| - 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``. |
Contributor
There was a problem hiding this comment.
Suggest we might reformat something like this:
Suggested change
| - 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. | |
| CodeQL tools have the following requirements. | |
| For 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 on all platforms: | |
| - Node.js must be installed and available on the ``PATH`` as ``node``. | |
| For Python: | |
| - 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``. |
adityasharad
dismissed stale reviews from felicitymay and tausbn
via
fdd71d4
Collaborator
Author
|
Thanks! I have addressed all comments (with minor tweaks). This will need a fresh approval, sorry. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a table of platform requirements (OS, OS version, CPU architecture).
Add a list of additional language-specific software requirements.
Preview:
