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 23:02] sunweaver [Reporting Bugs] |
wiki:bugs [2014/11/14 13:41] ionic [Open / Closed Bugs] |
||
---|---|---|---|
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 |
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 ==== | ==== Plain bug submission ==== | ||
Line 28: | Line 28: | ||
Subject: < | Subject: < | ||
Body: | Body: | ||
- | """ | ||
Package: < | Package: < | ||
Version: < | Version: < | ||
< | < | ||
- | """ | ||
</ | </ | ||
+ | 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 ==== | ==== Bug submission with a Patch ==== | ||
- | In case you can provide a patch with your bug report, please use this very similar template: | + | In case you can provide a patch with your bug report, please attach the patch to your bug report. Do __not__ copy+paste the patch into the mail body, as the result will not be usable!!! |
+ | |||
+ | 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 | ||
< | < | ||
Line 44: | Line 64: | ||
Subject: < | Subject: < | ||
Body: | Body: | ||
- | """ | ||
Package: < | Package: < | ||
Version: < | Version: < | ||
Line 50: | Line 69: | ||
< | < | ||
- | """ | + | |
+ | Attachment: < | ||
</ | </ | ||
+ | |||
+ | ==== 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 ===== | ===== Controlling Bugs ===== | ||
Line 57: | Line 94: | ||
The full control command set is documented [[http:// | The full control command set is documented [[http:// | ||
- | Very common control | + | Very common control |
==== Bug has been fixed in X2Go Git ==== | ==== Bug has been fixed in X2Go Git ==== | ||
- | Bugs are only closed on releases of X2Go components. To mark a bug as fixed whilst it is not yet included | + | Marking bugs being fixed in X2Go Git has been automatized. |
- | <code> | + | **Important notice for developers: |
- | To: <nnn>@bugs.x2go.org | + | |
- | Cc: control@bugs.x2go.org, < | + | |
- | Subject: Issue resolved | + | |
- | Body: | + | |
- | """ | + | |
- | tag #< | + | |
- | thanks | + | |
- | + | ||
- | The reported issue has been resolved with this commit: | + | |
- | < | + | |
- | + | ||
- | Thanks, | + | |
- | < | + | |
- | """ | + | |
- | </ | + | |
==== New version with a bug fixed has been released ==== | ==== New version with a bug fixed has been released ==== | ||
Line 84: | Line 106: | ||
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 99: | Line 119: | ||
Thanks for reporting this issue, | Thanks for reporting this issue, | ||
< | < | ||
- | """ | ||
</ | </ | ||
Line 108: | Line 127: | ||
< | < | ||
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 121: | Line 138: | ||
Thanks for reporting this issue, | Thanks for reporting this issue, | ||
< | < | ||
- | """ | ||
</ | </ | ||
Line 131: | Line 147: | ||
< | < | ||
To: < | To: < | ||
- | Cc: control@bugs.x2go.org, | + | Cc: < |
Subject: < | Subject: < | ||
Body: | Body: | ||
- | """ | + | Control: |
- | retitle | + | |
- | thanks | + | |
< | < | ||
Line 142: | Line 156: | ||
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, | ||
+ | < | ||
</ | </ | ||