how.html 13.5 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
"><LINK
REL="HOME"
10
TITLE="The Bugzilla Guide - 2.17.4 Development Release"
11 12 13 14 15
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
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
40
>The Bugzilla Guide - 2.17.4 Development Release</TH
41 42 43 44 45 46 47
></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 77 78
NAME="how"
></A
>3.1. How do I use Bugzilla?</H1
79
><P
80 81 82 83
>This section contains information for end-users of Bugzilla. 
    There is a Bugzilla test installation, called 
    <A
HREF="http://landfill.bugzilla.org/"
84
TARGET="_top"
85 86 87 88 89 90 91
>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
92
><DIV
93
CLASS="section"
94
><H2
95
CLASS="section"
96
><A
97 98 99
NAME="myaccount"
></A
>3.1.1. Create a Bugzilla Account</H2
100 101 102 103 104 105 106
><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/"
107
TARGET="_top"
108 109
>http://landfill.bugzilla.org/bugzilla-tip/</A
>.
110 111 112 113 114 115 116
      </P
><P
></P
><OL
TYPE="1"
><LI
><P
117 118
>Click the 
          <SPAN
119 120
CLASS="QUOTE"
>"Open a new Bugzilla account"</SPAN
121 122 123 124 125
>

          link, enter your email address and, optionally, your name in the
          spaces provided, then click 
          <SPAN
126 127
CLASS="QUOTE"
>"Create Account"</SPAN
128 129 130
>

          .</P
131 132 133
></LI
><LI
><P
134 135 136 137 138
>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
139 140 141
></LI
><LI
><P
142 143
>Click the 
          <SPAN
144 145
CLASS="QUOTE"
>"Log In"</SPAN
146 147 148 149 150
>
          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
151 152 153
CLASS="QUOTE"
>"Login"</SPAN
>.
154
          </P
155 156 157
></LI
></OL
><P
158 159 160
>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
161 162
></DIV
><DIV
163
CLASS="section"
164
><H2
165
CLASS="section"
166
><A
167 168 169
NAME="bug_page"
></A
>3.1.2. Anatomy of a Bug</H2
170
><P
171 172 173 174
>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"
175
TARGET="_top"
176 177 178 179 180 181 182
>&#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
183 184 185 186 187 188
><P
></P
><OL
TYPE="1"
><LI
><P
189
>&#13;          <EM
190
>Product and Component</EM
191 192 193 194 195 196
>: 
          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
197 198 199 200 201 202
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
203 204 205 206
>&#13;          <EM
>Administration:</EM
>
          Administration of a Bugzilla installation.</TD
207 208 209
></TR
><TR
><TD
210 211 212
>&#13;          <EM
>Bugzilla-General:</EM
>
213
          Anything that doesn't fit in the other components, or spans
214
          multiple components.</TD
215 216 217
></TR
><TR
><TD
218 219 220 221
>&#13;          <EM
>Creating/Changing Bugs:</EM
>
          Creating, changing, and viewing bugs.</TD
222 223 224
></TR
><TR
><TD
225 226 227 228
>&#13;          <EM
>Documentation:</EM
>
          The Bugzilla documentation, including The Bugzilla Guide.</TD
229 230 231
></TR
><TR
><TD
232 233 234 235
>&#13;          <EM
>Email:</EM
>
          Anything to do with email sent by Bugzilla.</TD
236 237 238
></TR
><TR
><TD
239 240 241 242
>&#13;          <EM
>Installation:</EM
>
          The installation process of Bugzilla.</TD
243 244 245
></TR
><TR
><TD
246 247 248 249 250
>&#13;          <EM
>Query/Buglist:</EM
>
          Anything to do with searching for bugs and viewing the
          buglists.</TD
251 252 253
></TR
><TR
><TD
254 255 256 257
>&#13;          <EM
>Reporting/Charting:</EM
>
          Getting reports from Bugzilla.</TD
258 259 260
></TR
><TR
><TD
261 262 263
>&#13;          <EM
>User Accounts:</EM
>
264
          Anything about managing a user account from the user's perspective.
265 266
          Saved queries, creating accounts, changing passwords, logging in,
          etc.</TD
267 268 269
></TR
><TR
><TD
270 271 272
>&#13;          <EM
>User Interface:</EM
>
273
          General issues having to do with the user interface cosmetics (not
274 275
          functionality) including cosmetic issues, HTML templates,
          etc.</TD
276 277 278 279 280 281
></TR
></TBODY
></TABLE
><P
></P
>
282
          </P
283 284
></LI
><LI
285
><P
286 287 288 289 290 291 292 293 294
>&#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
295 296 297
></LI
><LI
><P
298 299 300 301
>&#13;          <EM
>Assigned To:</EM
>
          The person responsible for fixing the bug.</P
302 303
></LI
><LI
304
><P
305 306 307 308
>&#13;          <EM
>*URL:</EM
>
          A URL associated with the bug, if any.</P
309 310
></LI
><LI
311
><P
312 313 314 315
>&#13;          <EM
>Summary:</EM
>
          A one-sentence summary of the problem.</P
316 317 318
></LI
><LI
><P
319 320 321 322 323
>&#13;          <EM
>*Status Whiteboard:</EM
>
          (a.k.a. Whiteboard) A free-form text area for adding short notes
          and tags to a bug.</P
324 325 326
></LI
><LI
><P
327 328 329 330 331 332
>&#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
333 334 335
></LI
><LI
><P
336 337 338 339 340
>&#13;          <EM
>Platform and OS:</EM
>
          These indicate the computing environment where the bug was
          found.</P
341 342 343
></LI
><LI
><P
344 345 346 347 348 349 350
>&#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
351 352 353
></LI
><LI
><P
354 355 356 357 358
>&#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
359 360 361
></LI
><LI
><P
362 363 364 365 366 367 368
>&#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
369 370 371
></LI
><LI
><P
372 373 374 375 376 377 378 379
>&#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
380 381 382
></LI
><LI
><P
383 384 385 386
>&#13;          <EM
>Reporter:</EM
>
          The person who filed the bug.</P
387 388 389
></LI
><LI
><P
390 391 392 393
>&#13;          <EM
>CC list:</EM
>
          A list of people who get mail when the bug changes.</P
394 395 396
></LI
><LI
><P
397 398 399 400 401
>&#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
402 403 404
></LI
><LI
><P
405 406 407 408 409 410
>&#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
411 412 413
></LI
><LI
><P
414 415 416 417
>&#13;          <EM
>*Votes:</EM
>
          Whether this bug has any votes.</P
418 419 420
></LI
><LI
><P
421 422 423 424 425
>&#13;          <EM
>Additional Comments:</EM
>
          You can add your two cents to the bug discussion here, if you have
          something worthwhile to say.</P
426 427
></LI
></OL
428 429 430 431 432 433
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
434 435 436
NAME="query"
></A
>3.1.3. Searching for Bugs</H2
437
><P
438 439 440 441 442
>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"
443
TARGET="_top"
444 445
>http://landfill.bugzilla.org/bugzilla-tip/query.cgi</A
>.</P
446
><P
447 448 449 450
>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
451
><P
452 453 454 455
>Highly advanced querying is done using Boolean Charts, which have
      their own 
      <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/booleanchart.html"
456
TARGET="_top"
457 458 459 460
>&#13;      context-sensitive help</A
>

      .</P
461 462 463 464 465 466
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
467 468 469
NAME="list"
></A
>3.1.4. Bug Lists</H2
470
><P
471 472 473 474
>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
475
><P
476 477 478 479
>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
480 481 482 483 484 485
></P
><TABLE
BORDER="0"
><TBODY
><TR
><TD
486 487 488 489 490 491
>&#13;        <EM
>Long Format:</EM
>

        this gives you a large page with a non-editable summary of the fields
        of each bug.</TD
492 493 494
></TR
><TR
><TD
495 496 497 498 499
>&#13;        <EM
>Change Columns:</EM
>

        change the bug attributes which appear in the list.</TD
500 501 502
></TR
><TR
><TD
503 504 505 506 507 508 509
>&#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
510 511 512
></TR
><TR
><TD
513 514 515 516 517
>&#13;        <EM
>Send mail to bug owners:</EM
>

        Sends mail to the owners of all bugs on the list.</TD
518 519 520
></TR
><TR
><TD
521 522 523 524 525 526 527
>&#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
528 529 530 531 532 533 534 535 536
></TR
></TBODY
></TABLE
><P
></P
>
      </P
></DIV
><DIV
537
CLASS="section"
538
><H2
539
CLASS="section"
540
><A
541 542 543
NAME="bugreports"
></A
>3.1.5. Filing Bugs</H2
544
><P
545 546 547 548
>Years of bug writing experience has been distilled for your
      reading pleasure into the 
      <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/bugwritinghelp.html"
549
TARGET="_top"
550 551 552 553 554 555 556 557
>&#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
558
><P
559
>The procedure for filing a test bug is as follows:</P
560 561 562 563 564 565
><P
></P
><OL
TYPE="1"
><LI
><P
566 567 568
>Go to 
          <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/"
569
TARGET="_top"
570 571 572 573 574
>&#13;          Landfill</A
>
          in your browser and click 
          <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/enter_bug.cgi"
575
TARGET="_top"
576
>&#13;          Enter a new bug report</A
577
>.
578
          </P
579 580 581
></LI
><LI
><P
582
>Select a product - any one will do.</P
583 584 585
></LI
><LI
><P
586 587 588
>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
589 590 591
></LI
><LI
><P
592
>Select "Commit" and send in your bug report.</P
593 594 595 596 597 598 599 600 601
></LI
></OL
></DIV
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
602
SUMMARY="Footer navigation table"
603 604 605 606 607 608 609 610 611 612
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
613
HREF="using.html"
614
ACCESSKEY="P"
615 616 617 618 619 620 621 622
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
623
ACCESSKEY="H"
624 625 626 627 628 629 630
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
631
HREF="hintsandtips.html"
632
ACCESSKEY="N"
633 634 635 636 637 638 639 640
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
641
>Using Bugzilla</TD
642 643 644 645 646 647
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="using.html"
648
ACCESSKEY="U"
649 650 651 652 653 654
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
655
>Hints and Tips</TD
656 657 658 659 660 661
></TR
></TABLE
></DIV
></BODY
></HTML
>