aboutsummaryrefslogtreecommitdiffstats
path: root/AGENTS.md
diff options
context:
space:
mode:
authorDanilo M. <danix@danix.xyz>2026-10-13 11:32:46 +0200
committerDanilo M. <danix@danix.xyz>2026-10-13 11:32:46 +0200
commitb87ca1ab1edd1eb49594f7bad31904307a44b3fc (patch)
treef20b8c8793ff63525b1e409ead268cc963501065 /AGENTS.md
parent6849707c43bb8b87f9913fc26b6a69d51777d209 (diff)
downloadquickshell-b87ca1ab1edd1eb49594f7bad31904307a44b3fc.tar.gz
quickshell-b87ca1ab1edd1eb49594f7bad31904307a44b3fc.zip
docs: the performance panel
What the panel shows, the dot's thresholds and their lack of hysteresis, why the public IP is pinned, and what is sampled always versus only while open. AGENTS.md gains two gotchas found building it: FileView reads /proc on reload(), and a hot reload does not resize an existing layer surface, which left the panel cut off after the height was raised. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md11
1 files changed, 10 insertions, 1 deletions
diff --git a/AGENTS.md b/AGENTS.md
index a7b841f..c4ab051 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -13,7 +13,7 @@ modules.
desktop/ the drawer: sound, mail, VMs, appearance
island/ top-centre pills on DP-1: clock, volume, tray, layout, privacy,
- controls panel (SUPER alone), calendar
+ controls panel (SUPER alone), calendar, performance
appearance/ wallpaper picker and colour scheme switcher
window-switcher/ open windows as live previews in a grid, on ALT+TAB
keybinds/ live keybind reminder, on SUPER+k
@@ -165,6 +165,15 @@ changing that component. The ones that generalise:
- **Use `/usr/bin/python3` for calctl and its test.** `python3` on PATH is a
pyenv shim without `icalendar`; the system interpreter has it, for
cal-notif.
+- **`FileView` reads `/proc` and `/sys` fine, but only on `reload()`.** With
+ `blockLoading: true`, `text()` straight after `reload()` is the fresh
+ contents, which is how `Perf.qml` samples `/proc/stat` and hwmon every 2s
+ without a subprocess. hwmon numbers move across boots; look chips up by
+ their `name` file.
+- **A hot reload does not resize an existing layer surface.** Raising the
+ island's `implicitHeight` from 360 to 480 reloaded cleanly while `hyprctl
+ layers` still reported `h: 360` and the performance panel stayed cut off;
+ `./reload.sh desktop` applied it. Check the layer size, not the source.
- **A QML method cannot be named `escape`.** It shadows the global JS
function, and the file fails with `Illegal method name` at load, which a
hot reload reports as the whole island being unavailable. The island's