Skip to content

docs: install Xcode's Metal Toolchain component before a Mac build - #1049

Open
akol1 wants to merge 1 commit into
ashhart:mainfrom
akol1:docs/metal-toolchain-component
Open

akol1 wants to merge 1 commit into
ashhart:mainfrom
akol1:docs/metal-toolchain-component

Conversation

@akol1

@akol1 akol1 commented Oct 18, 2026

Copy link
Copy Markdown
Contributor

What this changes

The build instructions say "On a Mac with Xcode's Metal toolchain" but not where that toolchain comes from. With only the Command Line Tools, every .metal compile fails with unable to find utility "metal", including in the reference suites. One paragraph now names full Xcode, its Metal Toolchain component and the install command.

Receipt

A change to documentation alone needs no receipt. The failure was seen on a clean clone, macOS on Apple silicon, with the pinned Zig 0.17.0 and the Command Line Tools only; installing the Metal Toolchain component made the Metal suites build and pass.

Checklist

The serving, drafting, precision and speed items below describe engine behaviour, which this change does not touch.

  • Every token still goes through the lane rounds. No serial path, and nothing that needs drafts off.
  • Drafted output equals "draft": false, a resumed prompt equals a fresh one, and concurrent equals solo.
  • No precision traded for speed. If the bits change, the description says which sums change and why.
  • Prompt processing is no slower than the last release.
  • The description says which platforms I ran, Metal M1 to M5 and CUDA, and which I could not.
  • New tests fail before the change, pass after it, and skip cleanly without their dependency.
  • Comments and docstrings are one line. No measurements or history in the source.
  • No personal data, machine names, internal hosts or local paths. No AI attribution lines.

The `.metal` sources need `metal` from the Metal Toolchain component of full
Xcode. With only the Command Line Tools every kernel compile fails with
`unable to find utility "metal"`, including the reference suites, so the build
instructions name the requirement and the component install command.
@ashhart

ashhart commented Oct 18, 2026

Copy link
Copy Markdown
Owner

Thanks @akol1, this is right: with only the Command Line Tools every .metal compile fails, and the README never said where the compiler comes from. It's queued for 1.1.2 as your commit. We'll also refresh the version in the example build command just below it.

Posted by Ash's AI Assistant Synthena

@akol1 akol1 closed this Oct 19, 2026
@akol1 akol1 reopened this Oct 19, 2026
@ashhart

ashhart commented Oct 19, 2026

Copy link
Copy Markdown
Owner

Thanks @akol1. We've prepared the docs change against the current public README and runbook, with credit for #1049. It names full Xcode, selecting its developer directory and installing the Metal Toolchain component, and links the standalone Metal checks to that setup. The existing Zig and release versions stay unchanged; the source build uses the manifest's version rather than adding an override. We'll land this as a small docs update independently of the next engine binary.

Posted by Ash's AI Assistant Synthena

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants