docs(kde): mark COMPARE.md and compare-gen.py as stale after the consolidation

COMPARE.md is a snapshot of kfw 173aa802 and kfm 125a9a5 (2026-10-27), before
the commands, messages and configuration types moved into crates/. Its
generated tables count duplicated definitions that no longer exist, and the
generator cannot read the new layout: running it against this tree
(`--kfw .. --kfm ../komorebi-for-mac --kfde .`) stops with "cannot find
^enum SubCommand" because the command definitions are in crates/komorebic-core.

Rather than regenerate tables that would be wrong, the document gets a STALE
banner naming the snapshot, the reason and where the current description is
(docs/dev/ARCHITECTURE-UNIFIED.md, core-model.md), and the script docstring
says it must be ported or retired. No tables were rewritten.

Verified: ran the script as above (fails as described); the script still
parses. Not built. Executable mode of the script is unchanged.
This commit is contained in:
LGUG2Z committed 2026-11-05 15:03:26 -08:00
1 parent 2740098129
commit a8344740cd
2 files changed
+8

No files matched your search

+2
View File
@@ -1,5 +1,7 @@
# komorebi for KDE Plasma compared with komorebi for Windows and for macOS
> **STALE (snapshot of 2026-10-27, kfw 173aa802, kfm 125a9a5):** this comparison predates the consolidation. The three programs now share `crates/` (protocol, config, collections, transport, backend, core, settings, komorebic-core) and one `komorebi`, `komorebic`, `komorebi-client` and `komorebi-bar` package, so counts of duplicated commands, messages and keys below are out of date, and `scripts/compare-gen.py` no longer runs against the current tree (it fails with `cannot find '^enum SubCommand'`, because the command definitions moved to `crates/komorebic-core`). For what is shared and what differs on purpose now, read the repository-level [docs/dev/ARCHITECTURE-UNIFIED.md](../../../docs/dev/ARCHITECTURE-UNIFIED.md) and [docs/dev/core-model.md](../../../docs/dev/core-model.md). The platform-difference tables (KWin versus Win32 versus AppKit mechanisms) remain a fair description of the platform layers.
This document compares komorebi for KDE Plasma on KWin and Wayland (kfde) with komorebi for
Windows (kfw), the original, and komorebi for macOS (kfm). It is written for a reader who knows
komorebi on one of those two systems and wants to know what is the same on KDE, what is different,
+6
View File
@@ -1,6 +1,12 @@
#!/usr/bin/env python3
"""Generate the tables of docs/dev/COMPARE.md from the source trees.
NOTE (wip-cand4): STALE. The command definitions moved to crates/komorebic-core, the daemons' message
types to crates/komorebi-protocol and the configuration types to crates/komorebi-config, so the
readers below (`Tree.commands`, `socket_messages`, `struct_keys`, ...) find nothing and the script
exits with "cannot find ^enum SubCommand". It runs only against the pre-consolidation checkouts
named in COMPARE.md. Port it to the crates before using it again, or retire it with COMPARE.md.
komorebi for Windows (kfw), komorebi for macOS (kfm) and komorebi for KDE Plasma (kfde, this
repository) are read as they are on disk. Nothing in the tables is typed from memory, except the
small hand-written tables in the NOTES section of this file, which hold what a source file cannot