Skip to content

docs(build): add macOS relinker prerequisites - #9471

Merged
adriadam10 merged 1 commit into
boykopovar:mainfrom
EnriqueDev2002:docs/macos-relinker-prerequisites
Oct 25, 2026
Merged

adriadam10 merged 1 commit into
boykopovar:mainfrom
EnriqueDev2002:docs/macos-relinker-prerequisites

Conversation

@EnriqueDev2002

Copy link
Copy Markdown
Contributor

What

Name the commands that provide the toolchain for the relinker-only build on macOS: xcode-select --install for AppleClang, brew install cmake ninja for CMake and Ninja. One sentence in the existing macOS mention of the Relinker only section; Linux and Windows already name their packages and toolchain there.

Tested

macOS 27.0.1 on Apple Silicon (arm64), AppleClang 21.0.0, CMake 4.4.4 and Ninja 1.13.2 from Homebrew 7.0.7, Python 3.14.6 from Homebrew.

brew install cmake ninja was run on this machine and provided both tools. xcode-select --install was not run here because the command-line tools were already installed at /Library/Developer/CommandLineTools.

Relinker-only build from a clean checkout of main (a6dcea9), with the commands of the section:

cmake -S . -B build-relinker -G Ninja -DCMAKE_BUILD_TYPE=Release -DANYPS5_RELINKER_ONLY=ON -DBUILD_TESTING=ON
cmake --build build-relinker --parallel
ctest --test-dir build-relinker --output-on-failure

Configure found Python 3.14; build 237 steps in 19 s; 100% tests passed out of 229; ctest -N lists input_magic (#199). python3 tools/check_conventions.py passed and python3 tools/pr_overlap.py --branch docs/macos-relinker-prerequisites reports no overlap.

Checklist

  • Based on current main; no other open PR implements the same functions
  • One topic per PR; follow-ups go in a new PR
  • No comments in code except technical debt
  • Unimplemented paths throw (NotImplemented_nid_no_patch); silent stubs are listed under Silent stubs in their library's technical debt file
  • No notes, investigation .md files or images added to the repository (attach them to this PR)
  • New third-party code is a submodule built from source
  • Generic behaviour, not specific to one title
  • Depends on: none
  • Fixes: none
  • Unblocks: none
  • GPUs tested: n/a
  • AI-assisted: yes

🤖 Generated with Claude Code

@MarcZX10 MarcZX10 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.

Reviewed the one-line relinker-only prerequisite clarification. It names AppleClang’s Xcode Command Line Tools installer and Homebrew packages for CMake/Ninja; the submitted clean-checkout test report includes the full relinker-only build and all 229 registered tests on Apple Silicon. Conventions, intake, and labels pass. No hosted full build was run for this documentation-only change.

@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Some comparisons could not be completed because a pull request conflicts with the base branch. Review these shared files manually before concluding that there is no overlap.

Pull request Shared files not compared
PR 674 docs/dev/BUILD.md
PR 1835 docs/dev/BUILD.md
PR 5021 docs/dev/BUILD.md

@github-actions github-actions Bot added the needs rebase Conflicts with main, rebase needed label Oct 22, 2026

@MarcZX10 MarcZX10 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.

The macOS prerequisite sentence is accurate and the author reports a clean relinker-only build plus all 229 registered tests on Apple Silicon. The #8087 overlap named by the earlier bot is now merged; its added Windows/MSYS2 guidance is separate from this macOS sentence. This branch and test report are based on a6dcea9, while upstream main is now ab347d1. Please rebase/update the branch and refresh the conventions/overlap checks against current main; the hosted docs-path checks pass. I did not run local tests.

@github-actions github-actions Bot added the docs label Oct 22, 2026
Name the commands that provide the compiler, CMake and Ninja on macOS
next to the existing mention of AppleClang in the relinker-only section.

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>
@EnriqueDev2002
EnriqueDev2002 force-pushed the docs/macos-relinker-prerequisites branch from 912bbaa to c5dd9c1 Compare October 22, 2026 11:50
@EnriqueDev2002

Copy link
Copy Markdown
Contributor Author

Rebased onto current main (8b3a6ba); the conflict with the merged #8087 is resolved keeping both the Windows and the macOS clauses. Refreshed on the rebased branch: conventions check passes, overlap report shows no line conflicts, relinker-only build and 230/230 tests pass on Apple Silicon.

@github-actions github-actions Bot removed the needs rebase Conflicts with main, rebase needed label Oct 22, 2026
@adriadam10 adriadam10 self-assigned this Oct 25, 2026
@adriadam10
adriadam10 dismissed MarcZX10’s stale review October 25, 2026 14:41

Dismissing a stale review: the requested changes were addressed after it (new head) and the merge queue blocks on it. Please request changes again if anything is still open.

@adriadam10
adriadam10 merged commit bd03896 into boykopovar:main Oct 25, 2026
9 checks passed
@adriadam10

Copy link
Copy Markdown
Collaborator

Checked the one-line change against docs/dev/BUILD.md: the commands match the existing macOS wording, the rebase kept both the Windows and macOS clauses, and Conventions and labels pass; merged.

@EnriqueDev2002
EnriqueDev2002 deleted the docs/macos-relinker-prerequisites branch October 26, 2026 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants