### Title Update macOS Development Documentation with Dispatch.h Error Solution ### Description This PR updates the macOS development documentation to include a solution for the `dispatch/dispatch.h` file not found error. This error is encountered during local development when using the `cargo run` command. The documentation now includes steps to ensure the Xcode command line tools are properly installed and set, and instructions to set the `BINDGEN_EXTRA_CLANG_ARGS` environment variable. ### Changes - Added troubleshooting section for `dispatch/dispatch.h` error in `development/macos.md`. ### Related Issues - Closes [#11963](https://github.com/zed-industries/zed/issues/11963) ### Testing Instructions 1. Follow the steps in the updated `development/macos.md` to configure your environment. 2. Run `cargo clean` and `cargo run` to ensure the build completes successfully. Release Notes: - N/A
Unified · Split
| @@ -83,3 +83,42 @@ Try `sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer` · 82 unmodified lines | |||
| 83 | ### Cargo errors claiming that a dependency is using unstable features | 83 | ### Cargo errors claiming that a dependency is using unstable features |
| 84 | 84 | ||
| 85 | Try `cargo clean` and `cargo build`. | 85 | Try `cargo clean` and `cargo build`. |
| 86 | |||
| 87 | ### Error: 'dispatch/dispatch.h' file not found | ||
| 88 | |||
| 89 | If you encounter an error similar to: | ||
| 90 | |||
| 91 | ```bash | ||
| 92 | src/platform/mac/dispatch.h:1:10: fatal error: 'dispatch/dispatch.h' file not found | ||
| 93 | |||
| 94 | Caused by: | ||
| 95 | process didn't exit successfully | ||
| 96 | |||
| 97 | --- stdout | ||
| 98 | cargo:rustc-link-lib=framework=System | ||
| 99 | cargo:rerun-if-changed=src/platform/mac/dispatch.h | ||
| 100 | cargo:rerun-if-env-changed=TARGET | ||
| 101 | cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS_aarch64-apple-darwin | ||
| 102 | cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS_aarch64_apple_darwin | ||
| 103 | cargo:rerun-if-env-changed=BINDGEN_EXTRA_CLANG_ARGS | ||
| 104 | ``` | ||
| 105 | |||
| 106 | This file is part of Xcode. Ensure you have installed the Xcode command line tools and set the correct path: | ||
| 107 | |||
| 108 | ```bash | ||
| 109 | xcode-select --install | ||
| 110 | sudo xcode-select --switch /Applications/Xcode.app/Contents/Developer | ||
| 111 | ``` | ||
| 112 | |||
| 113 | Additionally, set the `BINDGEN_EXTRA_CLANG_ARGS` environment variable: | ||
| 114 | |||
| 115 | ```bash | ||
| 116 | export BINDGEN_EXTRA_CLANG_ARGS="--sysroot=$(xcrun --show-sdk-path)" | ||
| 117 | ``` | ||
| 118 | |||
| 119 | Then clean and rebuild the project: | ||
| 120 | |||
| 121 | ```bash | ||
| 122 | cargo clean | ||
| 123 | cargo run | ||
| 124 | ``` | ||