[WIP][RFC] Add a mini-guide for debugging packages and programs, to help with better issue reports by ericonr · Pull Request #530 · void-linux/void-docs

ericonr · 2020-12-02T06:21:15Z

Some of this might fit better in void-packages, like Issue templates and such. I'm open to suggestions.

Just use a void-docs.md file directly.

fosslinux · 2020-12-02T06:35:28Z

src/contributing/debug.md

+- `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


I don't think any of this is nessecary.

Perhaps keep only the backtrace part? Because that's what we want to get if someone says "this segfaults when I launch it".

fosslinux · 2020-12-02T06:35:52Z

src/contributing/debug.md

+for example, to access files that don't exist, and their programmer didn't
+implement a proper fallback or error message.


Could be shortened.

fosslinux · 2020-12-02T06:36:13Z

src/contributing/debug.md

+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


Don't think this is needed either

fosslinux · 2020-12-02T06:36:50Z

src/contributing/debug.md

+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.


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.

Good point.

src/contributing/debug.md

fosslinux · 2020-12-02T06:37:56Z

src/contributing/debug.md

+
+## Look at error messages attentively THIS NEEDS WORK
+
+Python programs, for example, complain loudly about missing modules and other


Maybe a list of different types of programs? I don't like this format.

I'm making a second version.

fosslinux · 2020-12-02T06:38:45Z

src/contributing/debug.md

+```
+$ DEBUGINFOD_URLS="https://debugingod.s.voidlinux.org" gdb --args <program> [arguments]
+```


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.

fosslinux · 2020-12-02T06:39:09Z

src/contributing/index.md

+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


Indeed, but I'm not sure I improved it.

fosslinux · 2020-12-02T06:40:08Z

src/contributing/index.md

+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


This sentence could be shortened to something like 'This gives the problem visibility to expedite fixing' or something like that

I moved it around a bit, not 100% sure yet.

fosslinux · 2020-12-02T06:40:48Z

src/contributing/index.md

+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).


improve your bug report could be changed to something along the lines of assist us in finding the probelm

ericonr · 2020-12-07T05:15:30Z

@fosslinux thanks for the review! I have updated it.

contributing/void-docs: remove folder with one file.

dcfe571

Just use a void-docs.md file directly.

ericonr force-pushed the debug branch from 0625418 to c2c2de3 Compare December 2, 2020 06:23

fosslinux suggested changes Dec 2, 2020

View reviewed changes

ericonr added 2 commits December 7, 2020 02:15

contributing/debug: new page.

7055019

contributing/index: add more information and debug.md.

6327099

ericonr force-pushed the debug branch from c2c2de3 to 6327099 Compare December 7, 2020 05:15

		for example, to access files that don't exist, and their programmer didn't
		implement a proper fallback or error message.

		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.


		## Look at error messages attentively THIS NEEDS WORK

		Python programs, for example, complain loudly about missing modules and other

Conversation

ericonr commented Dec 2, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ericonr commented Dec 7, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ericonr commented Dec 2, 2020 •

edited

Loading