[WIP][RFC] Add a mini-guide for debugging packages and programs, to help with better issue reports #530
Conversation
Just use a void-docs.md file directly.
src/contributing/debug.md
Outdated
| - `backtrace`, which shows the function calls made until the application got to | ||
| that place; | ||
| - `info threads`, which shows information about threads in the program; | ||
| - `break <function>`, which puts a breakpoint in a function that you may think |
There was a problem hiding this comment.
I don't think any of this is nessecary.
There was a problem hiding this comment.
Perhaps keep only the backtrace part? Because that's what we want to get if someone says "this segfaults when I launch it".
src/contributing/debug.md
Outdated
| for example, to access files that don't exist, and their programmer didn't | ||
| implement a proper fallback or error message. |
src/contributing/debug.md
Outdated
| GDB is especially useful when an application crashes with `SIGABRT` or `SIGSEGV` | ||
| (see [signal(7)](https://man.voidlinux.org/signal.7), since it will stop | ||
| execution at that point and you can print a backtrace showing all the function |
src/contributing/debug.md
Outdated
| After this is done, check if the issue persists. It should be noted that issues | ||
| like this can indicate hardware issues in your storage media or RAM. |
There was a problem hiding this comment.
It might, but it also might not. I feel like this would lead to a lot of people going OH NO MY RAM IS DEAD when they actually powered off the computer in the middle of an upgrade or smth.
src/contributing/debug.md
Outdated
|
|
||
| ## Look at error messages attentively THIS NEEDS WORK | ||
|
|
||
| Python programs, for example, complain loudly about missing modules and other |
There was a problem hiding this comment.
Maybe a list of different types of programs? I don't like this format.
There was a problem hiding this comment.
I'm making a second version.
| ``` | ||
| $ DEBUGINFOD_URLS="https://debugingod.s.voidlinux.org" gdb --args <program> [arguments] | ||
| ``` |
There was a problem hiding this comment.
- This is not an example, its more of a 'syntax' i guess
- I would note the debuginfod server env variable to make it work separately.
src/contributing/index.md
Outdated
| If you find an issue with a package and you manage to fix it, you can add your | ||
| solution to the official package repository. New packages and updates are also | ||
| welcome! To contribute to the Void packages repository, start by reading the |
There was a problem hiding this comment.
Indeed, but I'm not sure I improved it.
src/contributing/index.md
Outdated
| void-packages repository. This makes maintainers aware of the issue, allows | ||
| others to fix it, and can work as a place for anyone to share workarounds in the | ||
| meantime. Remember to check the existing issues for your problem! There are also |
There was a problem hiding this comment.
This sentence could be shortened to something like 'This gives the problem visibility to expedite fixing' or something like that
There was a problem hiding this comment.
I moved it around a bit, not 100% sure yet.
src/contributing/index.md
Outdated
| void-packages repository. This makes maintainers aware of the issue, allows | ||
| others to fix it, and can work as a place for anyone to share workarounds in the | ||
| meantime. Remember to check the existing issues for your problem! There are also | ||
| some [things you can do to improve your bug report](./debug.md). |
There was a problem hiding this comment.
improve your bug report could be changed to something along the lines of assist us in finding the probelm
|
@fosslinux thanks for the review! I have updated it. |
Some of this might fit better in void-packages, like Issue templates and such. I'm open to suggestions.