2022-06-06 15:58:50 +03:00
# Issue Guidelines
First of all, please remember to:
- Check that your issue is not a duplicate
2023-06-03 12:11:13 +03:00
- Read the [FAQ ](https://wiki.hyprland.org/FAQ/ )
2023-03-09 13:55:17 +03:00
- Read the [Configuring Page ](https://wiki.hyprland.org/Configuring/Configuring-Hyprland )
2022-06-06 15:58:50 +03:00
< br / >
# Reporting suggestions
Suggestions are welcome.
2023-03-09 13:55:17 +03:00
Many features can be implemented using bash scripts and Hyprland sockets, read up on those [Here ](https://wiki.hyprland.org/IPC ). Please do not suggest features that can be implemented as such.
2022-06-06 15:58:50 +03:00
< br / >
# Reporting bugs
All bug reports should have the following:
- Steps to reproduce
- Expected outcome
- Noted outcome
If your bug is one that doesn't crash Hyprland, but feels like invalid behavior, that's all you need to say.
If your bug crashes Hyprland, append additionally:
- The Hyprland log
2022-07-12 16:35:23 +03:00
- Your config
2023-02-19 16:53:38 +03:00
- (v0.22.0beta and up) The Hyprland Crash Report
- (v0.21.0beta and below) Coredump / Coredump analysis (with a stacktrace)
2022-06-06 15:58:50 +03:00
2022-06-07 21:11:05 +03:00
**Important**: Please do NOT use any package for reporting bugs! Clone and compile from source.
2022-06-06 15:58:50 +03:00
## Obtaining the Hyprland log
If you are in a TTY, and the hyprland session that crashed was the last one you launched, the log will be printed with
```
2024-04-29 00:25:24 +03:00
cat $XDG_RUNTIME_DIR/hypr/$(ls -t $XDG_RUNTIME_DIR/hypr | head -n 1)/hyprland.log
2022-06-06 15:58:50 +03:00
```
feel free to send it to a file, save, copy, etc.
if you are in a Hyprland session, and you want the log of the last session, use
```
2024-04-29 00:25:24 +03:00
cat $XDG_RUNTIME_DIR/hypr/$(ls -t $XDG_RUNTIME_DIR/hypr | head -n 2 | tail -n 1)/hyprland.log
2022-06-06 15:58:50 +03:00
```
2024-04-29 00:25:24 +03:00
basically, directories in $XDG_RUNTIME_DIR/hypr are your sessions.
2022-06-06 15:58:50 +03:00
2023-03-31 15:16:52 +03:00
## Obtaining the Hyprland Crash Report (v0.22.0beta and up)
2024-02-20 03:55:04 +03:00
If you have `$XDG_CACHE_HOME` set, the crash report directory is `$XDG_CACHE_HOME/hyprland` . If not, it's `$HOME/.cache/hyprland` .
2023-03-31 15:16:52 +03:00
Go to the crash report directory and you should find a file named `hyprlandCrashReport[XXXX].txt` where `[XXXX]` is the PID of the process that crashed.
Attach that file to your issue.
2023-02-19 16:53:38 +03:00
## Obtaining the Hyprland coredump (v0.21.0beta and below)
2022-06-06 15:58:50 +03:00
If you are on systemd, you can simply use
```
coredumpctl
```
then go to the end (press END on your keyboard) and remember the PID of the last `Hyprland` occurrence. It's the first number after the time, for example `2891` .
exit coredumpctl (ctrl+c) and use
```
coredumpctl info [PID]
```
where `[PID]` is the PID you remembered.
2022-10-11 13:58:26 +03:00
## Obtaining the debug Hyprland coredump
2022-12-26 15:25:32 +03:00
A debug coredump provides more information for debugging and may speed up the process of fixing the bug.
Make sure you're on latest git. Run `git pull --recurse-submodules` to sync everything.
2022-10-11 13:58:26 +03:00
1. [Compile Hyprland with debug mode ](http://wiki.hyprland.org/Contributing-and-Debugging/#build-in-debug-mode )
> Note: The config file used will be `hyprlandd.conf` instead of `hyprland.conf`
2022-12-26 15:25:32 +03:00
2. `cd ~`
2023-04-04 01:47:01 +03:00
3. For your own convenience, launch Hyprland from a tty with the envvar `ASAN_OPTIONS="log_path=asan.log" ~/path/to/Hyprland`
2022-12-26 15:25:32 +03:00
4. Reproduce the crash. Hyprland should instantly close.
5. Check out your `~` and find a file called `asan.log.XXXXX` where `XXXXX` will be a number corresponding to the PID of the Hyprland instance that crashed.
6. That is your coredump. Attach it to your issue.