| 1 |
neysx 05/07/22 23:46:11 |
| 2 |
|
| 3 |
Modified: xml/htdocs/doc/en bugzilla-howto.xml |
| 4 |
Log: |
| 5 |
Done some coding style/link fixing |
| 6 |
|
| 7 |
Revision Changes Path |
| 8 |
1.5 +131 -146 xml/htdocs/doc/en/bugzilla-howto.xml |
| 9 |
|
| 10 |
file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/bugzilla-howto.xml?rev=1.5&content-type=text/x-cvsweb-markup&cvsroot=gentoo |
| 11 |
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/bugzilla-howto.xml?rev=1.5&content-type=text/plain&cvsroot=gentoo |
| 12 |
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/bugzilla-howto.xml.diff?r1=1.4&r2=1.5&cvsroot=gentoo |
| 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.4 |
| 18 |
retrieving revision 1.5 |
| 19 |
diff -u -r1.4 -r1.5 |
| 20 |
--- bugzilla-howto.xml 10 Jul 2005 14:13:08 -0000 1.4 |
| 21 |
+++ bugzilla-howto.xml 22 Jul 2005 23:46:11 -0000 1.5 |
| 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.4 2005/07/10 14:13:08 fox2mike Exp $ --> |
| 26 |
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.5 2005/07/22 23:46:11 neysx Exp $ --> |
| 27 |
|
| 28 |
<guide link="/doc/en/bugzilla-howto.xml"> |
| 29 |
<title>Gentoo Bug Reporting Guide</title> |
| 30 |
@@ -20,8 +20,8 @@ |
| 31 |
<!-- See http://creativecommons.org/licenses/by-sa/2.5 --> |
| 32 |
<license/> |
| 33 |
|
| 34 |
-<version>1.3</version> |
| 35 |
-<date>2005-07-10</date> |
| 36 |
+<version>1.4</version> |
| 37 |
+<date>2005-07-22</date> |
| 38 |
|
| 39 |
<chapter> |
| 40 |
<title>Introduction</title> |
| 41 |
@@ -86,11 +86,11 @@ |
| 42 |
</pre> |
| 43 |
|
| 44 |
<p> |
| 45 |
-These errors can be quite troublesome. However, once you find them, what do |
| 46 |
-you do? The following sections will look at two important tools for handling |
| 47 |
-run time errors. After that, we'll take a look at compile errors, and how to |
| 48 |
-handle them. Let's start out with the first tool for debugging run time |
| 49 |
-errors -- <c>gdb</c>. |
| 50 |
+These errors can be quite troublesome. However, once you find them, what do you |
| 51 |
+do? The following sections will look at two important tools for handling run |
| 52 |
+time errors. After that, we'll take a look at compile errors, and how to handle |
| 53 |
+them. Let's start out with the first tool for debugging run time errors -- |
| 54 |
+<c>gdb</c>. |
| 55 |
</p> |
| 56 |
|
| 57 |
</body> |
| 58 |
@@ -111,7 +111,7 @@ |
| 59 |
program is to <c>emerge</c> the program with <c>FEATURES="nostrip"</c>. This |
| 60 |
prevents the stripping of debug symbols. Why are programs stripped by default? |
| 61 |
The reason is the same as that for having gzipped man pages -- saving space. |
| 62 |
-Here's how the size of a program varies with and without debug symbol stripping. |
| 63 |
+Here's how the size of a program varies with and without debug symbol stripping. |
| 64 |
</p> |
| 65 |
|
| 66 |
<pre caption="Filesize Comparison"> |
| 67 |
@@ -128,7 +128,7 @@ |
| 68 |
the size! Two more things can be done for debugging. The first is adding ggdb3 |
| 69 |
to your CFLAGS and CXXFLAGS. This flag adds more debugging information than is |
| 70 |
generally included. We'll see what that means later on. This is how |
| 71 |
-<path>/etc/make.conf</path> <e>might</e> look with the newly added flags. |
| 72 |
+<path>/etc/make.conf</path> <e>might</e> look with the newly added flags. |
| 73 |
</p> |
| 74 |
|
| 75 |
<pre caption="make.conf settings"> |
| 76 |
@@ -137,9 +137,9 @@ |
| 77 |
</pre> |
| 78 |
|
| 79 |
<p> |
| 80 |
-Lastly, you can also add debug to the package's USE flags. This can be done with the |
| 81 |
-<path>package.use</path> file. |
| 82 |
-</p> |
| 83 |
+Lastly, you can also add debug to the package's USE flags. This can be done |
| 84 |
+with the <path>package.use</path> file. |
| 85 |
+</p> |
| 86 |
|
| 87 |
<pre caption="Using package.use to add debug USE flag"> |
| 88 |
# <i>echo "category/package debug" >> /etc/portage/package.use</i> |
| 89 |
@@ -395,7 +395,7 @@ |
| 90 |
reading in "bar" as it should. In this case, we can recommend the ebuild |
| 91 |
maintainer to put a warning about it. For now though, we can copy over the |
| 92 |
config file from <path>.foobar</path> and modify it to produce the correct |
| 93 |
-results. |
| 94 |
+results. |
| 95 |
</p> |
| 96 |
|
| 97 |
</body> |
| 98 |
@@ -510,9 +510,9 @@ |
| 99 |
<body> |
| 100 |
|
| 101 |
<p> |
| 102 |
-PORT_LOGDIR is a portage variable that sets up a log directory for separate |
| 103 |
-emerge logs. Let's take a look and see what that entails. First, run your emerge |
| 104 |
-with PORT_LOGDIR set to your favorite log location. Let's say we have a |
| 105 |
+PORT_LOGDIR is a portage variable that sets up a log directory for separate |
| 106 |
+emerge logs. Let's take a look and see what that entails. First, run your |
| 107 |
+emerge with PORT_LOGDIR set to your favorite log location. Let's say we have a |
| 108 |
location <path>/var/log/portage</path>. We'll use that for our log directory: |
| 109 |
</p> |
| 110 |
|
| 111 |
@@ -639,7 +639,7 @@ |
| 112 |
<p> |
| 113 |
This is how the Advanced Search Page looks like. While it may seem overwhelming |
| 114 |
at first, we're going to look at a few simple areas to narrow down the rather |
| 115 |
-vague searches bugzilla returns. |
| 116 |
+vague searches bugzilla returns. |
| 117 |
</p> |
| 118 |
|
| 119 |
<figure link="/images/docs/bugzie-content.png" caption="Content"/> |
| 120 |
@@ -759,15 +759,13 @@ |
| 121 |
|
| 122 |
<p> |
| 123 |
Another common misconception occurs with our Documentation bugs. For example, a |
| 124 |
-user finds a bug with the <uri |
| 125 |
-link="http://www.gentoo.org/proj/en/releng/catalyst/index.xml">Catalyst |
| 126 |
+user finds a bug with the <uri link="/proj/en/releng/catalyst/">Catalyst |
| 127 |
Docs</uri>. The general tendency is to file a bug under Docs-user, which gets |
| 128 |
assigned to the <uri link="http://gdp.gentoo.org">GDP</uri>, when it should |
| 129 |
-actually go to a member of the <uri |
| 130 |
-link="http://www.gentoo.org/proj/en/releng/">Release Engineering</uri> team. As |
| 131 |
-a rule of thumb, only documentation under http://www.gentoo.org/doc/* is under |
| 132 |
-the GDP. Anything under http://www.gentoo.org/proj/* is under the respective |
| 133 |
-teams. |
| 134 |
+actually go to a member of the <uri link="/proj/en/releng/">Release |
| 135 |
+Engineering</uri> team. As a rule of thumb, only documentation under |
| 136 |
+<path>http://www.gentoo.org/doc/*</path> is under the GDP. Anything under |
| 137 |
+<path>http://www.gentoo.org/proj/*</path> is under the respective teams. |
| 138 |
</p> |
| 139 |
|
| 140 |
<note> |
| 141 |
@@ -779,8 +777,9 @@ |
| 142 |
</note> |
| 143 |
|
| 144 |
<p> |
| 145 |
-Our bug goes in Gentoo Linux as it's an ebuild bug. We head over there and are presented |
| 146 |
-with the multi-step bug reporting process. Let us now proceed with Step 1... |
| 147 |
+Our bug goes in Gentoo Linux as it's an ebuild bug. We head over there and are |
| 148 |
+presented with the multi-step bug reporting process. Let us now proceed with |
| 149 |
+Step 1... |
| 150 |
</p> |
| 151 |
|
| 152 |
<figure link="/images/docs/bugzie-guide-step1.png" caption="Guided Format Step 1"/> |
| 153 |
@@ -808,22 +807,23 @@ |
| 154 |
|
| 155 |
<ul> |
| 156 |
<li> |
| 157 |
- First, there's the Product. The product will narrow down the bug to a |
| 158 |
- specific area of Gentoo like Bugzilla (for bugs relating to bugs.gentoo.org), |
| 159 |
- Docs-user(for User Documentation) or Gentoo Linux (for ebuilds and the like). |
| 160 |
+ First, there's the Product. The product will narrow down the bug to a |
| 161 |
+ specific area of Gentoo like Bugzilla (for bugs relating to |
| 162 |
+ bugs.gentoo.org), Docs-user(for User Documentation) or Gentoo Linux (for |
| 163 |
+ ebuilds and the like). |
| 164 |
</li> |
| 165 |
<li> |
| 166 |
- Component is where exactly the problem occurs, more specifically which part |
| 167 |
- of selected product the bug comes under. This makes classification easier. |
| 168 |
+ Component is where exactly the problem occurs, more specifically which part |
| 169 |
+ of selected product the bug comes under. This makes classification easier. |
| 170 |
</li> |
| 171 |
<li> |
| 172 |
- Hardware platform is what architecture you're running. If you were running |
| 173 |
- SPARC, you would set it to SPARC. |
| 174 |
+ Hardware platform is what architecture you're running. If you were running |
| 175 |
+ SPARC, you would set it to SPARC. |
| 176 |
</li> |
| 177 |
<li> |
| 178 |
- Operating System is what Operating System you're using. Because Gentoo is |
| 179 |
- considered a "Meta-distribution", it can run on other operating systems |
| 180 |
- beside Linux. |
| 181 |
+ Operating System is what Operating System you're using. Because Gentoo is |
| 182 |
+ considered a "Meta-distribution", it can run on other operating systems |
| 183 |
+ beside Linux. |
| 184 |
</li> |
| 185 |
</ul> |
| 186 |
|
| 187 |
@@ -832,34 +832,27 @@ |
| 188 |
</p> |
| 189 |
|
| 190 |
<ul> |
| 191 |
- <li> |
| 192 |
- Product - Gentoo Linux (Since it is an ebuild issue) |
| 193 |
- </li> |
| 194 |
- <li> |
| 195 |
- Component - Application (It is an application at fault, foobar2) |
| 196 |
- </li> |
| 197 |
- <li> |
| 198 |
- Hardware Platform - All (This error could occur across architectures) |
| 199 |
- </li> |
| 200 |
- <li> |
| 201 |
- Operation System - All (It could occur on all types of systems) |
| 202 |
- </li> |
| 203 |
+ <li>Product - Gentoo Linux (Since it is an ebuild issue)</li> |
| 204 |
+ <li>Component - Application (It is an application at fault, foobar2)</li> |
| 205 |
+ <li>Hardware Platform - All (This error could occur across architectures)</li> |
| 206 |
+ <li>Operation System - All (It could occur on all types of systems)</li> |
| 207 |
</ul> |
| 208 |
|
| 209 |
<figure link="/images/docs/bugzie-basic-comp.png" caption="Completed Basic Information"/> |
| 210 |
|
| 211 |
<ul> |
| 212 |
<li> |
| 213 |
|
| 214 |
|
| 215 |
|
| 216 |
-- |
| 217 |
gentoo-doc-cvs@g.o mailing list |
Archives