From 4b4fca3224ab977dc515ac0bb78d00b3dfa71e00 Mon Sep 17 00:00:00 2001 From: outfoxxed Date: Thu, 21 May 2026 23:12:13 -0700 Subject: [PATCH] docs: document private ABI usage --- BUILD.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/BUILD.md b/BUILD.md index d624a06..97ef93b 100644 --- a/BUILD.md +++ b/BUILD.md @@ -39,6 +39,9 @@ Quickshell has a set of base dependencies you will always need, names vary by di - `pkg-config` (build-time) - `cli11` (static library) +Quickshell relies on private Qt APIs and **MUST** be rebuilt against the each Qt release +or crashes via ABI mismatches will occur. + Build time dependencies and static libraries don't have to exist at runtime, however build time dependencies must be compiled for the architecture of the builder, while static libraries must be compiled for the architecture @@ -97,13 +100,6 @@ To disable: `-DSOCKETS=OFF` ### Wayland This feature enables wayland support. Subfeatures exist for each particular wayland integration. -WARNING: Wayland integration relies on features that are not part of the public Qt API and which -may break in minor releases. Updating quickshell's dependencies without ensuring without ensuring -that the current Qt version is supported WILL result in quickshell failing to build or misbehaving -at runtime. - -Currently supported Qt versions: `6.6`, `6.7`. - To disable: `-DWAYLAND=OFF` Dependencies: