/[gentoo]/xml/htdocs/doc/en/bugzilla-howto.xml
Gentoo

Diff of /xml/htdocs/doc/en/bugzilla-howto.xml

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

Revision 1.1 Revision 1.2
1<?xml version="1.0" encoding="UTF-8"?> 1<?xml version="1.0" encoding="UTF-8"?>
2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd"> 2<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.1 2005/07/07 12:02:21 fox2mike Exp $ --> 3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.2 2005/07/07 18:19:23 fox2mike Exp $ -->
4 4
5<guide link="/doc/en/bugzilla-howto.xml"> 5<guide link="/doc/en/bugzilla-howto.xml">
6<title>Gentoo Bug Reporting Guide</title> 6<title>Gentoo Bug Reporting Guide</title>
7 7
8<author title="Author"> 8<author title="Author">
9 <mail link="chriswhite@gentoo.org">Chris White</mail> 9 <mail link="chriswhite@gentoo.org">Chris White</mail>
10</author> 10</author>
11<author title="Editor"> 11<author title="Editor">
12 <mail link="fox2mike@gentoo.org">Shyam Mani</mail> 12 <mail link="fox2mike@gentoo.org">Shyam Mani</mail>
13</author> 13</author>
14 14
15<abstract> 15<abstract>
16This document shows the proper method of reporting bugs using Bugzilla. 16This document shows the proper method of reporting bugs using Bugzilla.
17</abstract> 17</abstract>
18 18
19<!-- The content of this document is licensed under the CC-BY-SA license --> 19<!-- The content of this document is licensed under the CC-BY-SA license -->
20<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> 20<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
21<license/> 21<license/>
22 22
23<version>1.0</version> 23<version>1.1</version>
24<date>2005-07-07</date> 24<date>2005-07-07</date>
25 25
26<chapter> 26<chapter>
27<title>Introduction</title> 27<title>Introduction</title>
28<section> 28<section>
29<title>Preface</title> 29<title>Preface</title>
30<body> 30<body>
31 31
32<p> 32<p>
33Often one of the factors that delay a bug being fixed is how it is reported. By 33Often one of the factors that delay a bug being fixed is how it is reported. By
34creating this guide, I hope to help improve the communication between 34creating this guide, I hope to help improve the communication between
35developers and users in bug resolution. Getting bugs fixed is an important, if 35developers and users in bug resolution. Getting bugs fixed is an important, if
36not crucial part of the quality assurance of any project and hopefully this 36not crucial part of the quality assurance of any project and hopefully this
37guide will help make that a success. 37guide will help make that a success.
38</p> 38</p>
352</section> 352</section>
353<section> 353<section>
354<title>Using strace to track the issue</title> 354<title>Using strace to track the issue</title>
355<body> 355<body>
356 356
357<p> 357<p>
358Let's have <c>strace</c> log the results of the system calls. To do this, we run 358Let's have <c>strace</c> log the results of the system calls. To do this, we run
359<c>strace</c> with the -o[file] arguments. Let's use it on foobar2 like so: 359<c>strace</c> with the -o[file] arguments. Let's use it on foobar2 like so:
360</p> 360</p>
361 361
362<pre caption="Running foobar2 through strace"> 362<pre caption="Running foobar2 through strace">
363# <i>strace -ostrace.log ./foobar2</i> 363# <i>strace -ostrace.log ./foobar2</i>
364</pre> 364</pre>
365 365
366<p> 366<p>
367This creates a file called strace.log in the current directory. We check the 367This creates a file called <path>strace.log</path> in the current directory. We
368file, and shown below are the relevant parts from the file. 368check the file, and shown below are the relevant parts from the file.
369</p> 369</p>
370 370
371<pre caption="A Look At the strace Log"> 371<pre caption="A Look At the strace Log">
372open(".foobar2/config", O_RDONLY) = 3 372open(".foobar2/config", O_RDONLY) = 3
373read(3, "bar", 3) = 3 373read(3, "bar", 3) = 3
374</pre> 374</pre>
375 375
376<p> 376<p>
377Aha! So There's the problem. Someone moved the configuration directory to 377Aha! So There's the problem. Someone moved the configuration directory to
378<path>.foobar2</path> instead of <path>.foobar</path>. We also see the program 378<path>.foobar2</path> instead of <path>.foobar</path>. We also see the program
379reading in "bar" as it should. In this case, we can recommend the ebuild 379reading in "bar" as it should. In this case, we can recommend the ebuild
380maintainer to put a warning about it. For now though, we can copy over the 380maintainer to put a warning about it. For now though, we can copy over the
381config file from .foobar and modify it to produce the correct results. 381config file from <path>.foobar</path> and modify it to produce the correct
382results.
382</p> 383</p>
383 384
384</body> 385</body>
385</section> 386</section>
386<section> 387<section>
387<title>Conclusion</title> 388<title>Conclusion</title>
388<body> 389<body>
389 390
390<p> 391<p>
391Now we've taken care of finding run time bugs. These bugs prove to be 392Now we've taken care of finding run time bugs. These bugs prove to be
392problematic when you try and run your programs. However, run time errors are 393problematic when you try and run your programs. However, run time errors are
393the least of your concern if your program won't compile at all. Let's take a 394the least of your concern if your program won't compile at all. Let's take a
394look at how to address <c>emerge</c> compile errors. 395look at how to address <c>emerge</c> compile errors.
395</p> 396</p>
396 397
572main.cc:323: warning: unused variable `FILE*fp' 573main.cc:323: warning: unused variable `FILE*fp'
573main.cc: In member function `void OXMain::DoSave(char*)': 574main.cc: In member function `void OXMain::DoSave(char*)':
574main.cc:337: warning: unused variable `FILE*fp' 575main.cc:337: warning: unused variable `FILE*fp'
575make[1]: *** [main.o] Error 1 576make[1]: *** [main.o] Error 1
576make[1]: Leaving directory 577make[1]: Leaving directory
577`/var/tmp/portage/xclass-0.7.4/work/xclass-0.7.4/example-app' 578`/var/tmp/portage/xclass-0.7.4/work/xclass-0.7.4/example-app'
578make: *** [shared] Error 2 579make: *** [shared] Error 2
579 580
580!!! ERROR: x11-libs/xclass-0.7.4 failed. 581!!! ERROR: x11-libs/xclass-0.7.4 failed.
581!!! Function src_compile, Line 29, Exitcode 2 582!!! Function src_compile, Line 29, Exitcode 2
582!!! 'emake shared' failed 583!!! 'emake shared' failed
583</pre> 584</pre>
584 585
585<p> 586<p>
586So to begin searching, we head over to the <uri 587So to begin searching, we head over to the <uri
587link="http://bugs.gentoo.org/">Bugzilla Homepage</uri>. 588link="https://bugs.gentoo.org/">Bugzilla Homepage</uri>.
588</p> 589</p>
589 590
590<figure link="/images/docs/bugzie-homepage.png" caption="Bugzilla Homepage"/> 591<figure link="/images/docs/bugzie-homepage.png" caption="Bugzilla Homepage"/>
591 592
592<p> 593<p>
593In order to begin our search, we'll click on "Query Existing bug reports". The 594In order to begin our search, we'll click on "Query Existing bug reports". The
594reason why we choose this versus the basic bug search is because the basic bug 595reason why we choose this versus the basic bug search is because the basic bug
595search tends to give vague results and often hinders users from looking 596search tends to give vague results and often hinders users from looking
596through the results and finding the duplicate bug. Once we click on the query 597through the results and finding the duplicate bug. Once we click on the query
597screen, we reach the next page: 598screen, we reach the next page:
598</p> 599</p>
599 600
600<figure link="/images/docs/bugzie-search.png" caption="Bugzilla Search Page"/> 601<figure link="/images/docs/bugzie-search.png" caption="Bugzilla Search Page"/>
601 602
602<note> 603<note>
952</p> 953</p>
953 954
954<figure link="/images/docs/bugzie-add-email.png" caption="Adding Email To CC:"/> 955<figure link="/images/docs/bugzie-add-email.png" caption="Adding Email To CC:"/>
955 956
956<note> 957<note>
957Email addresses must be registered with bugzilla. In order to CC multiple 958Email addresses must be registered with bugzilla. In order to CC multiple
958addresses, simply separate them with commas or spaces. 959addresses, simply separate them with commas or spaces.
959</note> 960</note>
960 961
961<p> 962<p>
962After all this work, the bug can undergo various status markings. Here's a few: 963After all this work, the bug can undergo various status markings. Here's a few:
963</p> 964</p>
964 965
965<ul> 966<ul>
966 <li> 967 <li>
967 UNCONFIRMED - You're generally not going to see this too often. This 968 UNCONFIRMED - You're generally not going to see this too often. This
968 means that a bug reporter has opened a bug using the advanced method and is 969 means that a bug reporter has opened a bug using the advanced method and is
969 uncertain his or her bug is an actual bug. 970 uncertain his or her bug is an actual bug.
970 </li> 971 </li>
971 <li> 972 <li>
972 NEW - Bugs that are first opened are considered new. 973 NEW - Bugs that are first opened are considered new.
973 </li> 974 </li>
974 <li> 975 <li>
975 ASSIGNED - When the person you've assigned the bug too validates your 976 ASSIGNED - When the person you've assigned the bug too validates your
976 bug, it will often receive ASSIGNED status while they figure out the issue. 977 bug, it will often receive ASSIGNED status while they figure out the issue.
977 This let's you know that they've accepted your bug as a real bug. 978 This let's you know that they've accepted your bug as a real bug.
978 </li> 979 </li>
979 <li> 980 <li>
980 REOPENED - Someone has resolved a bug and you think the solution is not 981 REOPENED - Someone has resolved a bug and you think the solution is not
981 feasible or the problem still persists. At this point, you may re-open the 982 feasible or the problem still persists. At this point, you may re-open the
982 bug. However <b>please do not abuse this</b>. If a developer closes the bug a 983 bug. However <b>please do not abuse this</b>. If a developer closes the bug a
983 second or even third time, chances are that your bug is closed. 984 second or even third time, chances are that your bug is closed.
984 </li> 985 </li>
985</ul> 986</ul>
986 987
987<p> 988<p>
988Now shortly afterward, I find the error in the strace log. I resolve the bug 989Now shortly afterward, I find the error in the strace log. I resolve the bug
989as RESOLVED FIXED and say that there was a change in the location of 990as RESOLVED FIXED and say that there was a change in the location of
990configuration files, and that I will update the ebuild with a warning about it. 991configuration files, and that I will update the ebuild with a warning about it.
991The bug now becomes resolved, and you are displayed with this: 992The bug now becomes resolved, and you are displayed with this:
992</p> 993</p>
993 994
994<figure link="/images/docs/bugzie-reso.png" caption="Resolved Bug"/> 995<figure link="/images/docs/bugzie-reso.png" caption="Resolved Bug"/>
995 996
996<p> 997<p>
997Also note the section here: 998Also note the section here:
998</p> 999</p>
999 1000
1000<figure link="/images/docs/bugzie-options.png" caption="Bug Options"/> 1001<figure link="/images/docs/bugzie-options.png" caption="Bug Options"/>
1001 1002
1002<p> 1003<p>
1003This gives you the option of Reopening the bug if you wish to (i.e. the developer 1004This gives you the option of Reopening the bug if you wish to (i.e. the developer
1004thinks it's resolved but it's really not to your standards). Now our bug is 1005thinks it's resolved but it's really not to your standards). Now our bug is
1005fixed! However, different resolutions can occur. Here's a small list: 1006fixed! However, different resolutions can occur. Here's a small list:
1006</p> 1007</p>
1007 1008
1008<ul> 1009<ul>
1009 <li> 1010 <li>
1010 FIXED - The bug is fixed, follow the instructions to resolve your 1011 FIXED - The bug is fixed, follow the instructions to resolve your
1011 issue. 1012 issue.
1012 </li> 1013 </li>
1013 <li> 1014 <li>
1014 INVALID - You did not do something specifically documented, causing the 1015 INVALID - You did not do something specifically documented, causing the
1015 bug 1016 bug
1016 </li> 1017 </li>
1017 <li> 1018 <li>
1018 DUPLICATE - You didn't use this guide and reported a duplicate bug 1019 DUPLICATE - You didn't use this guide and reported a duplicate bug
1019 :) 1020 :)
1020 </li> 1021 </li>
1021 <li> 1022 <li>
1022 WORKSFORME - Developer/person assigned the bug cannot reproduce your 1023 WORKSFORME - Developer/person assigned the bug cannot reproduce your
1023 error 1024 error
1024 </li> 1025 </li>
1025</ul> 1026</ul>
1026 1027
1027</body> 1028</body>
1028</section> 1029</section>
1029 1030
1030<section> 1031<section>
1031<title>Conclusion</title> 1032<title>Conclusion</title>
1032<body> 1033<body>
1033 1034
1034<p> 1035<p>
1035This concludes the howto on working with Bugzilla. I hope you find this useful. 1036This concludes the howto on working with Bugzilla. I hope you find this useful.
1036If you have any questions, comments, or ideas regarding this document, please 1037If you have any questions, comments, or ideas regarding this document, please
1037send them to me at <mail 1038send them to me at <mail
1038link="chriswhite@gentoo.org">chriswhite@gentoo.org</mail>. Special 1039link="chriswhite@gentoo.org">chriswhite@gentoo.org</mail>. Special
1039thanks go to moreon for his notes on -g flags and compile errors, the people at 1040thanks go to moreon for his notes on -g flags and compile errors, the people at

Legend:
Removed from v.1.1  
changed lines
  Added in v.1.2

  ViewVC Help
Powered by ViewVC 1.1.20