/[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.6 Revision 1.7
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.6 2005/08/30 02:51:12 vapier Exp $ --> 3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.7 2006/09/02 05:26:46 rane 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.5</version> 23<version>1.6</version>
24<date>2005-08-29</date> 24<date>2006-09-01</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>
33One of the factors that delay a bug being fixed is the way it is reported. By 33One of the factors that delay a bug being fixed is the way it is reported. By
34creating this guide, we hope to help improve the communication between 34creating this guide, we 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 for any project and hopefully this 36not crucial part of the quality assurance for any project and hopefully this
37guide will help make that a success. 37guide will help make that a success.
38</p> 38</p>
39 39
1089 1089
1090!!! Please attach the config.log to your bug report: 1090!!! Please attach the config.log to your bug report:
1091!!! /var/tmp/portage/php-5.0.3-r1/work/php-5.0.3/config.log 1091!!! /var/tmp/portage/php-5.0.3-r1/work/php-5.0.3/config.log
1092 1092
1093!!! ERROR: dev-php/php-5.0.3-r1 failed. 1093!!! ERROR: dev-php/php-5.0.3-r1 failed.
1094!!! Function econf, Line 485, Exitcode 0 1094!!! Function econf, Line 485, Exitcode 0
1095!!! econf failed 1095!!! econf failed
1096!!! If you need support, post the topmost build error, NOT this status message. 1096!!! If you need support, post the topmost build error, NOT this status message.
1097</pre> 1097</pre>
1098 1098
1099<p> 1099<p>
1100Please attach any file mentioned like this to your bug report. 1100Please attach any file mentioned like this to your bug report.
1101</p> 1101</p>
1102 1102
1103<p> 1103<p>
1104While we're doing all this, suppose another person finds your bug by searching 1104Sometimes a developer might ask you to attach a diff or patch for a file.
1105through bugzilla and is curious to keep track of the bug, they may do so by 1105Standard diff files can be obtained through:
1106putting their email in the Add CC field of the bug as shown below. You could 1106</p>
1107
1108<pre caption="Standard Diff Creation">
1109$ <i>cp file file.old</i>
1110$ <i>nano file</i>
1111$ <i>diff -u file.old file</i>
1112</pre>
1113
1114<p>
1115For C/C++ source files, the <b>-p</b> flag is added to show what function calls
1116the diff applies to:
1117</p>
1118
1119<pre caption="Diff-ing C/C++ source">
1120$ <i>cp file.c file.c.old</i>
1121$ <i>nano file.c</i>
1122$ <i>diff -up file.c.old file.c</i>
1123</pre>
1124
1125<p>
1126The documentation team will require the flag combination <b>-Nt</b> as well as
1127<b>-u</b>. This mainly has to do with tab expansion. You can create such a diff
1128with:
1129</p>
1130
1131<pre caption="Documentation diffs">
1132$<i> cp file.xml file.xml.old</i>
1133$<i> nano file.xml</i>
1134$<i> diff -Nut file.xml.old file.xml</i>
1135</pre>
1136
1137<p>
1138And your diff is created. While we're doing all this, suppose another person
1139finds your bug by searching through bugzilla and is curious to keep track of
1140the bug, they may do so by putting their email in the Add CC field of the bug
1107also keep track of other bugs by following the same method. 1141as shown below. You could also keep track of other bugs by following the same
1142method.
1108</p> 1143</p>
1109 1144
1110<figure link="/images/docs/bugzie-add-email.png" caption="Adding Email To CC:"/> 1145<figure link="/images/docs/bugzie-add-email.png" caption="Adding Email To CC:"/>
1111 1146
1112<note> 1147<note>
1113Email addresses must be registered with Gentoo Bugzilla. In order to CC multiple 1148Email addresses must be registered with Gentoo Bugzilla. In order to CC multiple
1114addresses, simply separate them with commas or spaces. 1149addresses, simply separate them with commas or spaces.
1115</note> 1150</note>
1116 1151
1117<p> 1152<p>
1118After all this work, the bug can undergo various status markings. This is 1153After all this work, the bug can undergo various status markings. This is
1119usually done by the Gentoo Developers and sometimes by the reporter. The 1154usually done by the Gentoo Developers and sometimes by the reporter. The
1120following are the various possible states a bug may go through during its 1155following are the various possible states a bug may go through during its
1121lifetime. 1156lifetime.
1122</p> 1157</p>

Legend:
Removed from v.1.6  
changed lines
  Added in v.1.7

  ViewVC Help
Powered by ViewVC 1.1.20