how.html 13.4 KB
Newer Older
1 2 3 4 5 6
<HTML
><HEAD
><TITLE
>How do I use Bugzilla?</TITLE
><META
NAME="GENERATOR"
7
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
8 9 10 11 12 13 14 15
"><LINK
REL="HOME"
TITLE="The Bugzilla Guide"
HREF="index.html"><LINK
REL="UP"
TITLE="Using Bugzilla"
HREF="using.html"><LINK
REL="PREVIOUS"
16 17
TITLE="Using Bugzilla"
HREF="using.html"><LINK
18
REL="NEXT"
19 20
TITLE="Hints and Tips"
HREF="hintsandtips.html"></HEAD
21
><BODY
22
CLASS="section"
23 24 25 26 27 28 29 30
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
31
SUMMARY="Header navigation table"
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Bugzilla Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
48
HREF="using.html"
49
ACCESSKEY="P"
50 51 52 53 54 55
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
56
>Chapter 3. Using Bugzilla</TD
57 58 59 60 61
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
62
HREF="hintsandtips.html"
63
ACCESSKEY="N"
64 65 66 67 68 69 70 71
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
72
CLASS="section"
73
><H1
74
CLASS="section"
75
><A
76
NAME="how">3.1. How do I use Bugzilla?</H1
77
><P
78 79 80 81
>This section contains information for end-users of Bugzilla. 
    There is a Bugzilla test installation, called 
    <A
HREF="http://landfill.bugzilla.org/"
82
TARGET="_top"
83 84 85 86 87 88 89
>Landfill</A
>, 
    which you are welcome to play with (if it's up.) 
    However, it does not necessarily
    have all Bugzilla features enabled, and often runs cutting-edge versions
    of Bugzilla for testing, so some things may work slightly differently
    than mentioned here.</P
90
><DIV
91
CLASS="section"
92
><H2
93
CLASS="section"
94
><A
95 96 97 98 99 100 101 102
NAME="myaccount">3.1.1. Create a Bugzilla Account</H2
><P
>If you want to use Bugzilla, first you need to create an account.
      Consult with the administrator responsible for your installation of
      Bugzilla for the URL you should use to access it. If you're
      test-driving Bugzilla, use this URL: 
      <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/"
103
TARGET="_top"
104
>&#13;      http://landfill.bugzilla.org/bugzilla-tip/</A
105 106 107 108 109 110 111 112
>
      </P
><P
></P
><OL
TYPE="1"
><LI
><P
113 114
>Click the 
          <SPAN
115 116
CLASS="QUOTE"
>"Open a new Bugzilla account"</SPAN
117 118 119 120 121
>

          link, enter your email address and, optionally, your name in the
          spaces provided, then click 
          <SPAN
122 123
CLASS="QUOTE"
>"Create Account"</SPAN
124 125 126
>

          .</P
127 128 129
></LI
><LI
><P
130 131 132 133 134
>Within moments, you should receive an email to the address
          you provided above, which contains your login name (generally the
          same as the email address), and a password you can use to access
          your account. This password is randomly generated, and can be
          changed to something more memorable.</P
135 136 137
></LI
><LI
><P
138 139
>Click the 
          <SPAN
140 141
CLASS="QUOTE"
>"Log In"</SPAN
142 143 144 145 146
>
          link in the yellow area at the bottom of the page in your browser,
          enter your email address and password into the spaces provided, and
          click 
          <SPAN
147 148 149
CLASS="QUOTE"
>"Login"</SPAN
>.
150
          </P
151 152 153
></LI
></OL
><P
154 155 156
>You are now logged in. Bugzilla uses cookies for authentication
      so, unless your IP address changes, you should not have to log in
      again.</P
157 158
></DIV
><DIV
159
CLASS="section"
160
><H2
161
CLASS="section"
162
><A
163
NAME="bug_page">3.1.2. Anatomy of a Bug</H2
164
><P
165 166 167 168
>The core of Bugzilla is the screen which displays a particular
      bug. It's a good place to explain some Bugzilla concepts. 
      <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/show_bug.cgi?id=1"
169
TARGET="_top"
170 171 172 173 174 175 176
>&#13;      Bug 1 on Landfill</A
>

      is a good example. Note that the labels for most fields are hyperlinks;
      clicking them will take you to context-sensitive help on that
      particular field. Fields marked * may not be present on every
      installation of Bugzilla.</P
177 178 179 180 181 182
><P
></P
><OL
TYPE="1"
><LI
><P
183
>&#13;          <EM
184
>Product and Component</EM
185 186 187 188 189 190
>: 
          Bugs are divided up by Product and Component, with a Product
          having one or more Components in it. For example,
          bugzilla.mozilla.org's "Bugzilla" Product is composed of several
          Components: 
          <P
191 192 193 194 195 196
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
197 198 199 200
>&#13;          <EM
>Administration:</EM
>
          Administration of a Bugzilla installation.</TD
201 202 203
></TR
><TR
><TD
204 205 206
>&#13;          <EM
>Bugzilla-General:</EM
>
207
          Anything that doesn't fit in the other components, or spans
208
          multiple components.</TD
209 210 211
></TR
><TR
><TD
212 213 214 215
>&#13;          <EM
>Creating/Changing Bugs:</EM
>
          Creating, changing, and viewing bugs.</TD
216 217 218
></TR
><TR
><TD
219 220 221 222
>&#13;          <EM
>Documentation:</EM
>
          The Bugzilla documentation, including The Bugzilla Guide.</TD
223 224 225
></TR
><TR
><TD
226 227 228 229
>&#13;          <EM
>Email:</EM
>
          Anything to do with email sent by Bugzilla.</TD
230 231 232
></TR
><TR
><TD
233 234 235 236
>&#13;          <EM
>Installation:</EM
>
          The installation process of Bugzilla.</TD
237 238 239
></TR
><TR
><TD
240 241 242 243 244
>&#13;          <EM
>Query/Buglist:</EM
>
          Anything to do with searching for bugs and viewing the
          buglists.</TD
245 246 247
></TR
><TR
><TD
248 249 250 251
>&#13;          <EM
>Reporting/Charting:</EM
>
          Getting reports from Bugzilla.</TD
252 253 254
></TR
><TR
><TD
255 256 257
>&#13;          <EM
>User Accounts:</EM
>
258
          Anything about managing a user account from the user's perspective.
259 260
          Saved queries, creating accounts, changing passwords, logging in,
          etc.</TD
261 262 263
></TR
><TR
><TD
264 265 266
>&#13;          <EM
>User Interface:</EM
>
267
          General issues having to do with the user interface cosmetics (not
268 269
          functionality) including cosmetic issues, HTML templates,
          etc.</TD
270 271 272 273 274 275
></TR
></TBODY
></TABLE
><P
></P
>
276
          </P
277 278
></LI
><LI
279
><P
280 281 282 283 284 285 286 287 288
>&#13;          <EM
>Status and Resolution:</EM
>

          These define exactly what state the bug is in - from not even
          being confirmed as a bug, through to being fixed and the fix
          confirmed by Quality Assurance. The different possible values for
          Status and Resolution on your installation should be documented in the
          context-sensitive help for those items.</P
289 290 291
></LI
><LI
><P
292 293 294 295
>&#13;          <EM
>Assigned To:</EM
>
          The person responsible for fixing the bug.</P
296 297
></LI
><LI
298
><P
299 300 301 302
>&#13;          <EM
>*URL:</EM
>
          A URL associated with the bug, if any.</P
303 304
></LI
><LI
305
><P
306 307 308 309
>&#13;          <EM
>Summary:</EM
>
          A one-sentence summary of the problem.</P
310 311 312
></LI
><LI
><P
313 314 315 316 317
>&#13;          <EM
>*Status Whiteboard:</EM
>
          (a.k.a. Whiteboard) A free-form text area for adding short notes
          and tags to a bug.</P
318 319 320
></LI
><LI
><P
321 322 323 324 325 326
>&#13;          <EM
>*Keywords:</EM
>
          The administrator can define keywords which you can use to tag and
          categorise bugs - e.g. The Mozilla Project has keywords like crash
          and regression.</P
327 328 329
></LI
><LI
><P
330 331 332 333 334
>&#13;          <EM
>Platform and OS:</EM
>
          These indicate the computing environment where the bug was
          found.</P
335 336 337
></LI
><LI
><P
338 339 340 341 342 343 344
>&#13;          <EM
>Version:</EM
>
          The "Version" field is usually used for versions of a product which
          have been released, and is set to indicate which versions of a
          Component have the particular problem the bug report is
          about.</P
345 346 347
></LI
><LI
><P
348 349 350 351 352
>&#13;          <EM
>Priority:</EM
>
          The bug assignee uses this field to prioritise his or her bugs.
          It's a good idea not to change this on other people's bugs.</P
353 354 355
></LI
><LI
><P
356 357 358 359 360 361 362
>&#13;          <EM
>Severity:</EM
>
          This indicates how severe the problem is - from blocker
          ("application unusable") to trivial ("minor cosmetic issue"). You
          can also use this field to indicate whether a bug is an enhancement
          request.</P
363 364 365
></LI
><LI
><P
366 367 368 369 370 371 372 373
>&#13;          <EM
>*Target:</EM
>
          (a.k.a. Target Milestone) A future version by which the bug is to
          be fixed. e.g. The Bugzilla Project's milestones for future
          Bugzilla versions are 2.18, 2.20, 3.0, etc. Milestones are not
          restricted to numbers, thought - you can use any text strings, such
          as dates.</P
374 375 376
></LI
><LI
><P
377 378 379 380
>&#13;          <EM
>Reporter:</EM
>
          The person who filed the bug.</P
381 382 383
></LI
><LI
><P
384 385 386 387
>&#13;          <EM
>CC list:</EM
>
          A list of people who get mail when the bug changes.</P
388 389 390
></LI
><LI
><P
391 392 393 394 395
>&#13;          <EM
>Attachments:</EM
>
          You can attach files (e.g. testcases or patches) to bugs. If there
          are any attachments, they are listed in this section.</P
396 397 398
></LI
><LI
><P
399 400 401 402 403 404
>&#13;          <EM
>*Dependencies:</EM
>
          If this bug cannot be fixed unless other bugs are fixed (depends
          on), or this bug stops other bugs being fixed (blocks), their
          numbers are recorded here.</P
405 406 407
></LI
><LI
><P
408 409 410 411
>&#13;          <EM
>*Votes:</EM
>
          Whether this bug has any votes.</P
412 413 414
></LI
><LI
><P
415 416 417 418 419
>&#13;          <EM
>Additional Comments:</EM
>
          You can add your two cents to the bug discussion here, if you have
          something worthwhile to say.</P
420 421
></LI
></OL
422 423 424 425 426 427
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
428
NAME="query">3.1.3. Searching for Bugs</H2
429
><P
430 431 432 433 434
>The Bugzilla Search page is is the interface where you can find
      any bug report, comment, or patch currently in the Bugzilla system. You
      can play with it here: 
      <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/query.cgi"
435
TARGET="_top"
436 437 438 439
>&#13;      landfill.bugzilla.org/bugzilla-tip/query.cgi</A
>

      .</P
440
><P
441 442 443 444
>The Search page has controls for selecting different possible
      values for all of the fields in a bug, as described above. Once you've
      defined a search, you can either run it, or save it as a Remembered
      Query, which can optionally appear in the footer of your pages.</P
445
><P
446 447 448 449
>Highly advanced querying is done using Boolean Charts, which have
      their own 
      <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html"
450
TARGET="_top"
451 452 453 454
>&#13;      context-sensitive help</A
>

      .</P
455 456 457 458 459 460
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
461
NAME="list">3.1.4. Bug Lists</H2
462
><P
463 464 465 466
>If you run a search, a list of matching bugs will be returned.
      The default search is to return all open bugs on the system - don't try
      running this search on a Bugzilla installation with a lot of
      bugs!</P
467
><P
468 469 470 471
>The format of the list is configurable. For example, it can be
      sorted by clicking the column headings. Other useful features can be
      accessed using the links at the bottom of the list: 
      <P
472 473 474 475 476 477
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
478 479 480 481 482 483
>&#13;        <EM
>Long Format:</EM
>

        this gives you a large page with a non-editable summary of the fields
        of each bug.</TD
484 485 486
></TR
><TR
><TD
487 488 489 490 491
>&#13;        <EM
>Change Columns:</EM
>

        change the bug attributes which appear in the list.</TD
492 493 494
></TR
><TR
><TD
495 496 497 498 499 500 501
>&#13;        <EM
>Change several bugs at once:</EM
>

        If your account is sufficiently empowered, you can make the same
        change to all the bugs in the list - for example, changing their
        owner.</TD
502 503 504
></TR
><TR
><TD
505 506 507 508 509
>&#13;        <EM
>Send mail to bug owners:</EM
>

        Sends mail to the owners of all bugs on the list.</TD
510 511 512
></TR
><TR
><TD
513 514 515 516 517 518 519
>&#13;        <EM
>Edit this query:</EM
>

        If you didn't get exactly the results you were looking for, you can
        return to the Query page through this link and make small revisions
        to the query you just made so you get more accurate results.</TD
520 521 522 523 524 525 526 527 528
></TR
></TBODY
></TABLE
><P
></P
>
      </P
></DIV
><DIV
529
CLASS="section"
530
><H2
531
CLASS="section"
532
><A
533
NAME="bugreports">3.1.5. Filing Bugs</H2
534
><P
535 536 537 538
>Years of bug writing experience has been distilled for your
      reading pleasure into the 
      <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html"
539
TARGET="_top"
540 541 542 543 544 545 546 547
>&#13;      Bug Writing Guidelines</A
>. 
      While some of the advice is Mozilla-specific, the basic principles of
      reporting Reproducible, Specific bugs, isolating the Product you are
      using, the Version of the Product, the Component which failed, the
      Hardware Platform, and Operating System you were using at the time of
      the failure go a long way toward ensuring accurate, responsible fixes
      for the bug that bit you.</P
548
><P
549
>The procedure for filing a test bug is as follows:</P
550 551 552 553 554 555
><P
></P
><OL
TYPE="1"
><LI
><P
556 557 558
>Go to 
          <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/"
559
TARGET="_top"
560 561 562 563 564
>&#13;          Landfill</A
>
          in your browser and click 
          <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi"
565
TARGET="_top"
566
>&#13;          Enter a new bug report</A
567
>.
568
          </P
569 570 571
></LI
><LI
><P
572
>Select a product - any one will do.</P
573 574 575
></LI
><LI
><P
576 577 578
>Fill in the fields. Bugzilla should have made reasonable
          guesses, based upon your browser, for the "Platform" and "OS"
          drop-down boxes. If they are wrong, change them.</P
579 580 581
></LI
><LI
><P
582
>Select "Commit" and send in your bug report.</P
583 584 585 586 587 588 589 590 591
></LI
></OL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
592
SUMMARY="Footer navigation table"
593 594 595 596 597 598 599 600 601 602
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
603
HREF="using.html"
604
ACCESSKEY="P"
605 606 607 608 609 610 611 612
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
613
ACCESSKEY="H"
614 615 616 617 618 619 620
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
621
HREF="hintsandtips.html"
622
ACCESSKEY="N"
623 624 625 626 627 628 629 630
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
631
>Using Bugzilla</TD
632 633 634 635 636 637
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="using.html"
638
ACCESSKEY="U"
639 640 641 642 643 644
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
645
>Hints and Tips</TD
646 647 648 649 650 651
></TR
></TABLE
></DIV
></BODY
></HTML
>