Skip to content

docs: list all required build dependencies and clang version in BUILDING.md #119

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
CEnnisgit wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: list all required build dependencies and clang version in BUILDING.md #119

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion .github/BUILDING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,13 @@

### The dependencies for Debian-like distributions.
```
sudo apt install build-essential cmake libunwind-dev libsox-dev git libasound2-dev nasm g++-14
sudo apt install build-essential cmake pkg-config libunwind-dev libsox-dev git libasound2-dev nasm g++-14 \
libudev-dev libxcb1-dev libx11-dev libwayland-dev libxkbcommon-dev libxrandr-dev \
libxinerama-dev libxcursor-dev libxi-dev libxext-dev
```

Without `pkg-config` and `libudev-dev` the configure step fails (Vulkan-Loader and hidapi respectively); without the X11/Wayland headers Vulkan-Loader and GLFW are built without window-system support. This list matches what CI installs (`.github/workflows/rpcsx.yml`).

### The dependencies for Fedora distributions:

```
Expand Down Expand Up @@ -34,3 +38,12 @@ For Ubuntu 24.04 you need to manually specify compiler version:
```
cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS_INIT="-march=native" -DCMAKE_CXX_COMPILER=g++-14 && cmake --build build -j$(nproc)
```

### Building with clang

clang 20 or newer is required: clang 18 rejects the codebase's C++23 relaxed `constexpr` (P2448, e.g. in `rx/StaticString.hpp` and `rpcsx/gpu/lib/gcn-shader/src/eval.cpp`), and clang 19 fails on the enum-reflection code in `rx/format.hpp` (its `-Wenum-constexpr-conversion` diagnostic is not SFINAE-friendly). The matching `clang-tools` package is also needed, since CMake invokes `clang-scan-deps` for dependency scanning:

```
sudo apt install clang-20 clang-tools-20
cmake -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_CXX_FLAGS_INIT="-march=native" -DCMAKE_C_COMPILER=clang-20 -DCMAKE_CXX_COMPILER=clang++-20 && cmake --build build -j$(nproc)
```