Skip to content

Docs: add linux-arm64 to supported platforms - #22444

Open
redsun82 wants to merge 2 commits into
mainfrom
redsun82-docs-linux-arm64-supported-platform
Open

Docs: add linux-arm64 to supported platforms#22444
redsun82 wants to merge 2 commits into
mainfrom
redsun82-docs-linux-arm64-supported-platform

Conversation

@redsun82

@redsun82 redsun82 commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Why

Linux on arm64 is becoming a supported CodeQL platform, so the customer-facing supported-platforms matrix (published to codeql.github.com) needs to list it. While here, the existing Apple Silicon footnote is clarified and brought up to date.

What changed

Single file: docs/codeql/reusables/supported-platforms.rst (a reusable .. include::-d by system-requirements.rst).

  • Linux row: add arm64 alongside x86-64, marked beta via a new [1] footnote. Footnotes are numbered by their order of appearance in the table (Linux [1], macOS [2]).
  • Apple Silicon footnote ([2]): replace the old "currently in beta" line with practical guidance on when Rosetta 2 is needed. Building your code during analysis requires Rosetta 2; analyzing an interpreted language or using build mode none runs natively. Apple Silicon is well past beta, so the beta wording is dropped.

Release timing

These docs publish with the next CodeQL release, which lines up with the public Linux arm64 rollout, so there is no risk of documenting the platform ahead of availability.

Open decision

The Linux arm64 entry is drafted as beta. Flipping it to GA is a one-line change: drop the [1] footnote reference from the Linux cell and remove the [1] definition.

Validation

The csv-table parses cleanly under docutils --strict; both footnote references resolve. Docs-only change, no build/test impact.

redsun82 and others added 2 commits August 27, 2026 11:11
Add arm64 to the Linux row of the customer-facing supported-platforms
table, following the existing macOS Apple Silicon precedent. Marked as
beta via a new footnote.

Part of native Linux Arm64 support. Release-gated: must land together
with the actual arm release.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Replace the Apple Silicon supported-platforms footnote with guidance on
when Rosetta 2 is needed: building your code during analysis requires
Rosetta 2, while analyzing an interpreted language or using build mode
none runs natively.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@redsun82 redsun82 changed the title [Do not merge] Docs: add linux-arm64 to supported platforms Docs: add linux-arm64 to supported platforms Aug 27, 2026
@redsun82
redsun82 marked this pull request as ready for review August 27, 2026 10:05
@redsun82
redsun82 requested a review from a team as a code owner August 27, 2026 10:05
Copilot AI balanced review requested due to automatic review settings August 27, 2026 10:05

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates supported-platform documentation for Linux arm64 and clarifies Apple Silicon requirements.

Changes:

  • Adds beta Linux arm64 support.
  • Clarifies when Apple Silicon requires Rosetta 2.
Show a summary per file
File Description
docs/codeql/reusables/supported-platforms.rst Updates platform architecture entries and footnotes.

Review details

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Balanced


.. [1] Support for Apple Silicon is currently in beta.
.. [1] Support for Linux on arm64 is currently in beta.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we generally don't have empty lines between these.

Suggested change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants