faq.xml 40.9 KB
Newer Older
1
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
2

3
<appendix id="faq">
4 5
  <title>The Bugzilla FAQ</title>

6 7 8 9
  <para>
    This FAQ includes questions not covered elsewhere in the Guide.
  </para>
  
10 11 12
  <qandaset>


13
    <qandadiv id="faq-general">
14 15 16
      <title>General Questions</title>

      <qandaentry>
17
	<question id="faq-general-information">
18 19 20 21 22 23
	  <para>
	    Where can I find information about Bugzilla?</para>
	</question>
	<answer>
	  <para>
	    You can stay up-to-date with the latest Bugzilla
24
	    information at <ulink url="http://www.bugzilla.org/"/>.
25 26 27 28 29
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
30
	<question id="faq-general-license">
31 32 33 34 35 36
	  <para>
	    What license is Bugzilla distributed under?
	  </para>
	</question>
	<answer>
	  <para>
37
	    Bugzilla is covered by the Mozilla Public License.
38
	    See details at <ulink url="http://www.mozilla.org/MPL/"/>.
39 40 41 42 43
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
44
	<question id="faq-general-support">
45 46 47 48 49
	  <para>
	    How do I get commercial support for Bugzilla?
	  </para>
	</question>
	<answer>
50
          <para>
51
            <ulink url="http://bugzilla.org/consulting.html"/>
52 53 54
            is a list of people and companies who have asked us to list them
            as consultants for Bugzilla.
          </para>
55
	  <para>
56
	    <ulink url="http://www.collab.net/"/> offers
57 58 59
	    Bugzilla as part of their standard offering to large projects.
	    They do have some minimum fees that are pretty hefty, and generally
	    aren't interested in small projects.
60 61
	  </para>
	  <para>
62 63
	    There are several experienced
	    Bugzilla hackers on the mailing list/newsgroup who are willing
64
	    to make themselves available for generous compensation.
65
	    Try sending a message to the mailing list asking for a volunteer.
66 67 68 69 70
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
71
	<question id="faq-general-companies">
72
	  <para>
73 74
	    What major companies or projects are currently using Bugzilla
	    for bug-tracking?
75 76 77 78
	  </para>
	</question>
	<answer>
	  <para>
79
	    There are <emphasis>dozens</emphasis> of major companies with public
80 81 82 83 84 85 86
	    Bugzilla sites to track bugs in their products. We have a fairly
            complete list available on our website at
            <ulink url="http://bugzilla.org/installation_list.html"/>. If you
            have an installation of Bugzilla and would like to be added to the
            list, whether it's a public install or not, simply e-mail
            Gerv <email>gerv@mozilla.org</email>. Keep in mind that it's kinda
            difficult to get onto the <quote>high-profile</quote> list ;).
87 88 89 90 91
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
92
	<question id="faq-general-maintainers">
93 94 95 96 97 98
	  <para>
	    Who maintains Bugzilla?
	  </para>
	</question>
	<answer>
	  <para>
99 100
	    A 
      <ulink url="http://www.bugzilla.org/who_we_are.html">core team</ulink>,
101
      led by Dave Miller (justdave@bugzilla.org).
102 103 104 105 106
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
107
	<question id="faq-general-compare">
108
	  <para>
109
	    How does Bugzilla stack up against other bug-tracking databases?
110 111 112 113
	  </para>
	</question>
	<answer>
	  <para>
114 115 116
	    We can't find any head-to-head comparisons of Bugzilla against
	    other defect-tracking software. If you know of one, please
      get in touch. However, from the author's personal
117 118 119 120 121 122
	    experience with other bug-trackers, Bugzilla offers
	    superior performance on commodity hardware, better price
	    (free!), more developer- friendly features (such as stored
	    queries, email integration, and platform independence),
	    improved scalability, open source code, greater
	    flexibility, and superior ease-of-use.
123 124
	  </para>
	  <para>
125
	    If you happen to be a commercial bug-tracker vendor, please
126 127 128
	    step forward with a list of advantages your product has over
      Bugzilla. We'd be happy to include it in the "Competitors"
      section.
129 130 131 132 133
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
134
	<question id="faq-general-bzmissing">
135
	  <para>
136
	    Why doesn't Bugzilla offer this or that feature or compatibility
137
	    with this other tracking software?
138 139 140 141
	  </para>
	</question>
	<answer>
	  <para>
142
	    It may be that the support has not been built yet, or that you
143 144
	    have not yet found it. Bugzilla is making tremendous strides in
	    usability, customizability, scalability, and user interface. It
145 146
	    is widely considered the most complete and popular open-source
	    bug-tracking software in existence.
147 148
	  </para>
	  <para>
149 150 151 152
	    That doesn't mean it can't use improvement!
	    You can help the project along by either hacking a patch yourself
	    that supports the functionality you require, or else submitting a
	    "Request for Enhancement" (RFE) using the bug submission interface
153
	    at <ulink url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">bugzilla.mozilla.org</ulink>.
154 155 156 157 158
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
159
	<question id="faq-general-mysql">
160 161
	  <para>
	    Why MySQL?  I'm interested in seeing Bugzilla run on
162
	    Oracle/Sybase/Msql/PostgreSQL/MSSQL.
163 164 165
	  </para>
	</question>
	<answer>
166
	  <para>
167 168 169 170 171
            MySQL was originally chosen because it is free, easy to install,
            and was available for the hardware Netscape intended to run it on.
	  </para>
          <para>
            There is currently work in progress to make Bugzilla work on
172 173 174
            PostgreSQL and Sybase in the default distribution. You can track
            the progress of these initiatives in <ulink
            url="http://bugzilla.mozilla.org/show_bug.cgi?id=98304">bug 98304</ulink>
175
            and <ulink
176
            url="http://bugzilla.mozilla.org/show_bug.cgi?id=173130">bug 173130</ulink>
177 178 179 180 181 182
            respectively.
          </para>
          <para>
            Once both of these are done, adding support for additional
            database servers should be trivial.
          </para>
183 184 185 186
	</answer>
      </qandaentry>

      <qandaentry>
187
	<question id="faq-general-bonsaitools">
188
	  <para>
189
	    What is <filename>/usr/bonsaitools/bin/perl</filename>?
190 191 192 193
	  </para>
	</question>
	<answer>
	  <para>
194 195 196 197
            Bugzilla used to have the path to perl on the shebang line set to
            <filename>/usr/bonsaitools/bin/perl</filename> because when
            Terry first started writing the code for mozilla.org he needed a
            version of Perl and other tools that were completely under his
198 199
            control. This location was abandoned for the 2.18 release in favor
            of the more sensible <filename>/usr/bin/perl</filename>. If you
200 201 202 203 204
            installed an older verion of Bugzilla and created the symlink we
            suggested, you can remove it now (provided that you don't have
            anything else, such as Bonsai, using it and you don't intend to
            reinstall an older version of Bugzilla).
          </para>
205 206 207
	</answer>
      </qandaentry>

208 209 210 211 212 213 214 215 216 217
      <qandaentry>
        <question id="faq-general-perlpath">
          <para>
            My perl is not located at <filename>/usr/bin/perl</filename>, is
            there an easy way to change it everywhere it needs to be changed?
          </para>
        </question>
        <answer>
          <para>
            Yes, the following bit of perl magic will change all the shebang
218
            lines. Be sure to change <filename>/usr/local/bin/perl</filename>
219 220 221 222 223 224 225
            to your path to the perl binary.
          </para>
          <programlisting>
perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl
          </programlisting>
        </answer>
      </qandaentry>
226 227

      <qandaentry>
228
	<question id="faq-general-cookie">
229 230 231 232 233 234 235 236 237 238 239
	  <para>
	    Is there an easy way to change the Bugzilla cookie name?
	  </para>
	</question>
	<answer>
	  <para>
	    At present, no.
	  </para>
	</answer>
      </qandaentry>
      
240 241
    </qandadiv>

242
    <qandadiv id="faq-phb">
243
      <title>Managerial Questions</title>
244 245 246
      <para>
	<note>
	  <para>
247
	    Questions likely to be asked by managers. :-)
248 249 250
	  </para>
	</note>
      </para>
251 252

      <qandaentry>
253
	<question id="faq-phb-client">
254
	  <para>
255 256
	    Is Bugzilla web-based, or do you have to have specific software or
	    a specific operating system on your machine?
257 258 259 260
	  </para>
	</question>
	<answer>
	  <para>
261
	    It is web and e-mail based. You can edit bugs by sending specially
262
	    formatted email to a properly configured Bugzilla, or control via the web.
263 264 265 266 267
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
268
	<question id="faq-phb-integration">
269
	  <para>
270
	    Can Bugzilla integrate with
271
	    Perforce (SCM software)?
272 273 274 275
	  </para>
	</question>
	<answer>
	  <para>
276 277
	    Yes!  You can find more information elsewhere in "The Bugzilla
	    Guide" in the "Integration with Third-Party Products" section.
278 279 280 281 282
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
283
	<question id="faq-phb-projects">
284 285 286 287 288 289
	  <para>
	    Does Bugzilla allow the user to track multiple projects?
	  </para>
	</question>
	<answer>
	  <para>
290 291
	    Absolutely!  You can track any number of Products that can each be
            composed of any number of Components.
292 293 294 295 296
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
297
	<question id="faq-phb-sorting">
298
	  <para>
299 300
	    If I am on many projects, and search for all bugs assigned to me, will
	    Bugzilla list them for me and allow me to sort by project, severity etc?
301 302 303 304 305 306 307 308 309 310
	  </para>
	</question>
	<answer>
	  <para>
	    Yes.
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
311
	<question id="faq-phb-attachments">
312
	  <para>
313
	    Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes,
314
	    are there any that are NOT allowed?
315 316 317 318
	  </para>
	</question>
	<answer>
	  <para>
319
	    Yes - any sort of attachment is allowed, although administrators can
320
      configure a maximum size.
321 322 323
            Bugzilla gives the user the option of either using the MIME-type
            supplied by the browser, choosing from a pre-defined list or
            manually typing any arbitrary MIME-type. 
324 325 326 327 328
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
329
	<question id="faq-phb-priorities">
330
	  <para>
331 332 333
	    Does Bugzilla allow us to define our own priorities and levels? Do we
	    have complete freedom to change the labels of fields and format of them, and
	    the choice of acceptable values?
334 335 336 337
	  </para>
	</question>
	<answer>
	  <para>
338
	    Yes. However, modifying some fields, notably those related to bug
339 340
	    progression states, also require adjusting the program logic to
	    compensate for the change.
341
	  </para>
342 343
	  <para>
	    There is no GUI for adding fields to Bugzilla at this
344 345
	    time. You can follow development of this feature in 
	    <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=91037">bug 91037</ulink>
346
	  </para>
347 348 349 350
	</answer>
      </qandaentry>

      <qandaentry>
351
	<question id="faq-phb-reporting">
352
	  <para>
353 354
	    Does Bugzilla provide any reporting features, metrics, graphs, etc? You
	    know, the type of stuff that management likes to see. :)
355 356 357 358
	  </para>
	</question>
	<answer>
	  <para>
359 360
	    Yes. Look at <ulink url="http://bugzilla.mozilla.org/report.cgi"/>
            for samples of what Bugzilla can do in reporting and graphing.
361 362
	  </para>
	  <para>
363 364 365 366 367 368
            If you can not get the reports you want from the included reporting
            scripts, it is possible to hook up a professional reporting package
            such as Crystal Reports using ODBC. If you choose to do this,
            beware that giving direct access to the database does contain some
            security implications. Even if you give read-only access to the
            bugs database it will bypass the secure bugs features of Bugzilla.
369 370 371 372 373
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
374
	<question id="faq-phb-email">
375
	  <para>
376
	    Is there email notification and if so, what do you see when you get an
377
	    email?
378 379 380 381
	  </para>
	</question>
	<answer>
	  <para>
382
	    Email notification is user-configurable. By default, the bug id and 
383
      Summary of the bug report accompany each email notification, along with
384
	    a list of the changes made.
385 386 387 388 389
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
390
	<question id="faq-phb-cclist">
391 392 393 394 395 396 397 398 399 400 401 402 403
	  <para>
	    Can email notification be set up to send to multiple
	    people, some on the To List, CC List, BCC List etc?
	  </para>
	</question>
	<answer>
	  <para>
	    Yes.
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
404
	<question id="faq-phb-emailapp">
405
	  <para>
406
	    Do users have to have any particular
407
	    type of email application?
408 409 410 411
	  </para>
	</question>
	<answer>
	  <para>
412 413
	    Bugzilla email is sent in plain text, the most compatible mail format
	    on the planet.
414 415
	    <note>
	      <para>
416 417 418
		If you decide to use the bugzilla_email integration features
		to allow Bugzilla to record responses to mail with the associated bug,
		you may need to caution your users to set their mailer to "respond
419
		to messages in the format in which they were sent". For security reasons
420 421
		Bugzilla ignores HTML tags in comments, and if a user sends HTML-based
		email into Bugzilla the resulting comment looks downright awful.
422 423 424 425 426 427 428
	      </para>
	    </note>
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
429
	<question id="faq-phb-data">
430
	  <para>
431 432 433 434
	    Does Bugzilla allow data to be imported and exported? If I had outsiders
	    write up a bug report using a MS Word bug template, could that template be
	    imported into "matching" fields? If I wanted to take the results of a query
	    and export that data to MS Excel, could I do that?
435 436 437
	  </para>
	</question>
	<answer>
438 439 440
          <para>
            Bugzilla can output buglists as HTML (the default), CSV or RDF.
            The link for CSV can be found at the bottom of the buglist in HTML
441
            format. This CSV format can easily be imported into MS Excel or
442 443 444 445
            other spread-sheet applications.
          </para>
          <para>
            To use the RDF format of the buglist it is necessary to append a
446
            <computeroutput>&amp;ctype=rdf</computeroutput> to the URL. RDF
447 448 449 450 451 452 453
            is meant to be machine readable and thus it is assumed that the
            URL would be generated progmatically so there is no user visible
            link to this format.
          </para>
          <para>
            Currently the only script included with Bugzilla that can import
            data is <filename>importxml.pl</filename> which is intended to be
454 455 456
            used for importing the data generated by the XML ctype of
            <filename>show_bug.cgi</filename> in association with bug moving.
            Any other use is left as an exercise for the user.
457 458 459 460 461 462 463
          </para>
          <para>
            There are also scripts included in the <filename>contrib/</filename>
            directory for using e-mail to import information into Bugzilla,
            but these scripts are not currently supported and included for
            educational purposes.
          </para>
464 465 466 467
	</answer>
      </qandaentry>

      <qandaentry>
468
	<question id="faq-phb-l10n">
469
	  <para>
470 471
	    Has anyone converted Bugzilla to another language to be used in other
	    countries? Is it localizable?
472 473 474 475
	  </para>
	</question>
	<answer>
	  <para>
476
            Yes. For more information including available translated templates,
477
            see <ulink
478
            url="http://www.bugzilla.org/download.html#localizations"/>.
479
            The admin interfaces are still not included in these translated
480 481
            templates and is therefore still English only. Also, there may be
            issues with the charset not being declared. See <ulink
482 483
            url="http://bugzilla.mozilla.org/show_bug.cgi?id=126266">bug 126226</ulink>
            for more information.
484 485 486 487 488
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
489
	<question id="faq-phb-reports">
490
	  <para>
491 492
	    Can a user create and save reports? Can they do this in Word format?
	    Excel format?
493 494 495 496
	  </para>
	</question>
	<answer>
	  <para>
497
	    Yes. No. Yes (using the CSV format).
498 499 500 501 502
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
503
	<question id="faq-phb-searching">
504
	  <para>
505 506
	    Does Bugzilla have the ability to search by word, phrase, compound
	    search?
507 508 509 510
	  </para>
	</question>
	<answer>
	  <para>
511
	    You have no idea. Bugzilla's query interface, particularly with the
512
	    advanced Boolean operators, is incredibly versatile.
513 514 515 516 517
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
518
	<question id="faq-phb-midair">
519
	  <para>
520 521 522
	     Does Bugzilla provide record locking when there is simultaneous access
	    to the same bug? Does the second person get a notice that the bug is in use
	    or how are they notified?
523 524 525 526
	  </para>
	</question>
	<answer>
	  <para>
527
	    Bugzilla does not lock records. It provides mid-air collision detection,
528
	    and offers the offending user a choice of options to deal with the conflict.
529 530 531 532 533
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
534
	<question id="faq-phb-backup">
535 536 537 538 539 540
	  <para>
	    Are there any backup features provided?
	  </para>
	</question>
	<answer>
	  <para>
541 542
	    MySQL, the database back-end for Bugzilla, allows hot-backup of data.
	    You can find strategies for dealing with backup considerations
543
	    at <ulink url="http://www.mysql.com/doc/B/a/Backup.html"/>.
544 545 546 547 548
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
549
	<question id="faq-phb-livebackup">
550 551 552 553 554 555
	  <para>
	    Can users be on the system while a backup is in progress?
	  </para>
	</question>
	<answer>
	  <para>
556 557
	    Yes. However, commits to the database must wait
	    until the tables are unlocked. Bugzilla databases are typically
558 559 560 561 562 563
	    very small, and backups routinely take less than a minute.
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
564
	<question id="faq-phb-maintenance">
565
	  <para>
566 567 568 569 570
	    What type of human resources are needed to be on staff to install and
	    maintain Bugzilla? Specifically, what type of skills does the person need to
	    have? I need to find out if we were to go with Bugzilla, what types of
	    individuals would we need to hire and how much would that cost vs buying an
	    "Out-of-the-Box" solution.
571 572 573 574
	  </para>
	</question>
	<answer>
	  <para>
575 576
	    If Bugzilla is set up correctly from the start, continuing maintenance
      needs are minimal and can be done easily using the web interface.
577 578
	  </para>
	  <para>
579
	    Commercial Bug-tracking software typically costs somewhere upwards
580
	    of $20,000 or more for 5-10 floating licenses. Bugzilla consultation
581 582
	    is available from skilled members of the newsgroup. Simple questions
      are answered there and then.
583 584 585 586 587
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
588
	<question id="faq-phb-installtime">
589
	  <para>
590 591 592 593 594
	    What time frame are we looking at if we decide to hire people to install
	    and maintain the Bugzilla? Is this something that takes hours or weeks to
	    install and a couple of hours per week to maintain and customize or is this
	    a multi-week install process, plus a full time job for 1 person, 2 people,
	    etc?
595 596 597 598
	  </para>
	</question>
	<answer>
	  <para>
599
	    It all depends on your level of commitment. Someone with much Bugzilla
600
	    experience can get you up and running in less than a day, and
601
	    your Bugzilla install can run untended for years. If your
602 603
	    Bugzilla strategy is critical to your business workflow, hire somebody
	    with reasonable UNIX or Perl skills to handle your process management and
604
	    bug-tracking maintenance &amp; customization.
605 606 607 608 609
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
610
	<question id="faq-phb-cost">
611
	  <para>
612 613
	    Is there any licensing fee or other fees for using Bugzilla? Any
	    out-of-pocket cost other than the bodies needed as identified above?
614 615 616 617
	  </para>
	</question>
	<answer>
	  <para>
618
	    No. MySQL asks, if you find their product valuable, that you purchase
619
	    a support contract from them that suits your needs.
620 621 622 623 624
	  </para>
	</answer>
      </qandaentry>
    </qandadiv>

625
    <qandadiv id="faq-security">
626 627 628
      <title>Bugzilla Security</title>

      <qandaentry>
629
	<question id="faq-security-mysql">
630
	  <para>
631
	    How do I completely disable MySQL security if it's giving me problems
632
	    (I've followed the instructions in the installation section of this guide)?
633 634 635 636
	  </para>
	</question>
	<answer>
	  <para>
637
	    Run MySQL like this: "mysqld --skip-grant-tables". Please remember <emphasis>this
638
	    makes MySQL as secure as taping a $100 to the floor of a football stadium
639
	    bathroom for safekeeping.</emphasis> 
640 641 642 643 644
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
645
	<question id="faq-security-knownproblems">
646 647 648 649 650 651
	  <para>
	    Are there any security problems with Bugzilla?
	  </para>
	</question>
	<answer>
	  <para>
652 653 654
	    The Bugzilla code has undergone a reasonably complete security audit,
      and user-facing CGIs run under Perl's taint mode. However, 
	    it is recommended that you closely examine permissions on your Bugzilla
655 656
	    installation, and follow the recommended security guidelines found
	    in The Bugzilla Guide.
657 658 659 660 661 662
	  </para>
	</answer>
      </qandaentry>


      <qandaentry>
663
	<question id="faq-security-mysqluser">
664
	  <para>
665 666 667
	    I've implemented the security fixes mentioned in Chris Yeh's security
	    advisory of 5/10/2000 advising not to run MySQL as root, and am running into
	    problems with MySQL no longer working correctly.
668 669 670 671
	  </para>
	</question>
	<answer>
	  <para>
672 673 674
	    This is a common problem, related to running out of file descriptors.
	    Simply add "ulimit -n unlimited" to the script which starts
	    mysqld.
675 676 677 678 679
	  </para>
	</answer>
      </qandaentry>
    </qandadiv>

680
    <qandadiv id="faq-email">
681 682 683
      <title>Bugzilla Email</title>

      <qandaentry>
684
	<question id="faq-email-nomail">
685
	  <para>
686 687
	    I have a user who doesn't want to receive any more email from Bugzilla.
	    How do I stop it entirely for this user?
688 689 690 691
	  </para>
	</question>
	<answer>
	  <para>
692
	    The user should be able to set
693 694
	    this in user email preferences (uncheck all boxes) or you can add
            their email address to the <filename>data/nomail</filename> file.
695 696 697 698 699
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
700
	<question id="faq-email-testing">
701
	  <para>
702 703
	    I'm evaluating/testing Bugzilla, and don't want it to send email to
	    anyone but me. How do I do it?
704 705 706 707
	  </para>
	</question>
	<answer>
	  <para>
708
	    Edit the "newchangedmail" Param. Replace "To:" with "X-Real-To:",
709
	    replace "Cc:" with "X-Real-CC:", and add a "To: &lt;youremailaddress&gt;".
710 711 712 713 714
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
715
	<question id="faq-email-whine">
716
	  <para>
717 718
	    I want whineatnews.pl to whine at something more, or other than, only new
	    bugs. How do I do it?
719 720 721 722
	  </para>
	</question>
	<answer>
	  <para>
723 724 725
	    Try Klaas Freitag's excellent patch for "whineatassigned"
            functionality. You can find it in <ulink
            url="http://bugzilla.mozilla.org/show_bug.cgi?id=6679">bug 6679</ulink>. This
726 727
	    patch is against an older version of Bugzilla, so you must apply
	    the diffs manually.
728
            <!-- TODO: Mention Joel's "Fine Whine" patch. -->
729 730 731 732 733
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
734
	<question id="faq-email-procmail">
735
	  <para>
736 737
	    I don't like/want to use Procmail to hand mail off to bug_email.pl.
	    What alternatives do I have?
738 739 740 741
	  </para>
	</question>
	<answer>
	  <para>
742 743
	    You can call bug_email.pl directly from your aliases file, with
	    an entry like this:
744 745
	    <blockquote>
	      <para>
746
		bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl"
747
	      </para>
748 749 750
	    </blockquote>
	    However, this is fairly nasty and subject to problems; you also
	    need to set up your smrsh (sendmail restricted shell) to allow
751
	    it. In a pinch, though, it can work.
752 753 754 755 756
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
757
	<question id="faq-email-mailif">
758
	  <para>
759
	    How do I set up the email interface to submit/change bugs via email?
760 761 762 763
	  </para>
	</question>
	<answer>
	  <para>
764 765
	    You can find an updated README.mailif file in the contrib/ directory
	    of your Bugzilla distribution that walks you through the setup.
766 767 768 769 770
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
771
	<question id="faq-email-sendmailnow">
772
	  <para>
773
	    Email takes FOREVER to reach me from Bugzilla -- it's extremely slow.
774
	    What gives?
775 776 777 778
	  </para>
	</question>
	<answer>
	  <para>
779 780 781 782 783
	    If you are using an alternate <glossterm linkend="gloss-mta">MTA</glossterm>,
            make sure the options given in <filename>Bugzilla/BugMail.pm</filename>
            and any other place where <application>sendmail</application> is called from
	    are correct for your MTA. You should also ensure that the
            <option>sendmailnow</option> param is set to <literal>on</literal>.
784 785
	  </para>
	  <para>
786 787 788
	    If you are using <application>sendmail</application>, try enabling
            <option>sendmailnow</option> in <filename>editparams.cgi</filename>.
            <!-- TODO provide more info about this, possibly a link to admin -->
789 790 791 792 793
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
794
	<question id="faq-email-nonreceived">
795
	  <para>
796
	     How come email from Bugzilla changes never reaches me?
797 798 799 800
	  </para>
	</question>
	<answer>
	  <para>
801 802 803 804
	    Double-check that you have not turned off email in your user preferences.
	    Confirm that Bugzilla is able to send email by visiting the "Log In"
	    link of your Bugzilla installation and clicking the "Email me a password"
	    button after entering your email address.
805 806
	  </para>
	  <para>
807
	    If you never receive mail from Bugzilla, chances you do not have
808
	    sendmail in "/usr/lib/sendmail". Ensure sendmail lives in, or is symlinked
809
	    to, "/usr/lib/sendmail".
810 811 812 813 814
	  </para>
	</answer>
      </qandaentry>
    </qandadiv>

815
    <qandadiv id="faq-db">
816 817 818
      <title>Bugzilla Database</title>

      <qandaentry>
819
	<question id="faq-db-oracle">
820 821 822 823 824 825
	  <para>
	    I've heard Bugzilla can be used with Oracle?
	  </para>
	</question>
	<answer>
	  <para>
826 827
            Red Hat's old version of Bugzilla (based on 2.8) worked on Oracle.
            Red Hat's newer version (based on 2.17.1 and soon to be merged into
828
            the main distribution) runs on PostgreSQL. At this time we know of
829 830
            no recent ports of Bugzilla to Oracle but do intend to support it
            in the future (possibly the 2.20 time-frame).
831 832 833 834 835
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
836
	<question id="faq-db-corrupted">
837
	  <para>
838 839
	    I think my database might be corrupted, or contain invalid entries. What
	    do I do?
840 841 842 843
	  </para>
	</question>
	<answer>
	  <para>
844 845 846 847
	    Run the <quote>sanity check</quote> utility
	    (<filename>./sanitycheck.cgi</filename> in the
	    Bugzilla_home directory) from your web browser to see! If
	    it finishes without errors, you're
848
	    <emphasis>probably</emphasis> OK. If it doesn't come back
849
	    OK (i.e. any red letters), there are certain things
850
	    Bugzilla can recover from and certain things it can't. If
851 852
	    it can't auto-recover, I hope you're familiar with
	    mysqladmin commands or have installed another way to
853
	    manage your database. Sanity Check, although it is a good
854 855
	    basic check on your database integrity, by no means is a
	    substitute for competent database administration and
856
	    avoiding deletion of data. It is not exhaustive, and was
857 858
	    created to do a basic check for the most common problems
	    in Bugzilla databases.
859 860 861 862 863
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
864
	<question id="faq-db-manualedit">
865 866 867 868 869 870
	  <para>
	    I want to manually edit some entries in my database. How?
	  </para>
	</question>
	<answer>
	  <para>
871 872
	     There is no facility in Bugzilla itself to do this. It's also generally
	    not a smart thing to do if you don't know exactly what you're doing.
873 874
	    However, if you understand SQL you can use the <command>mysql</command>
            command line utility to manually insert, delete and modify table
875
            information. There are also more intuitive GUI clients available.
876 877 878 879
            Personal favorites of the Bugzilla team are <ulink
            url="http://www.phpmyadmin.net/">phpMyAdmin</ulink> and <ulink
            url="http://www.mysql.com/downloads/gui-mycc.html">MySQL Control
            Center</ulink>.
880 881 882 883 884
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
885
	<question id="faq-db-permissions">
886
	  <para>
887
	    I think I've set up MySQL permissions correctly, but Bugzilla still can't
888
	    connect.
889 890 891 892
	  </para>
	</question>
	<answer>
	  <para>
893 894
	    Try running MySQL from its binary: "mysqld --skip-grant-tables". This
	    will allow you to completely rule out grant tables as the cause of your
895 896 897 898 899 900 901 902 903 904 905
            frustration. If this Bugzilla is able to connect at this point then
            you need to check that you have granted proper permission to the user
            password combo defined in <filename>localconfig</filename>.
          </para>
          <warning>
            <para>
              Running MySQL with this command line option is very insecure and
              should only be done when not connected to the external network
              as a troubleshooting step.
            </para>
          </warning>
906 907 908 909
	</answer>
      </qandaentry>

      <qandaentry>
910
	<question id="faq-db-synchronize">
911
	  <para>
912 913
	    How do I synchronize bug information among multiple different Bugzilla
	    databases?
914 915 916 917
	  </para>
	</question>
	<answer>
	  <para>
918
	    Well, you can synchronize or you can move bugs. Synchronization will
919 920 921
	    only work one way -- you can create a read-only copy of the database
	    at one site, and have it regularly updated at intervals from the main
	    database.
922 923
	  </para>
	  <para>
924 925 926 927
	    MySQL has some synchronization features builtin to the latest releases.
	    It would be great if someone looked into the possibilities there
	    and provided a report to the newsgroup on how to effectively
	    synchronize two Bugzilla installations.
928 929
	  </para>
	  <para>
930 931
	    If you simply need to transfer bugs from one Bugzilla to another,
	    checkout the "move.pl" script in the Bugzilla distribution.
932 933 934 935 936
	  </para>
	</answer>
      </qandaentry>
    </qandadiv>

937
    <qandadiv id="faq-nt">
938 939 940
      <title>Bugzilla and Win32</title>

      <qandaentry>
941
	<question id="faq-nt-easiest">
942
	  <para>
943
	    What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
944 945 946 947
	  </para>
	</question>
	<answer>
	  <para>
948 949
	    Remove Windows. Install Linux. Install Bugzilla.
	    The boss will never know the difference.
950 951 952 953 954
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
955
	<question id="faq-nt-bundle">
956 957 958 959 960 961
	  <para>
	    Is there a "Bundle::Bugzilla" equivalent for Win32?
	  </para>
	</question>
	<answer>
	  <para>
962 963
	    Not currently. Bundle::Bugzilla enormously simplifies Bugzilla
	    installation on UNIX systems. If someone can volunteer to
964
	    create a suitable PPM bundle for Win32, it would be appreciated.
965 966 967 968 969
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
970
	<question id="faq-nt-mappings">
971
	  <para>
972 973
	    CGI's are failing with a "something.cgi is not a valid Windows NT
	    application" error. Why?
974 975 976 977
	  </para>
	</question>
	<answer>
	  <para>
978 979 980
	    Depending on what Web server you are using, you will have to configure
	    the Web server to treat *.cgi files as CGI scripts. In IIS, you do this by
	    adding *.cgi to the App Mappings with the &lt;path&gt;\perl.exe %s %s as the
981 982 983 984 985 986
	    executable.
	  </para>
	  <para>
	    Microsoft has some advice on this matter, as well:
	    <blockquote>
	      <para>
987 988 989 990 991 992 993 994
		"Set application mappings. In the ISM, map the extension for the script
		file(s) to the executable for the script interpreter. For example, you might
		map the extension .py to Python.exe, the executable for the Python script
		interpreter. Note For the ActiveState Perl script interpreter, the extension
		.pl is associated with PerlIS.dll by default. If you want to change the
		association of .pl to perl.exe, you need to change the application mapping.
		In the mapping, you must add two percent (%) characters to the end of the
		pathname for perl.exe, as shown in this example: c:\perl\bin\perl.exe %s %s"
995 996 997 998 999 1000
	      </para>
	    </blockquote>
	  </para>
	</answer>
      </qandaentry>

1001
      <qandaentry>
1002
	<question id="faq-nt-dbi">
1003 1004 1005
	  <para>
	    I'm having trouble with the perl modules for NT not being able to talk to
	    to the database.
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033
	  </para>
	</question>
	<answer>
	  <para>
	    Your modules may be outdated or inaccurate. Try:
	    <orderedlist>
	      <listitem>
		<para>
		  Hitting http://www.activestate.com/ActivePerl
		</para>
	      </listitem>
	      <listitem>
		<para>
		  Download ActivePerl
		</para>
	      </listitem>
	      <listitem>
		<para>
		  Go to your prompt
		</para>
	      </listitem>
	      <listitem>
		<para>
		  Type 'ppm'
		</para>
	      </listitem>
	      <listitem>
		<para>
1034
		  <prompt>PPM></prompt> <command>install DBI DBD-mysql GD</command>
1035 1036
		</para>
	      </listitem>
1037 1038 1039
	    </orderedlist>
	    I reckon TimeDate and Data::Dumper come with the activeperl. You can check
	    the ActiveState site for packages for installation through PPM.
1040
	    <ulink url="http://www.activestate.com/Packages/"/>.
1041 1042 1043 1044 1045 1046
	  </para>
	</answer>
      </qandaentry>

    </qandadiv>

1047
    <qandadiv id="faq-use">
1048 1049
      <title>Bugzilla Usage</title>

1050
      <qandaentry>
1051
	<question id="faq-use-changeaddress">
1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063
	  <para>
	    How do I change my user name (email address) in Bugzilla?
	  </para>
	</question>
	<answer>
	  <para>
	    New in 2.16 - go to the Account section of the Preferences. You will
      be emailed at both addresses for confirmation.
	  </para>
	</answer>
      </qandaentry>

1064
      <qandaentry>
1065
	<question id="faq-use-query">
1066
	  <para>
1067
	    The query page is very confusing. Isn't there a simpler way to query?
1068 1069 1070 1071
	  </para>
	</question>
	<answer>
	  <para>
1072 1073 1074
	    The interface was simplified by a UI designer for 2.16. Further
      suggestions for improvement are welcome, but we won't sacrifice power for
      simplicity.
1075 1076 1077 1078 1079
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
1080
	<question id="faq-use-accept">
1081
	  <para>
1082 1083
	    I'm confused by the behavior of the "accept" button in the Show Bug form.
	    Why doesn't it assign the bug to me when I accept it?
1084 1085 1086 1087
	  </para>
	</question>
	<answer>
	  <para>
1088
	    The current behavior is acceptable to bugzilla.mozilla.org and most
1089
	    users. You have your choice of patches to change this behavior, however.
1090
	    <simplelist>
1091 1092 1093 1094 1095
	      <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8029">
		Add a "and accept bug" radio button</ulink></member>
	      <member><ulink url="http://bugzilla.mozilla.org/showattachment.cgi?attach_id=8153">
		"Accept" button automatically assigns to you</ulink></member>
	    </simplelist>
1096 1097
	    Note that these patches are somewhat dated. You will need to apply
      them manually.
1098 1099 1100 1101 1102
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
1103
	<question id="faq-use-attachment">
1104
	  <para>
1105
	    I can't upload anything into the database via the "Create Attachment"
1106
	    link. What am I doing wrong?
1107 1108 1109 1110
	  </para>
	</question>
	<answer>
	  <para>
1111
	    The most likely cause is a very old browser or a browser that is
1112
	    incompatible with file upload via POST. Download the latest Netscape,
1113
	    Microsoft, or Mozilla browser to handle uploads correctly.
1114 1115 1116 1117 1118
	  </para>
	</answer>
      </qandaentry>

      <qandaentry>
1119
	<question id="faq-use-keyword">
1120
	  <para>
1121
	    How do I change a keyword in Bugzilla, once some bugs are using it?
1122 1123 1124 1125
	  </para>
	</question>
	<answer>
	  <para>
1126
	    In the Bugzilla administrator UI, edit the keyword and it will let you
1127 1128
	    replace the old keyword name with a new one. This will cause a problem
	    with the keyword cache. Run sanitycheck.cgi to fix it.
1129 1130 1131 1132
	  </para>
	</answer>
      </qandaentry>

1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155
      <qandaentry>
    <question id="faq-use-close">
      <para>
        Why can't I close bugs from the "Change Several Bugs at Once" page?
      </para>
    </question>
    <answer>
      <para>
        The logic flow currently used is RESOLVED, then VERIFIED, then CLOSED.
        You <emphasis>can</emphasis> mass-CLOSE bugs from the change several
        bugs at once page. <emphasis>but</emphasis>, every bug listed on the
        page has to be in VERIFIED state before the control to do it will show
        up on the form. You can also mass-VERIFY, but every bug listed has to be
        RESOLVED in order for the control to show up on the form. The logic
        behind this is that if you pick one of the bugs that's not VERIFIED and
        try to CLOSE it, the bug change will fail miserably (thus killing any
        changes in the list after it while doing the bulk change) so it doesn't
        even give you the choice.
      </para>
    </answer>
      </qandaentry>


1156 1157
    </qandadiv>

1158
    <qandadiv id="faq-hacking">
1159 1160
      <title>Bugzilla Hacking</title>

1161
      <qandaentry>
1162
        <question id="faq-hacking-templatestyle">
1163 1164 1165 1166 1167 1168
	  <para>
	    What kind of style should I use for templatization?
	  </para>
	</question>
	<answer>
	  <para>
1169
	    Gerv and Myk suggest a 2-space indent, with embedded code sections on
1170
	    their own line, in line with outer tags. Like this:</para>
1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191
	    <programlisting><![CDATA[
<fred>
[% IF foo %]
  <bar>
  [% FOREACH x = barney %]
    <tr>
      <td>
        [% x %]
      </td>
    <tr>
  [% END %]
[% END %]
</fred>
]]></programlisting>

	<para> Myk also recommends you turn on PRE_CHOMP in the template
	initialization to prevent bloating of HTML with unnecessary whitespace.
	</para>

	<para>Please note that many have differing opinions on this subject,
	and the existing templates in Bugzilla espouse both this and a 4-space
1192
	style. Either is acceptable; the above is preferred.</para>
1193 1194 1195
	</answer>
      </qandaentry>

1196
      <qandaentry>
1197
	<question id="faq-hacking-bugzillabugs">
1198 1199 1200 1201 1202 1203
	  <para>
	    What bugs are in Bugzilla right now?
	  </para>
	</question>
	<answer>
	  <para>
1204
	    Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;product=Bugzilla">
1205 1206
	    this link</ulink> to view current bugs or requests for
	    enhancement for Bugzilla.
1207 1208
	  </para>
	  <para>
1209 1210 1211
	    You can view bugs marked for &bz-nextver; release
	    <ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&amp;target_milestone=Bugzilla+&bz-nextver;">here</ulink>.
	    This list includes bugs for the &bz-nextver; release that have already
1212
	    been fixed and checked into CVS. Please consult the
1213
	    <ulink url="http://www.bugzilla.org/">
1214 1215 1216
	      Bugzilla Project Page</ulink> for details on how to
	    check current sources out of CVS so you can have these
	    bug fixes early!
1217 1218 1219 1220
	  </para>
	</answer>
      </qandaentry>

1221
      <qandaentry>
1222
	<question id="faq-hacking-priority">
1223
	  <para>
1224 1225
	    How can I change the default priority to a null value?  For instance, have the default
	    priority be "---" instead of "P2"?
1226 1227 1228 1229
	  </para>
	</question>
	<answer>
	  <para>
1230 1231 1232 1233
	    This is well-documented in <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=49862">
	    bug 49862</ulink>. Ultimately, it's as easy as adding the "---" priority field to your
            localconfig file in the appropriate area, re-running checksetup.pl, and then changing the
            default priority in your browser using "editparams.cgi". 
1234 1235 1236 1237
	  </para>
	</answer>
      </qandaentry>

1238
      <qandaentry>
1239
	<question id="faq-hacking-patches">
1240
	  <para>
1241
	    What's the best way to submit patches?  What guidelines should I follow?
1242 1243 1244 1245 1246 1247 1248
	  </para>
	</question>
	<answer>
	  <blockquote>
	    <orderedlist>
	      <listitem>
		<para>
1249 1250 1251
		  Enter a bug into bugzilla.mozilla.org for the <quote><ulink
                  url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">Bugzilla</ulink></quote>
                  product.
1252 1253 1254 1255
		</para>
	      </listitem>
	      <listitem>
		<para>
1256
		  Upload your patch as a unified diff (having used "diff -u" against
1257 1258 1259 1260
		  the <emphasis>current sources</emphasis> checked out of CVS),
		  or new source file by clicking
		  "Create a new attachment" link on the bug page you've just created, and
		  include any descriptions of database changes you may make, into the bug
1261
		  ID you submitted in step #1. Be sure and click the "Patch" checkbox
1262
		  to indicate the text you are sending is a patch!
1263 1264 1265 1266 1267
		</para>
	      </listitem>
	      <listitem>
		<para>
		  Announce your patch and the associated URL
1268
		  (http://bugzilla.mozilla.org/show_bug.cgi?id=XXXXXX) for discussion in
1269
		  the newsgroup (netscape.public.mozilla.webtools). You'll get a really
1270 1271 1272
		  good, fairly immediate reaction to the implications of your patch,
		  which will also give us an idea how well-received the change would
		  be.
1273 1274 1275 1276
		</para>
	      </listitem>
	      <listitem>
		<para>
1277 1278 1279
		  If it passes muster with minimal modification, the person to whom
		  the bug is assigned in Bugzilla is responsible for seeing the patch
		  is checked into CVS.
1280 1281 1282 1283
		</para>
	      </listitem>
	      <listitem>
		<para>
1284 1285
		  Bask in the glory of the fact that you helped write the most successful
		  open-source bug-tracking software on the planet :)
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297
		</para>
	      </listitem>
	    </orderedlist>
	  </blockquote>
	</answer>
      </qandaentry>


    </qandadiv>

  </qandaset>

1298
</appendix>
1299 1300 1301 1302 1303 1304


<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
1305 1306
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
1307
sgml-exposed-tags:nil
1308 1309 1310
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
1311 1312
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
1313 1314 1315
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
1316
sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
1317 1318
sgml-shorttag:t
sgml-tag-region-if-active:t
1319 1320
End:
-->