This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
wiki:bugs [2013/03/14 20:20] sunweaver [Bug submitter used a non-appropriate title] |
wiki:bugs [2015/08/05 19:32] stefanbaur Added example for clarification, as lots of first-time submitters place <>'s around the field values |
||
---|---|---|---|
Line 1: | Line 1: | ||
====== X2Go Bug Tracker ====== | ====== X2Go Bug Tracker ====== | ||
- | The X2Go project uses the '' | + | The X2Go project uses '' |
Before X2Go had a bug tracker, the quest was: we need a BTS that is easily scriptable and a BTS that fully maps issue tracking to the developers' | Before X2Go had a bug tracker, the quest was: we need a BTS that is easily scriptable and a BTS that fully maps issue tracking to the developers' | ||
Line 7: | Line 7: | ||
The choice has been well thought of, you may find that there are better bug tracking systems in the world. For X2Go, we think we have found what we wanted. | The choice has been well thought of, you may find that there are better bug tracking systems in the world. For X2Go, we think we have found what we wanted. | ||
- | ===== Open / Closed Bugs ===== | + | ===== Viewing Bug History |
If you know either the X2Go component or the bug number you can also access the information directly: | If you know either the X2Go component or the bug number you can also access the information directly: | ||
- | * [[http:// | + | * http:// |
- | * [[http:// | + | * http:// |
A complete list of X2Go components with open/closed bugs can be viewed with this URL: | A complete list of X2Go components with open/closed bugs can be viewed with this URL: | ||
Line 21: | Line 21: | ||
===== Reporting Bugs ===== | ===== Reporting Bugs ===== | ||
- | How to report a bug is explained [[http:// | + | How to report a bug is fully explained [[http:// |
+ | |||
+ | ==== Plain bug submission ==== | ||
+ | Definition of fields/ | ||
< | < | ||
Line 27: | Line 30: | ||
Subject: < | Subject: < | ||
Body: | Body: | ||
- | """ | ||
Package: < | Package: < | ||
Version: < | Version: < | ||
- | """ | + | <one empty line - so hit [enter] twice after typing the version number> |
+ | < | ||
</ | </ | ||
- | ===== Controlling Bugs ===== | + | Example: |
+ | < | ||
+ | To: submit@bugs.x2go.org | ||
+ | Subject: Package contains bobcat | ||
+ | Body: | ||
+ | Package: x2goserver | ||
+ | Version: 4.0.1.0 | ||
- | The full control command set is documented [[http:// | + | When installing x2goserver on Debian stable using apt-get install x2goserver, |
+ | instead of running the postinstall script, a bobcat | ||
- | Very common control sequence are shown below: | + | // |
+ | \\ // , | ||
+ | | ||
+ | \ \ @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@, | ||
+ | \ \ (@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@<> | ||
+ | | ||
+ | \@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@ | ||
+ | __----__ | ||
+ | \@\ @@@@@@@@----__-----_ | ||
+ | | ||
+ | /@/ @@@@ @@@@@ @@@@@ @@@@@ | ||
+ | / | ||
+ | (@( | ||
+ | | ||
+ | \/ | ||
+ | @@@ | ||
+ | ''' | ||
- | ==== Bug has been fixed in X2Go Git ==== | + | A detailed log of the installation progress can be found at https:// |
- | Bugs are only closed on releases | + | </ |
+ | |||
+ | In the description, | ||
+ | - The steps you took to produce the bug | ||
+ | - Any exact error messages | ||
+ | - What you expected to happen | ||
+ | - What actually happened | ||
+ | |||
+ | Also, please list the following info: | ||
+ | - The client machine' | ||
+ | - The client machine' | ||
+ | - Any relevant session settings in X2GoClient, PyHoca-GUI or Pyhoca-CLI | ||
+ | - The server' | ||
+ | - The server' | ||
+ | - The server' | ||
+ | - The server' | ||
+ | - The server' | ||
+ | - Any relevant settings in X2GoServer (that you changed from the defaults) | ||
+ | ==== Bug submission with a Patch ==== | ||
+ | |||
+ | In case you can provide | ||
+ | |||
+ | Create patches for master branch and send them in git format. The documentation about creating git patches can be found [[http:// | ||
+ | |||
+ | Some of you have their own Git clones of X2Go Git. If you want to provide a patch via your public Git clone of an X2Go component, please make sure that the patch is just one commit on one of your Git branches. The rule here is simple: one Git commit on your side, one bug report in X2Go BTS. Everything else will take too much time on the patch reviewer side. | ||
+ | |||
+ | For submitting your bug report, please use this very similar template: | ||
< | < | ||
- | To: <nnn>@bugs.x2go.org | + | To: submit@bugs.x2go.org |
- | Cc: control@bugs.x2go.org, | + | Subject: <a-really-good-short-description-of-the-problem> |
- | Subject: Issue resolved in X2Go Git | + | |
Body: | Body: | ||
- | """ | + | Package: < |
- | tag #<nnn> pending | + | Version: |
- | thanks | + | Tag: patch |
- | The reported issue has been resolved with this commit: | + | <your-not-too-long-description-of-the-discovered-problem> |
- | <http-URL-to-Gitweb-of-commitdiff> | + | |
- | Thanks, | + | Attachment: |
- | <my-name> | + | |
- | """ | + | |
</ | </ | ||
+ | |||
+ | ==== Feature requests / Wishlist bugs ==== | ||
+ | |||
+ | Feature requests are also handled via the X2Go BTS system. Feature requests are bugs with severity ,, | ||
+ | |||
+ | < | ||
+ | To: submit@bugs.x2go.org | ||
+ | Subject: < | ||
+ | Body: | ||
+ | Package: < | ||
+ | Version: < | ||
+ | Severity: wishlist | ||
+ | |||
+ | < | ||
+ | </ | ||
+ | |||
+ | |||
+ | |||
+ | ===== Controlling Bugs ===== | ||
+ | |||
+ | The full control command set is documented [[http:// | ||
+ | |||
+ | Very common control sequences are shown below. | ||
+ | |||
+ | ==== Bug has been fixed in X2Go Git ==== | ||
+ | |||
+ | Marking bugs being fixed in X2Go Git has been automatized. | ||
+ | |||
+ | **Important notice for developers: | ||
==== New version with a bug fixed has been released ==== | ==== New version with a bug fixed has been released ==== | ||
Line 64: | Line 141: | ||
As part of the X2Go release workflow, bugs that have been fixed for this release have to be closed. Normally, most bugs are already marked (tagged) as pending. | As part of the X2Go release workflow, bugs that have been fixed for this release have to be closed. Normally, most bugs are already marked (tagged) as pending. | ||
- | Some pending bugs, though, may only have been fixed on the master branch, but not yet on a release branch. If the release is taken from a release branch, take a look at the released component' | + | Some pending bugs, though, may only have been fixed on the master branch, but not yet on a release branch. If the release is taken from a release branch, take a look at the //Fixed in:// field of the bug report and check if the version to be released |
< | < | ||
To: < | To: < | ||
- | Cc: control@bugs.x2go.org, | + | Cc: < |
Subject: Issue resolved in < | Subject: Issue resolved in < | ||
Body: | Body: | ||
- | """ | + | Control: |
- | close #< | + | |
- | thanks | + | |
The reported issue has been resolved in the lately release version < | The reported issue has been resolved in the lately release version < | ||
Line 79: | Line 154: | ||
Thanks for reporting this issue, | Thanks for reporting this issue, | ||
< | < | ||
- | """ | ||
</ | </ | ||
Line 88: | Line 162: | ||
< | < | ||
To: < | To: < | ||
- | Cc: control@bugs.x2go.org, | + | Cc: < |
Subject: < | Subject: < | ||
Body: | Body: | ||
- | """ | + | Control: |
- | reassign | + | |
- | thanks | + | |
The reported issue is actually a bug in < | The reported issue is actually a bug in < | ||
Line 101: | Line 173: | ||
Thanks for reporting this issue, | Thanks for reporting this issue, | ||
< | < | ||
- | """ | ||
</ | </ | ||
Line 111: | Line 182: | ||
< | < | ||
To: < | To: < | ||
- | Cc: control@bugs.x2go.org, | + | Cc: < |
Subject: < | Subject: < | ||
Body: | Body: | ||
- | """ | + | Control: |
- | retitle | + | |
- | thanks | + | |
< | < | ||
Line 122: | Line 191: | ||
Thanks for reporting this issue, | Thanks for reporting this issue, | ||
< | < | ||
- | """ | + | </ |
+ | |||
+ | |||
+ | ==== Cloning bugs ==== | ||
+ | |||
+ | While fixing a Bug we might become aware of another issue arising in some other X2Go Component that is related to the bug we just fixed. In such a case we have to clone the bug. | ||
+ | |||
+ | < | ||
+ | To: < | ||
+ | Cc: control@bugs.x2go.org | ||
+ | Subject: < | ||
+ | Body: | ||
+ | clone #< | ||
+ | tag -1 - pending | ||
+ | tag -1 - patch | ||
+ | reassign -1 < | ||
+ | retitle #< | ||
+ | thanks | ||
+ | |||
+ | < | ||
+ | |||
+ | Best, | ||
+ | < | ||
</ | </ | ||