From ad28321a8d9e9cefde0257aa1c9df00d130a4f45 Mon Sep 17 00:00:00 2001 From: vaxerski <43317083+vaxerski@users.noreply.github.com> Date: Sun, 19 Feb 2023 13:53:38 +0000 Subject: [PATCH] update issue guidelines for crash reports --- docs/ISSUE_GUIDELINES.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/docs/ISSUE_GUIDELINES.md b/docs/ISSUE_GUIDELINES.md index 0e47fecb..0de63991 100644 --- a/docs/ISSUE_GUIDELINES.md +++ b/docs/ISSUE_GUIDELINES.md @@ -25,8 +25,9 @@ If your bug is one that doesn't crash Hyprland, but feels like invalid behavior, If your bug crashes Hyprland, append additionally: - The Hyprland log -- Coredump / Coredump analysis (with a stacktrace) - Your config +- (v0.22.0beta and up) The Hyprland Crash Report +- (v0.21.0beta and below) Coredump / Coredump analysis (with a stacktrace) **Important**: Please do NOT use any package for reporting bugs! Clone and compile from source. @@ -44,7 +45,7 @@ cat /tmp/hypr/$(ls -t /tmp/hypr/ | head -n 2 | tail -n 1)/hyprland.log basically, directories in /tmp/hypr are your sessions. -## Obtaining the Hyprland coredump +## Obtaining the Hyprland coredump (v0.21.0beta and below) If you are on systemd, you can simply use ``` coredumpctl @@ -57,6 +58,13 @@ coredumpctl info [PID] ``` where `[PID]` is the PID you remembered. +## Obtaining the Hyprland Crash Report (v0.22.0beta and up) +Go to `~/.hyprland/` and you should find a file named `.hyprlandCrashReport[XXXX]` where `[XXXX]` is the PID of the process that crashed. + +If you do not see it, make sure you have "show hidden files" enabled in your file manager. + +Attach that file to your issue. + ## Obtaining the debug Hyprland coredump A debug coredump provides more information for debugging and may speed up the process of fixing the bug.