Gentoo Archives: gentoo-doc-cvs

From: Sven Vermeulen <swift@××××××××××××.org>
To: gentoo-doc-cvs@l.g.o
Subject: [gentoo-doc-cvs] cvs commit: bugzilla-howto.xml
Date: Fri, 23 May 2008 20:42:46
Message-Id: E1Jze66-0006Q2-Hb@stork.gentoo.org
1 swift 08/05/23 20:42:42
2
3 Modified: bugzilla-howto.xml
4 Log:
5 Coding style
6
7 Revision Changes Path
8 1.13 xml/htdocs/doc/en/bugzilla-howto.xml
9
10 file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml?rev=1.13&view=markup
11 plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml?rev=1.13&content-type=text/plain
12 diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml?r1=1.12&r2=1.13
13
14 Index: bugzilla-howto.xml
15 ===================================================================
16 RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v
17 retrieving revision 1.12
18 retrieving revision 1.13
19 diff -u -r1.12 -r1.13
20 --- bugzilla-howto.xml 1 Feb 2008 19:30:40 -0000 1.12
21 +++ bugzilla-howto.xml 23 May 2008 20:42:42 -0000 1.13
22 @@ -1,6 +1,6 @@
23 <?xml version="1.0" encoding="UTF-8"?>
24 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
25 -<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.12 2008/02/01 19:30:40 jkt Exp $ -->
26 +<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.13 2008/05/23 20:42:42 swift Exp $ -->
27
28 <guide link="/doc/en/bugzilla-howto.xml">
29 <title>Gentoo Bug Reporting Guide</title>
30 @@ -201,7 +201,7 @@
31
32 <note>
33 One can also debug with core dumps. These core files contain the same
34 -information that the program would produce when run with gdb. In order to debug
35 +information that the program would produce when run with gdb. In order to debug
36 with a core file with bad_code, you would run <c>gdb ./bad_code core</c> where
37 core is the name of the core file.
38 </note>
39 @@ -327,11 +327,11 @@
40 </pre>
41
42 <p>
43 -This ends the walk-through of <c>gdb</c>. Using <c>gdb</c>, we hope that you will
44 -be able to use it to create better bug reports. However, there are other types
45 -of errors that can cause a program to fail during run time. One of the other
46 -ways is through improper file access. We can find those using a nifty little
47 -tool called <c>strace</c>.
48 +This ends the walk-through of <c>gdb</c>. Using <c>gdb</c>, we hope that you
49 +will be able to use it to create better bug reports. However, there are other
50 +types of errors that can cause a program to fail during run time. One of the
51 +other ways is through improper file access. We can find those using a nifty
52 +little tool called <c>strace</c>.
53 </p>
54
55 </body>
56 @@ -350,9 +350,9 @@
57 tool called <c>strace</c> was created to help deal with this. <c>strace</c>
58 traces system calls (hence the name) which include calls that use the memory and
59 files. For our example, we're going to take a program foobar2. This is an
60 -updated version of foobar. However, during the change over to foobar2, you notice
61 -all your configurations are missing! In foobar version 1, you had it setup to
62 -say "foo", but now it's using the default "bar".
63 +updated version of foobar. However, during the change over to foobar2, you
64 +notice all your configurations are missing! In foobar version 1, you had it
65 +setup to say "foo", but now it's using the default "bar".
66 </p>
67
68 <pre caption="Foobar2 With an invalid configuration">
69 @@ -454,9 +454,9 @@
70 </pre>
71
72 <p>
73 -The program is compiling smoothly when it suddenly stops and presents an error message. This
74 -particular error can be split into 3 different sections, The compile messages, the build
75 -error, and the emerge error message as shown below.
76 +The program is compiling smoothly when it suddenly stops and presents an error
77 +message. This particular error can be split into 3 different sections, The
78 +compile messages, the build error, and the emerge error message as shown below.
79 </p>
80
81 <pre caption="Parts of the error">
82 @@ -658,8 +658,8 @@
83 </p>
84
85 <p>
86 -Comment is the important part. Use the comment field to list what appears to be a
87 -specific instance of the error. Basically, don't use anything like the
88 +Comment is the important part. Use the comment field to list what appears to be
89 +a specific instance of the error. Basically, don't use anything like the
90 beginning of the build error, find a line that's before it stating a true
91 error. Also, you'll want to filter out any punctuation to prevent bugzilla
92 from interpreting the results the comment the wrong way. Example from the xclass
93 @@ -772,9 +772,9 @@
94 <note>
95 We would rather see a bug whose product was not supposed to be Gentoo Linux but
96 has been filed under the same rather than seeing a bug which belongs the Gentoo
97 -Linux product and filed elsewhere. While neither is preferred, the former is more
98 -acceptable and understandable (except website bugs.. we might have an issue with
99 -that...).
100 +Linux product and filed elsewhere. While neither is preferred, the former is
101 +more acceptable and understandable (except website bugs.. we might have an issue
102 +with that...).
103 </note>
104
105 <p>
106 @@ -934,7 +934,7 @@
107 Minor - Your program crashes here and there with apparent workarounds.
108 </li>
109 <li>
110 - Normal - The default. If you're not sure leave it here unless it's a new
111 + Normal - The default. If you're not sure leave it here unless it's a new
112 build or cosmetic change, then read below for more information.
113 </li>
114 <li>Trivial - Things such as a mispelled word or whitespace clean up. </li>
115 @@ -1182,7 +1182,7 @@
116
117 <p>
118 The documentation team will require the flag combination <b>-Nt</b> as well as
119 -<b>-u</b>. This mainly has to do with tab expansion. You can create such a diff
120 +<b>-u</b>. This mainly has to do with tab expansion. You can create such a diff
121 with:
122 </p>
123
124 @@ -1251,7 +1251,7 @@
125 Now shortly afterward, we find the error in the strace log and fix the bug and
126 mark it as RESOLVED FIXED and mention that there was a change in the location
127 of configuration files, and that I will update the ebuild with a warning about
128 -it. The bug now becomes resolved, and you are shown the following.
129 +it. The bug now becomes resolved, and you are shown the following.
130 </p>
131
132 <figure link="/images/docs/bugzie-reso.png" caption="Resolved Bug"/>
133 @@ -1282,7 +1282,7 @@
134 </li>
135 <li>
136 CANTFIX - Somehow the bug cannot be solved because of certain
137 - circumstances. These circumstances will be noted by the person taking the
138 + circumstances. These circumstances will be noted by the person taking the
139 bug.
140 </li>
141 <li>
142 @@ -1303,7 +1303,7 @@
143
144 <p>
145 Sometimes, before the bug can be resolved, a developer may request that you
146 -test an updated ebulid. In the next chapter we'll take a look at testing
147 +test an updated ebulid. In the next chapter we'll take a look at testing
148 ebuilds.
149 </p>
150
151 @@ -1422,7 +1422,7 @@
152 <p>
153 In the first section we see that the emerge started off as it should. The second
154 section shows our patch being applied successfully by the "[ ok ]" status
155 -message to the right. The last section tells us the program compiled ok. The
156 +message to the right. The last section tells us the program compiled ok. The
157 patch works! Now we can go and let the developer know that their patch works
158 fine, and that they can commit the fix to portage.
159 </p>
160
161
162
163 --
164 gentoo-doc-cvs@l.g.o mailing list