/[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.13 Revision 1.14
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.13 2008/05/23 20:42:42 swift Exp $ --> 3<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/bugzilla-howto.xml,v 1.14 2009/01/26 07:34:41 nightmorph 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.11</version> 23<version>1.12</version>
24<date>2008-01-31</date> 24<date>2009-01-25</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
427of frustration for users. Reporting them is considered crucial for maintaining 427of frustration for users. Reporting them is considered crucial for maintaining
428the health of Gentoo. Let's take a look at a sample ebuild, foobar2, which 428the health of Gentoo. Let's take a look at a sample ebuild, foobar2, which
429contains some build errors. 429contains some build errors.
430</p> 430</p>
431 431
432</body> 432</body>
433</section> 433</section>
434<section id="emerge_error"> 434<section id="emerge_error">
435<title>Evaluating emerge Errors</title> 435<title>Evaluating emerge Errors</title>
436<body> 436<body>
437 437
438<p> 438<p>
439Let's take a look at this very simple <c>emerge</c> error: 439Let's take a look at this very simple <c>emerge</c> error:
440</p> 440</p>
441 441
442<pre caption="emerge Error"> 442<pre caption="emerge Error (long lines are manually wrapped to fit the window)">
443gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod -c -o foobar2-7.o foobar2-7.c
444gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod -c -o foobar2-8.o foobar2-8.c
445gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod -c -o foobar2-9.o foobar2-9.c
446gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod -c -o foobar2.o foobar2.c 443gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod \
444 -c -o foobar2-7.o foobar2-7.c
445gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod \
446 -c -o foobar2-8.o foobar2-8.c
447gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod \
448 -c -o foobar2-9.o foobar2-9.c
449gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod \
450 -c -o foobar2.o foobar2.c
447foobar2.c:1:17: ogg.h: No such file or directory 451foobar2.c:1:17: ogg.h: No such file or directory
448make: *** [foobar2.o] Error 1 452make: *** [foobar2.o] Error 1
449 453
450!!! ERROR: sys-apps/foobar2-1.0 failed. 454!!! ERROR: sys-apps/foobar2-1.0 failed.
451!!! Function src_compile, Line 19, Exitcode 2 455!!! Function src_compile, Line 19, Exitcode 2
452!!! Make failed! 456!!! Make failed!
453!!! If you need support, post the topmost build error, NOT this status message 457!!! If you need support, post the topmost build error, NOT this status message
454</pre> 458</pre>
455 459
456<p> 460<p>
457The program is compiling smoothly when it suddenly stops and presents an error 461The program is compiling smoothly when it suddenly stops and presents an error
458message. This particular error can be split into 3 different sections, The 462message. This particular error can be split into 3 different sections, The
459compile messages, the build error, and the emerge error message as shown below. 463compile messages, the build error, and the emerge error message as shown below.
460</p> 464</p>
461 465
462<pre caption="Parts of the error"> 466<pre caption="Parts of the error (long lines are manually wrapped to fit the window)">
463<comment>(Compilation Messages)</comment> 467<comment>(Compilation Messages)</comment>
464gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod -c -o foobar2-7.o foobar2-7.c
465gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod -c -o foobar2-8.o foobar2-8.c
466gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod -c -o foobar2-9.o foobar2-9.c
467gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod -c -o foobar2.o foobar2.c 468gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod \
469 -c -o foobar2-7.o foobar2-7.c
470gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod \
471 -c -o foobar2-8.o foobar2-8.c
472gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod \
473 -c -o foobar2-9.o foobar2-9.c
474gcc -D__TEST__ -D__GNU__ -D__LINUX__ -L/usr/lib -I/usr/include -L/usr/lib/nspr/ -I/usr/include/fmod \
475 -c -o foobar2.o foobar2.c
468 476
469<comment>(Build Error)</comment> 477<comment>(Build Error)</comment>
470foobar2.c:1:17: ogg.h: No such file or directory 478foobar2.c:1:17: ogg.h: No such file or directory
471make: *** [foobar2.o] Error 1 479make: *** [foobar2.o] Error 1
472 480
473<comment>(emerge Error)</comment> 481<comment>(emerge Error)</comment>
474!!! ERROR: sys-apps/foobar2-1.0 failed. 482!!! ERROR: sys-apps/foobar2-1.0 failed.
475!!! Function src_compile, Line 19, Exitcode 2 483!!! Function src_compile, Line 19, Exitcode 2
476!!! Make failed! 484!!! Make failed!
477!!! If you need support, post the topmost build error, NOT this status message 485!!! If you need support, post the topmost build error, NOT this status message
478</pre> 486</pre>
479 487
480<p> 488<p>
481The compilation messages are what lead up to the error. Most often, it's good to 489The compilation messages are what lead up to the error. Most often, it's good to
482at least include 10 lines of compile information so that the developer knows 490at least include 10 lines of compile information so that the developer knows
512 520
513<p> 521<p>
514PORT_LOGDIR is a portage variable that sets up a log directory for separate 522PORT_LOGDIR is a portage variable that sets up a log directory for separate
515emerge logs. Let's take a look and see what that entails. First, run your 523emerge logs. Let's take a look and see what that entails. First, run your
516emerge with PORT_LOGDIR set to your favorite log location. Let's say we have a 524emerge with PORT_LOGDIR set to your favorite log location. Let's say we have a
517location <path>/var/log/portage</path>. We'll use that for our log directory: 525location <path>/var/log/portage</path>. We'll use that for our log directory:
518</p> 526</p>
519 527
520<note> 528<note>
521In the default setup, <path>/var/log/portage</path> does not exist, and you will 529In the default setup, <path>/var/log/portage</path> does not exist, and you will
522most likely have to create it. If you do not, portage will fail to write the 530most likely have to create it. If you do not, portage will fail to write the
523logs. 531logs.
524</note> 532</note>
525 533
526<pre caption="emerge-ing With PORT_LOGDIR"> 534<pre caption="emerge-ing With PORT_LOGDIR">
527# <i>PORT_LOGDIR=/var/log/portage emerge foobar2</i> 535# <i>PORT_LOGDIR=/var/log/portage emerge cate-gory/foobar2</i>
528</pre> 536</pre>
529 537
530<p> 538<p>
531Now the emerge fails again. However, this time we have a log we can work with, 539Now the emerge fails again. However, this time we have a log we can work with,
532and attach to the bug later on. Let's take a quick look at our log directory. 540and attach to the bug later on. Let's take a quick look at our log directory.
533</p> 541</p>
534 542
535<pre caption="PORT_LOGDIR Contents"> 543<pre caption="PORT_LOGDIR Contents">
536# <i>ls -la /var/log/portage</i> 544# <i>ls -la /var/log/portage</i>
537total 16 545total 16
538drwxrws--- 2 root root 4096 Jun 30 10:08 . 546drwxrws--- 2 root root 4096 Jun 30 10:08 .
539drwxr-xr-x 15 root root 4096 Jun 30 10:08 .. 547drwxr-xr-x 15 root root 4096 Jun 30 10:08 ..
540-rw-r--r-- 1 root root 7390 Jun 30 10:09 2115-foobar2-1.0.log 548-rw-r--r-- 1 root root 7390 Jun 30 10:09 cate-gory:foobar2-1.0:20090110-213217.log
541</pre> 549</pre>
542 550
543<p> 551<p>
544The log files have the format [counter]-[package name]-[version].log. Counter 552The log files have the format [category]:[package name]-[version]:[date].log. A
545is a special variable that is meant to state this package as the n-th package
546you've emerged. This prevents duplicate logs from appearing. A quick look at
547the log file will show the entire emerge process. This can be attached later 553quick look at the log file will show the entire emerge process. This can be
548on as we'll see in the bug reporting section. Now that we've safely obtained 554attached later on as we'll see in the bug reporting section. Now that we've
549our information needed to report the bug we can continue to do so. However, 555safely obtained our information needed to report the bug we can continue to do
550before we get started on that, we need to make sure no one else has reported 556so. However, before we get started on that, we need to make sure no one else
551the issue. Let's take a look at searching for bugs. 557has reported the issue. Let's take a look at searching for bugs.
552</p> 558</p>
553 559
554</body> 560</body>
555</section> 561</section>
556</chapter> 562</chapter>
557 563
558<chapter> 564<chapter>
559<title>Searching Using Bugzilla</title> 565<title>Searching Using Bugzilla</title>
560<section> 566<section>
561<title>Introduction</title> 567<title>Introduction</title>
562<body> 568<body>
563 569
564<p> 570<p>
565<uri link="http://www.bugzilla.org">Bugzilla</uri> is what we at Gentoo use to 571<uri link="http://www.bugzilla.org">Bugzilla</uri> is what we at Gentoo use to
566handle bugs. Gentoo's Bugzilla is reachable by HTTPS and HTTP. HTTPS is 572handle bugs. Gentoo's Bugzilla is reachable by HTTPS and HTTP. HTTPS is

Legend:
Removed from v.1.13  
changed lines
  Added in v.1.14

  ViewVC Help
Powered by ViewVC 1.1.20