From 612099a31d51ccae2d53fad9d1c0d4957c0c449b Mon Sep 17 00:00:00 2001 From: Han Young Date: Mon, 9 Jan 2023 13:40:31 +0000 Subject: [PATCH] add more debugging information to CONTRIBUTING.md Something nice to have for the first time contributors (like me). So we don't have to bug people on matrix about how to debug :) --- CONTRIBUTING.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 86d66f99e6..970fad79ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -84,7 +84,7 @@ cmake .. make ``` -People hacking on much KDE software may want to set up kdesrc-build. +People hacking on much KDE software may want to set up [kdesrc-build](https://invent.kde.org/sdk/kdesrc-build). Once built, you can either install it over your system KWin (not recommended) or run it from the build directory directly. @@ -108,6 +108,17 @@ QT_PLUGIN_PATH tells Qt to load KWin's plugins from the build directory, and not The dbus-run-session is needed to prevent the nested KWin instance from conflicting with your session KWin instance when exporting objects onto the bus, or with stuff like global shortcuts. +If you need to run a whole Wayland plasma session, you should install a development session by first building [plasma-workspace](https://invent.kde.org/plasma/plasma-workspace) and executing the `login-sessions/install-sessions.sh` in the build directory. This can be done using kdesrc-build. + +```bash +kdesrc-build plasma-workspace +# assuming the root directory for kdesrc-build is ~/kde +bash ~/kde/build/plasma-workspace/login-sessions/install-sessions.sh +``` +Then you can select the develop session in the sddm login screen. + +You can look up the current boot kwin log via `journalctl --user-unit plasma-kwin_wayland --boot 0`. + ## Using A Debugger Trying to attach a debugger to a running KWin instance from within itself will likely be the last thing you do in the session, as KWin will freeze until you resume it from your debugger, which you need KWin to interact with.