User Tools

Site Tools


wiki:bugs

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
Next revision Both sides next revision
wiki:bugs [2014/03/05 12:18]
ncryer [Bug submission with a Patch]
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 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 24: Line 24:
  
 ==== Plain bug submission ==== ==== Plain bug submission ====
 +Definition of fields/formatting requirements:
 +
 <code> <code>
 To: submit@bugs.x2go.org To: submit@bugs.x2go.org
 Subject: <a-really-good-short-description-of-the-problem> Subject: <a-really-good-short-description-of-the-problem>
 Body: Body:
-""" 
 Package: <name-of-x2go-component> Package: <name-of-x2go-component>
 Version: <a.b.c.d> Version: <a.b.c.d>
 +<one empty line - so hit [enter] twice after typing the version number>
 <your-not-too-long-description-of-the-discovered-problem> <your-not-too-long-description-of-the-discovered-problem>
-""" 
 </code> </code>
  
 +Example:
 +<code>
 +To: submit@bugs.x2go.org
 +Subject: Package contains bobcat
 +Body:
 +Package: x2goserver
 +Version: 4.0.1.0
 +
 +When installing x2goserver on Debian stable using apt-get install x2goserver, 
 +instead of running the postinstall script, a bobcat is released:
 +
 +    //
 +    \\  //                                               ,
 +     \\//    ,@@@@@@@@@@,              ,@@@@@@@@,       @@@
 +      \ \    @@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@,
 +       \ \  (@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@<>@@@@
 + --__---\ \__\@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@_@@@@@@@@@@@@o
 +              \@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@ @@@@@@@@@@@@
 +    __----__  /@/@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@     -----__ U
 +              \@\ @@@@@@@@----__-----_   @@@@@@@@
 + __---------__-)@)-@@@@@@_____---------___@@@@@@_----___-------
 +              /@/   @@@@ @@@@@       @@@@@ @@@@@
 +             /@/    @@@  @@@@       @@@@@   @@@@@
 +            (@(     @@    @@       @@@@@     @@@@
 +             \@\    @@    @@        @@@@      @@@
 +              \/     @@@   @@@       @@@       @@@
 +                      @@@   @@@      @@@        @@@
 +                      '''   '''      '''        '''
 +
 +A detailed log of the installation progress can be found at https://xkcd.com/325/
 +
 +</code>
 +
 +In the description, please describe:
 +  - 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's OS (e.g., "Windows 7 64-bit SP1" or "Ubuntu 12.04 32-bit")
 +  - The client machine's version of X2GoClient, PyHoca-GUI or Pyhoca-CLI
 +  - Any relevant session settings in X2GoClient, PyHoca-GUI or Pyhoca-CLI
 +  - The server's OS
 +  - The server's version of the x2goserver package
 +  - The server's version of the x2goserver-xsession package
 +  - The server's version of the nxagent package
 +  - The server's version of any other relevant packages (e.g., if the bug as about MATE integration, the version of x2gomatebindings)
 +  - 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 attach the patch to your bug report. Do __not__ copy+paste the patch into the mail body, as the result will not be usable!!! 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://www.git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project|here]] +Create patches for master branch and send them in git format. The documentation about creating git patches can be found [[http://www.git-scm.com/book/en/Distributed-Git-Contributing-to-a-Project#Public-Large-Project|here]] 
  
 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. 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.
Line 50: Line 99:
 Subject: <a-really-good-short-description-of-the-problem> Subject: <a-really-good-short-description-of-the-problem>
 Body: Body:
-""" 
 Package: <name-of-x2go-component> Package: <name-of-x2go-component>
 Version: <a.b.c.d> Version: <a.b.c.d>
Line 56: Line 104:
  
 <your-not-too-long-description-of-the-discovered-problem> <your-not-too-long-description-of-the-discovered-problem>
-"""+
 Attachment: <your-patch.diff> Attachment: <your-patch.diff>
 </code> </code>
Line 68: Line 116:
 Subject: <a-really-good-short-description-of-the-problem> Subject: <a-really-good-short-description-of-the-problem>
 Body: Body:
-""" 
 Package: <name-of-x2go-component> Package: <name-of-x2go-component>
 Version: <a.b.c.d> Version: <a.b.c.d>
Line 74: Line 121:
  
 <your-not-too-long-description-of-the-discovered-problem> <your-not-too-long-description-of-the-discovered-problem>
-""" 
 </code> </code>
  
Line 99: Line 145:
 <code> <code>
 To: <nnn>@bugs.x2go.org To: <nnn>@bugs.x2go.org
-Cc: control@bugs.x2go.org, <nnn>-submitter@bugs.x2go.org+Cc: <nnn>-submitter@bugs.x2go.org
 Subject: Issue resolved in <x2go-component> <version> Subject: Issue resolved in <x2go-component> <version>
 Body: Body:
-""" +Control: close -1
-close #<nnn> +
-thanks+
  
 The reported issue has been resolved in the lately release version <version> of <x2go-component>. The reported issue has been resolved in the lately release version <version> of <x2go-component>.
Line 110: Line 154:
 Thanks for reporting this issue, Thanks for reporting this issue,
 <my-name> <my-name>
-""" 
 </code> </code>
  
Line 119: Line 162:
 <code> <code>
 To: <nnn>@bugs.x2go.org To: <nnn>@bugs.x2go.org
-Cc: control@bugs.x2go.org, <nnn>-submitter@bugs.x2go.org+Cc: <nnn>-submitter@bugs.x2go.org
 Subject: <a-good-subject-line> Subject: <a-good-subject-line>
 Body: Body:
-""" +Control: reassign -1 <another-x2go-component>
-reassign #<nnn> <another-x2go-component> +
-thanks+
  
 The reported issue is actually a bug in <another-x2go-component>. Reassigning. The reported issue is actually a bug in <another-x2go-component>. Reassigning.
Line 132: Line 173:
 Thanks for reporting this issue, Thanks for reporting this issue,
 <my-name> <my-name>
-""" 
 </code> </code>
  
Line 142: Line 182:
 <code> <code>
 To: <nnn>@bugs.x2go.org To: <nnn>@bugs.x2go.org
-Cc: control@bugs.x2go.org, <nnn>-submitter@bugs.x2go.org+Cc: <nnn>-submitter@bugs.x2go.org
 Subject: <a-good-subject-line> Subject: <a-good-subject-line>
 Body: Body:
-""" +Control: retitle -1 <better-title>
-retitle #<nnn> <better-title> +
-thanks+
  
 <further-info-if-any> <further-info-if-any>
Line 153: Line 191:
 Thanks for reporting this issue, Thanks for reporting this issue,
 <my-name> <my-name>
-""" 
 </code> </code>
  
Line 166: Line 203:
 Subject: <cloning-this-bug-for-a-reason> Subject: <cloning-this-bug-for-a-reason>
 Body: Body:
-""" 
 clone #<nnn> -1 clone #<nnn> -1
 tag -1 - pending tag -1 - pending
Line 178: Line 214:
 Best, Best,
 <my-name> <my-name>
-""" 
 </code> </code>
  
  
  
wiki/bugs.txt · Last modified: 2018/05/24 17:19 by stefanbaur