logiguard fork: GPUI xdg-activation keyboard-focus serial fix
Some checks failed
Update All Top Ranking Issues / update_top_ranking_issues (push) Has been cancelled
Triage Project Sync (#84) / Sync triage project (push) Has been cancelled
release_nightly / notify_on_failure (push) Has been cancelled
release_nightly / check_style (push) Has been cancelled
release_nightly / run_tests_windows (push) Has been cancelled
release_nightly / clippy_windows (push) Has been cancelled
release_nightly / bundle_linux_aarch64 (push) Has been cancelled
release_nightly / bundle_linux_x86_64 (push) Has been cancelled
release_nightly / bundle_mac_aarch64 (push) Has been cancelled
release_nightly / bundle_mac_x86_64 (push) Has been cancelled
release_nightly / bundle_windows_aarch64 (push) Has been cancelled
release_nightly / bundle_windows_x86_64 (push) Has been cancelled
release_nightly / build_nix_linux_x86_64 (push) Has been cancelled
release_nightly / build_nix_mac_aarch64 (push) Has been cancelled
release_nightly / update_nightly_tag (push) Has been cancelled
Hotfix Review Monitor / check-hotfix-reviews (push) Has been cancelled
Stale PR Review Reminder / check-stale-prs (push) Has been cancelled
Update Weekly Top Ranking Issues / update_top_ranking_issues (push) Has been cancelled
Bump collab-staging Tag / update-collab-staging-tag (push) Has been cancelled
compliance_check / scheduled_compliance_check (push) Has been cancelled
Some checks failed
Update All Top Ranking Issues / update_top_ranking_issues (push) Has been cancelled
Triage Project Sync (#84) / Sync triage project (push) Has been cancelled
release_nightly / notify_on_failure (push) Has been cancelled
release_nightly / check_style (push) Has been cancelled
release_nightly / run_tests_windows (push) Has been cancelled
release_nightly / clippy_windows (push) Has been cancelled
release_nightly / bundle_linux_aarch64 (push) Has been cancelled
release_nightly / bundle_linux_x86_64 (push) Has been cancelled
release_nightly / bundle_mac_aarch64 (push) Has been cancelled
release_nightly / bundle_mac_x86_64 (push) Has been cancelled
release_nightly / bundle_windows_aarch64 (push) Has been cancelled
release_nightly / bundle_windows_x86_64 (push) Has been cancelled
release_nightly / build_nix_linux_x86_64 (push) Has been cancelled
release_nightly / build_nix_mac_aarch64 (push) Has been cancelled
release_nightly / update_nightly_tag (push) Has been cancelled
Hotfix Review Monitor / check-hotfix-reviews (push) Has been cancelled
Stale PR Review Reminder / check-stale-prs (push) Has been cancelled
Update Weekly Top Ranking Issues / update_top_ranking_issues (push) Has been cancelled
Bump collab-staging Tag / update-collab-staging-tag (push) Has been cancelled
compliance_check / scheduled_compliance_check (push) Has been cancelled
Single-commit orphan branch: full zed-industries/zed @ 8c74db0 source tree with a 3-file patch applied (no upstream history). Patch (crates/gpui_linux/src/linux/wayland/): - serial.rs: add SerialKind::KeyboardEnter - client.rs: store wl_keyboard.enter serial; add latest_serial_of() - window.rs: activate() uses keyboard-enter serial (Mutter focus gate) Mutter honors window activation only when the token carries the keyboard- focus serial from wl_keyboard.enter; GPUI used a stale mouse-press serial. See docs/tray-window-focus-wayland.md in logiguard. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
197
docs/src/development/macos.md
Normal file
197
docs/src/development/macos.md
Normal file
@@ -0,0 +1,197 @@
|
||||
---
|
||||
title: Building Zed for macOS
|
||||
description: "Guide to building zed for macos for Zed development."
|
||||
---
|
||||
|
||||
# Building Zed for macOS
|
||||
|
||||
## Repository
|
||||
|
||||
Clone the [Zed repository](https://github.com/zed-industries/zed).
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Install [rustup](https://www.rust-lang.org/tools/install)
|
||||
|
||||
- Install [Xcode](https://apps.apple.com/us/app/xcode/id497799835?mt=12) from the macOS App Store or from the [Apple Developer](https://developer.apple.com/download/all/) website. The Apple Developer download requires a developer account.
|
||||
|
||||
> Launch Xcode after installation and install the macOS components (the default option).
|
||||
|
||||
- Install [Xcode command line tools](https://developer.apple.com/xcode/resources/)
|
||||
|
||||
```sh
|
||||
xcode-select --install
|
||||
```
|
||||
|
||||
- Ensure that the Xcode command line tools are using your newly installed copy of Xcode:
|
||||
|
||||
```sh
|
||||
sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
|
||||
sudo xcodebuild -license accept
|
||||
```
|
||||
|
||||
- Install `cmake` (required by [a dependency](https://docs.rs/wasmtime-c-api-impl/latest/wasmtime_c_api/))
|
||||
|
||||
```sh
|
||||
brew install cmake
|
||||
```
|
||||
|
||||
## Building Zed from Source
|
||||
|
||||
Once you have the dependencies installed, you can build Zed using [Cargo](https://doc.rust-lang.org/cargo/).
|
||||
|
||||
For a debug build:
|
||||
|
||||
```sh
|
||||
cargo run
|
||||
```
|
||||
|
||||
For a release build:
|
||||
|
||||
```sh
|
||||
cargo run --release
|
||||
```
|
||||
|
||||
And to run the tests:
|
||||
|
||||
```sh
|
||||
cargo test --workspace
|
||||
```
|
||||
|
||||
## Visual Regression Tests
|
||||
|
||||
Zed includes visual regression tests that capture screenshots of real Zed windows and compare them against baseline images. These tests require macOS with Screen Recording permission.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
You must grant Screen Recording permission to your terminal:
|
||||
|
||||
1. Run the visual test runner once - macOS will prompt for permission
|
||||
2. Or manually: System Settings > Privacy & Security > Screen Recording
|
||||
3. Enable your terminal app (e.g., Terminal.app, iTerm2, Ghostty)
|
||||
4. Restart your terminal after granting permission
|
||||
|
||||
### Running Visual Tests
|
||||
|
||||
```sh
|
||||
cargo run -p zed --bin zed_visual_test_runner --features visual-tests
|
||||
```
|
||||
|
||||
### Baseline Images
|
||||
|
||||
Baseline images are stored in `crates/zed/test_fixtures/visual_tests/` but are
|
||||
**gitignored** to avoid bloating the repository. You must generate them locally
|
||||
before running tests.
|
||||
|
||||
#### Initial Setup
|
||||
|
||||
Before making any UI changes, generate baseline images from a known-good state:
|
||||
|
||||
```sh
|
||||
git checkout origin/main
|
||||
UPDATE_BASELINE=1 cargo run -p zed --bin zed_visual_test_runner --features visual-tests
|
||||
git checkout -
|
||||
```
|
||||
|
||||
This creates baselines that reflect the current expected UI.
|
||||
|
||||
#### Updating Baselines
|
||||
|
||||
When UI changes are intentional, update the baseline images after your changes:
|
||||
|
||||
```sh
|
||||
UPDATE_BASELINE=1 cargo run -p zed --bin zed_visual_test_runner --features visual-tests
|
||||
```
|
||||
|
||||
> **Note:** In the future, baselines may be stored externally. For now, they
|
||||
> remain local-only to keep the git repository lightweight.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Error compiling metal shaders
|
||||
|
||||
```sh
|
||||
error: failed to run custom build command for gpui v0.1.0 (/Users/path/to/zed)`**
|
||||
|
||||
xcrun: error: unable to find utility "metal", not a developer tool or in PATH
|
||||
```
|
||||
|
||||
Try `sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer`
|
||||
|
||||
If you're on macOS 26, try `xcodebuild -downloadComponent MetalToolchain`.
|
||||
If that command fails, run `xcodebuild -runFirstLaunch` and try downloading the toolchain again.
|
||||
|
||||
### Cargo errors claiming that a dependency is using unstable features
|
||||
|
||||
Try `cargo clean` and `cargo build`.
|
||||
|
||||
### Error: 'dispatch/dispatch.h' file not found
|
||||
|
||||
If you encounter an error similar to:
|
||||
|
||||
```sh
|
||||
src/platform/mac/dispatch.h:1:10: fatal error: 'dispatch/dispatch.h' file not found
|
||||
|
||||
Caused by:
|
||||
process didn't exit successfully
|
||||
|
||||
--- stdout
|
||||
cargo:rustc-link-lib=framework=System
|
||||
cargo:rerun-if-changed=src/platform/mac/dispatch.h
|
||||
cargo:rerun-if-env-changed=TARGET
|
||||
cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS_aarch64-apple-darwin
|
||||
cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS_aarch64_apple_darwin
|
||||
cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS
|
||||
```
|
||||
|
||||
This file is part of Xcode. Make sure the Xcode command line tools are installed and the path is set correctly:
|
||||
|
||||
```sh
|
||||
xcode-select --install
|
||||
sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer
|
||||
```
|
||||
|
||||
Additionally, set the `BINDGEN_EXTRA_CLANG_ARGS` environment variable:
|
||||
|
||||
```sh
|
||||
export BINDGEN_EXTRA_CLANG_ARGS="--sysroot=$(xcrun --show-sdk-path)"
|
||||
```
|
||||
|
||||
Then clean and rebuild the project:
|
||||
|
||||
```sh
|
||||
cargo clean
|
||||
cargo run
|
||||
```
|
||||
|
||||
### Tests failing due to `Too many open files (os error 24)`
|
||||
|
||||
This error seems to be caused by OS resource constraints. Installing and running tests with `cargo-nextest` should resolve the issue.
|
||||
|
||||
- `cargo install cargo-nextest --locked`
|
||||
- `cargo nextest run --workspace --no-fail-fast`
|
||||
|
||||
## Tips & Tricks
|
||||
|
||||
### Avoiding continual rebuilds
|
||||
|
||||
If Zed continually rebuilds root crates, you may be opening the Zed codebase itself in your development build.
|
||||
|
||||
This causes problems because `cargo run` exports a bunch of environment
|
||||
variables which are picked up by the `rust-analyzer` that runs in the development
|
||||
build of Zed. These environment variables are in turn passed to `cargo check`, which
|
||||
invalidates the build cache of some of the crates we depend on.
|
||||
|
||||
To avoid this, run the built binary against a different project, for example `cargo run ~/path/to/other/project`.
|
||||
|
||||
### Speeding up verification
|
||||
|
||||
If you build Zed frequently, macOS may keep verifying new builds, which can add a few seconds to each iteration.
|
||||
|
||||
To fix this, you can:
|
||||
|
||||
- Run `sudo spctl developer-mode enable-terminal` to enable the Developer Tools panel in System Settings.
|
||||
- In System Settings, search for "Developer Tools" and add your terminal (e.g. iTerm or Ghostty) to the list under "Allow applications to use developer tools"
|
||||
- Restart your terminal.
|
||||
|
||||
Thanks to the nextest developers for publishing [this](https://nexte.st/docs/installation/macos/#gatekeeper).
|
||||
Reference in New Issue
Block a user