Summary

Add how to submit a bug report and debugging sections

Review Request #802 — Created July 11, 2021 and submitted July 12, 2021, 6:36 p.m.

Information

Owner

sorvival

Repository

pidgin/nest

Branch

default

Bugs

Depends On

Commit

112de4c083a6

Reviewers

Groups

pidgin-www

People

Description

Tackling both of these at once since they are related (a lot of the times to
submit a good bug report you need to provide a debug log or crash dump).

The contents of these sections are heavily based off the content of the old
wiki pages, primarly TipsForBugReports and GetABacktrace.

Testing Done

Ran dev-server.sh and verified contents look as intended.

Issues

Description	From	Last Updated
can you change the -d to --debug. A lot of our old docs use the short flags that aren't immediately …	grim	July 12, 2021, 6:16 p.m.
You don't need to number these yourself, you can just keep using 1. that way you can reorder things much …	grim	July 12, 2021, 6:16 p.m.
Should probably us https://issues.imfreedom.org/issues/PIDGIN?u=1 as the link target as it'll select th pidgin project and hide closed reports by default.	grim	July 12, 2021, 6:16 p.m.
You might want to mention that they can create an issue as a place holder and then have an Pidgin …	grim	July 12, 2021, 6:15 p.m.
use url from above.	grim	July 12, 2021, 6:17 p.m.
might want to change this to pidgin --debug \|& tee ~/debug.log which does the same thing but also echoes it …	grim	July 12, 2021, 6:17 p.m.
I think it's c:\Program Files (x86)\ now? And might have been for a while...	grim	July 12, 2021, 6:34 p.m.
might want to use gdb --args pidgin --debug \|& tee ~/pidgin-backtrace.log ?	grim	July 12, 2021, 6:17 p.m.
could mention pidof here too	grim	July 12, 2021, 6:17 p.m.

Change Summary:

Change reference to old backtrace section in the old site to the new one

Commit:

c3c0c8370b2c

914d60a11a65

Diff:

Revision 2 (+273 -5)

Show changes

	hugo/content/about/security/_index.md
	hugo/content/development/contributing.md
	hugo/content/development/debugging.md
	hugo/content/development/voice-and-video/_index.md

hugo/content/about/security/_index.md (Diff revision 2)

The issue has been resolved. Show all issues

can you change the -d to --debug. A lot of our old docs use the short flags that aren't immediately recognizable like the long arguments.

sorvival July 12, 2021, 5:39 p.m.
```
done in rev3.
```

hugo/content/development/contributing.md (Diff revision 2)

The issue has been resolved. Show all issues

You don't need to number these yourself, you can just keep using 1. that way you can reorder things much more easily.

sorvival July 12, 2021, 5:39 p.m.

Gotcha. I knew about this but I wasn't aware if we wanted to follow that style for markdown numbered lists :) Maybe at some point I'll start the discussion to add a markdownlinter and setup a markdownlint rules file so that this becomes more explicit for anyone contributing. In rev3 I changed all the numbered lists modified in this PR to always start with a 1..

hugo/content/development/contributing.md (Diff revision 2)

The issue has been resolved. Show all issues

Should probably us https://issues.imfreedom.org/issues/PIDGIN?u=1 as the link target as it'll select th pidgin project and hide closed reports by default.

sorvival July 12, 2021, 5:39 p.m.

done in rev3. Since this may be a URL that we may want to repeat a few times in Nest I added a param for it in config.toml.

hugo/content/development/contributing.md (Diff revision 2)

The issue has been dropped. Show all issues

You might want to mention that they can create an issue as a place holder and then have an Pidgin developer flip the issues to pidgin devs + reporter only. But I'm not sure of a concise way to really put that..

sorvival July 12, 2021, 5:39 p.m.

I'm cool with stating adding an issue in YouTrack visible to only the Pidgin Team as an alternative to sending the report to our security mail list. However, I'd prefer to do that in a separate PR since that would be about modifying part of our Security vulnerability reporting process (well, not really modifying... more like expanding). What do you think of this?

grim July 12, 2021, 6:17 p.m.
```
Yeah that sounds like a good plan :)
```

hugo/content/development/contributing.md (Diff revision 2)
The issue has been resolved. Show all issues
```
use url from above.
```
1. sorvival July 12, 2021, 5:39 p.m.
  done in rev3, see comment above for more details

hugo/content/development/debugging.md (Diff revision 2)

The issue has been resolved. Show all issues

might want to change this to pidgin --debug |& tee ~/debug.log which does the same thing but also echoes it out to the terminal.

sorvival July 12, 2021, 5:39 p.m.
```
done in rev3
```

hugo/content/development/debugging.md (Diff revision 2)

The issue has been resolved. Show all issues

I think it's c:\Program Files (x86)\ now? And might have been for a while...

sorvival July 12, 2021, 5:39 p.m.

I believe that the Program Files (x86) directory is for 32 bit applications, whereas 64 bit applications are stored in Program Files. I'd guess Pidgin2 on Windows is a 64 bit application? To be honest I never installed Pidgin on Windows (not a Windows user) so I might be wrong...

grim July 12, 2021, 6:17 p.m.
```
It's only 32 bit
```

sorvival July 12, 2021, 6:23 p.m.

Okay then, in rev4 I changed the path to Program Files (x86)

hugo/content/development/debugging.md (Diff revision 2)

Holy crap thanks for getting all this info together!!

hugo/content/development/debugging.md (Diff revision 2)
The issue has been resolved. Show all issues
```
might want to use gdb --args pidgin --debug |& tee ~/pidgin-backtrace.log ?
```
1. sorvival July 12, 2021, 5:39 p.m.
  done in rev 3
hugo/content/development/debugging.md (Diff revision 2)
The issue has been resolved. Show all issues
```
could mention pidof here too
```
1. sorvival July 12, 2021, 5:39 p.m.
  done in rev3

Change Summary:

Apply suggestions done by GK:
1. Change -d to --debug in security index page
2. Start all markdown numbered lists with 1.
3. Use the issue tracker url that links to the Pidgin issues that are not closed
4. Mention pidof command as a way to get the pid of pidgin
5. Use |& as a way to avoid having to also use 2>&1 when you need to redirect stderr output to stdout

Commit:

914d60a11a65

ddf47b0f15bf

Diff:

Revision 3 (+274 -5)

Show changes

	hugo/config.toml
	hugo/content/about/security/_index.md
	hugo/content/development/contributing.md
	hugo/content/development/debugging.md
	hugo/content/development/voice-and-video/_index.md

Change Summary:

Change from C:\Program Files to C:\Program Files (x86)

Commit:

ddf47b0f15bf

112de4c083a6

Diff:

Revision 4 (+274 -5)

Show changes

	hugo/config.toml
	hugo/content/about/security/_index.md
	hugo/content/development/contributing.md
	hugo/content/development/debugging.md
	hugo/content/development/voice-and-video/_index.md

Ship it!

```
Ship It!
```
```
Awesome work! Thank you very much!!
```

Status:: Completed