Skip to content

Commit b909b4e

Browse files
committed
docs: ask users not to submit v1 crash reports
1 parent a51dcd0 commit b909b4e

3 files changed

Lines changed: 17 additions & 83 deletions

File tree

.github/ISSUE_TEMPLATE/crash.yml

Lines changed: 13 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -1,82 +1,17 @@
11
name: Crash Report (v1)
2-
description: Quickshell has crashed
3-
labels: ["bug", "crash"]
2+
description: Quickshell has crashed (old)
3+
labels: ["unactionable"]
44
body:
5-
- type: textarea
6-
id: crashinfo
5+
- type: markdown
76
attributes:
8-
label: General crash information
9-
description: |
10-
Paste the contents of the `info.txt` file in your crash folder here.
11-
value: "<details> <summary>General information</summary>
12-
13-
14-
```
15-
16-
<Paste the contents of the file here inside of the triple backticks>
17-
18-
```
19-
20-
21-
</details>"
22-
validations:
23-
required: true
24-
- type: textarea
25-
id: userinfo
7+
value: |
8+
Thank you for taking the time to click the report button.
9+
At this point most of the worst issues in 0.2.1 and before have been fixed and we are
10+
preparing for a new release. Please do not report crashes from 0.2.1 or before for now.
11+
- type: checkboxes
12+
id: donotcheck
2613
attributes:
27-
label: What caused the crash
28-
description: |
29-
Any information likely to help debug the crash. What were you doing when the crash occurred,
30-
what changes did you make, can you get it to happen again?
31-
- type: textarea
32-
id: dump
33-
attributes:
34-
label: Minidump
35-
description: |
36-
Attach `minidump.dmp.log` here. If it is too big to upload, compress it.
37-
38-
You may skip this step if quickshell crashed while processing a password
39-
or other sensitive information. If you skipped it write why instead.
40-
validations:
41-
required: true
42-
- type: textarea
43-
id: logs
44-
attributes:
45-
label: Log file
46-
description: |
47-
Attach `log.qslog.log` here. If it is too big to upload, compress it.
48-
49-
You can preview the log if you'd like using `quickshell read-log <path-to-log>`.
50-
validations:
51-
required: true
52-
- type: textarea
53-
id: config
54-
attributes:
55-
label: Configuration
56-
description: |
57-
Attach your configuration here, preferrably in full (not just one file).
58-
Compress it into a zip, tar, etc.
59-
60-
This will help us reproduce the crash ourselves.
61-
- type: textarea
62-
id: bt
63-
attributes:
64-
label: Backtrace
65-
description: |
66-
If you have gdb installed and use systemd, or otherwise know how to get a backtrace,
67-
we would appreciate one. (You may have gdb installed without knowing it)
68-
69-
1. Run `coredumpctl debug <pid>` where `pid` is the number shown after "Crashed process ID"
70-
in the crash reporter.
71-
2. Once it loads, type `bt -full` (then enter)
72-
3. Copy the output and attach it as a file or in a spoiler.
73-
- type: textarea
74-
id: exe
75-
attributes:
76-
label: Executable
77-
description: |
78-
If the crash folder contains a executable.txt file, upload it here. If not you can ignore this field.
79-
If it is too big to upload, compress it.
80-
81-
Note: executable.txt is the quickshell binary. It has a .txt extension due to github's limitations on
82-
filetypes.
14+
label: Read the text above.
15+
options:
16+
- label: Do not check this box or submit this issue.
17+
required: true

.github/ISSUE_TEMPLATE/crash2.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,29 +9,29 @@ body:
99
description: |
1010
Any information likely to help debug the crash. What were you doing when the crash occurred,
1111
what changes did you make, can you get it to happen again?
12-
- type: textarea
12+
- type: upload
1313
id: report
1414
attributes:
1515
label: Report file
1616
description: Attach `report.txt` here.
1717
validations:
1818
required: true
19-
- type: textarea
19+
- type: upload
2020
id: logs
2121
attributes:
2222
label: Log file
2323
description: |
2424
Attach `log.qslog.log` here. If it is too big to upload, compress it.
2525
26-
You can preview the log if you'd like using `quickshell read-log <path-to-log>`.
26+
You can preview the log if you'd like using `qs log <path-to-log> -r '*=true'`.
2727
validations:
2828
required: true
2929
- type: textarea
3030
id: config
3131
attributes:
3232
label: Configuration
3333
description: |
34-
Attach your configuration here, preferrably in full (not just one file).
34+
Attach or link your configuration here, preferrably in full (not just one file).
3535
Compress it into a zip, tar, etc.
3636
3737
This will help us reproduce the crash ourselves.

src/wayland/wl_proxy_safe_deref.cpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
#include <dlfcn.h>
32
#include <qlogging.h>
43
#include <qloggingcategory.h>

0 commit comments

Comments
 (0)