using.xml 37.6 KB
Newer Older
1
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33

<!-- TOC
Chapter: Using Bugzilla
 Create an account
 Logging in
 Setting up preferences
  Account Settings
  Email Settings
  Page Footer
  Permissions
 Life cycle of a bug
 Creating a bug
  Checking for duplicates
  Overview of all bug fields
  Setting bug permissions
 The Query Interface
  Standard Queries
  Email Queries
  Boolean Queries
  Regexp Queries
 The Query Results
  Changing Columns
  Changing sorting order
  Mass changes 
 Miscellaneous usage hints

-->

<chapter id="using">
<title>Using Bugzilla</title>
  <epigraph>
    <para>
34
      What, Why, How, & Where?
35 36 37 38 39 40
    </para>
  </epigraph>

  <section id="whatis">
    <title>What is Bugzilla?</title>
    <para>
41 42 43 44 45 46 47 48 49 50 51 52 53
      Bugzilla is one example of a class of programs called "Defect
Tracking Systems", or, more commonly, "Bug-Tracking Systems".  Defect
Tracking Systems allow individual or groups of developers to keep
track of outstanding bugs in their product effectively. Bugzilla was
originally written by Terry Weissman in a programming language called
"TCL", to replace a crappy bug-tracking database used internally for
Netscape Communications.  Terry later ported Bugzilla to Perl from
TCL, and in Perl it remains to this day. Most commercial
defect-tracking software vendors at the time charged enormous
licensing fees, and Bugzilla quickly became a favorite of the
open-source crowd (with its genesis in the open-source browser
project, Mozilla).  It is now the de-facto standard defect-tracking
system against which all others are measured.
54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
    </para>
    <para>
      Bugzilla has matured immensely, and now boasts many advanced features.  These include:
      <itemizedlist>
	<listitem>
	  <para>
	    integrated, product-based granular security schema
	  </para>
	</listitem>
	<listitem>
	  <para>
	    inter-bug dependencies and dependency graphing
	  </para>
	</listitem>
	<listitem>
	  <para>
	    advanced reporting capabilities
	  </para>
	</listitem>
	<listitem>
	  <para>
	    a robust, stable RDBMS back-end
	  </para>
	</listitem>
	<listitem>
	  <para>
	    extensive configurability
	  </para>
	</listitem>
	<listitem>
	  <para>
	    a very well-understood and well-thought-out natural bug resolution protocol
	  </para>
	</listitem>
	<listitem>
	  <para>
90
	    email, XML, console, and HTTP APIs
91 92 93 94
	  </para>
	</listitem>
	<listitem>
	  <para>
95 96 97 98
	    available integration with automated software
	    configuration management systems, including Perforce and
	    CVS (through the Bugzilla email interface and
	    checkin/checkout scripts)
99 100 101 102 103 104 105 106 107 108
	  </para>
	</listitem>
	<listitem>
	  <para>
	    too many more features to list
	  </para>
	</listitem>
      </itemizedlist>
    </para>
    <para>
109 110 111 112 113 114 115 116 117
      Despite its current robustness and popularity, Bugzilla faces
      some near-term challenges, such as reliance on a single
      database, a lack of abstraction of the user interface and
      program logic, verbose email bug notifications, a powerful but
      daunting query interface, little reporting configurability,
      problems with extremely large queries, some unsupportable bug
      resolution options, little internationalization (although non-US
      character sets are accepted for comments), and dependence on
      some nonstandard libraries.
118
    </para>
119
    <para>
120 121 122 123 124 125
      Some recent headway has been made on the query front, however.
      If you are using the latest version of Bugzilla, you should see
      a <quote>simple search</quote> form on the default front page of
      your Bugzilla install.  Type in two or three search terms and
      you should pull up some relevant information.  This is also
      available as "queryhelp.cgi".
126
    </para>
127
    <para>
128 129 130
      Despite these small problems, Bugzilla is very hard to beat.  It
      is under <emphasis>very</emphasis> active development to address
      the current issues, and continually gains new features.
131 132 133 134 135 136 137 138 139 140 141
    </para>
  </section>
  
  <section id="why">
    <title>Why Should We Use Bugzilla?</title>
    <epigraph>
      <para>
	No, Who's on first...
      </para>
    </epigraph>
    <para>
142 143 144 145 146 147
      For many years, defect-tracking software has remained
      principally the domain of large software development houses.
      Even then, most shops never bothered with bug-tracking software,
      and instead simply relied on shared lists and email to monitor
      the status of defects.  This procedure is error-prone and tends
      to cause those bugs judged least significant by developers to be
148
      dropped or ignored.
149 150
    </para>
    <para>
151 152 153 154 155 156 157 158 159 160
      These days, many companies are finding that integrated
      defect-tracking systems reduce downtime, increase productivity,
      and raise customer  satisfaction with their systems.  Along with
      full disclosure, an open bug-tracker allows manufacturers to
      keep in touch with their clients and resellers, to communicate
      about problems effectively throughout the data management chain.
      Many corporations have also discovered that defect-tracking
      helps reduce costs by providing IT support accountability,
      telephone support knowledge bases, and a common, well-understood
      system for accounting for unusual system or software issues.
161 162 163 164 165
    </para>
    <para>
      But why should <emphasis>you</emphasis> use Bugzilla?
    </para>
    <para>
166 167 168 169 170 171 172 173 174
      Bugzilla is very adaptable to various situations.  Known uses
      currently include IT support queues, Systems Administration
      deployment management, chip design and development problem
      tracking (both pre-and-post fabrication), and software and
      hardware bug tracking for luminaries such as Redhat, Loki
      software, Linux-Mandrake, and VA Systems.  Combined with systems
      such as CVS, Bonsai, or Perforce SCM, Bugzilla provides a
      powerful, easy-to-use  solution to configuration management and
      replication problems
175 176
    </para>
    <para>
177 178 179 180 181 182 183 184 185 186
      Bugzilla can dramatically increase the productivity and
      accountability of individual employees by providing a documented
      workflow and positive feedback for good performance.  How many
      times do you wake up in the morning, remembering that you were
      supposed to do <emphasis>something</emphasis> today, but you
      just can't quite remember?  Put it in Bugzilla, and you have a
      record of it from which you can extrapolate milestones, predict
      product versions for integration, and by using Bugzilla's e-mail
      integration features be able to follow the discussion trail that
      led to critical decisions.
187 188
    </para>
    <para>
189 190 191 192
      Ultimately, Bugzilla puts the power in your hands to improve
      your value to your employer or business while providing a usable
      framework for your natural attention to detail and knowledge
      store to flourish.
193 194 195 196 197 198 199 200 201 202 203 204
    </para>
  </section>
  
  <section id="how">
    <title>How do I use Bugzilla?</title>
    <epigraph>
      <para>
	Hey!  I'm Woody!  Howdy, Howdy, Howdy!
      </para>
    </epigraph>
    
    <para>
205
      Bugzilla is a large, complex system.  Describing how to use it
206 207 208 209 210 211 212
      requires some time.  If you are only interested in installing or
      administering a Bugzilla installation, please consult the
      Installing and Administering Bugzilla portions of this Guide.
      This section is principally aimed towards developing end-user
      mastery of Bugzilla, so you may fully enjoy the benefits
      afforded by using this reliable open-source bug-tracking
      software.
213 214
    </para>
    <para>
215 216
      Throughout this portion of the Guide, we will refer to user
      account options available at the Bugzilla test installation,
217
      <ulink url="http://landfill.tequilarista.org/">
218
	landfill.tequilarista.org</ulink>.
219 220
      <note>
	<para>
221 222 223 224
	  Some people have run into difficulties completing this
	  tutorial.  If you run into problems, please check the
	  updated online documentation available at <ulink
							    url="http://www.trilobyte.net/barnsons/">http://www.trilobyte.net/barnsons</ulink>. If you're still stumped, please subscribe to the newsgroup and provide details of exactly what's stumping you!  If enough people complain, I'll have to fix it in the next version of this Guide.  You can subscribe to the newsgroup at <ulink url="news://news.mozilla.org/netscape.public.mozilla.webtools"> news://news.mozilla.org/netscape.public.mozilla.webtools</ulink>
225 226
	</para>
 
227 228 229 230 231 232 233
      </note> Although Landfill serves as a great introduction to
      Bugzilla, it does not offer all the options you would have as a
      user on your own installation of Bugzilla, nor can it do more
      than serve as a general introduction to Bugzilla.  Additionally,
      Landfill often runs cutting-edge versions of Bugzilla for
      testing, so some things may work slightly differently than
      mentioned here.
234 235 236 237 238
    </para>
    
    <section id="myaccount">
      <title>Create a Bugzilla Account</title>
      <para>
239 240 241 242 243 244
	First things first!  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 the end-user
	Bugzilla experience, use this URL: <ulink
						  url="http://landfill.tequilarista.org/bugzilla-tip/"> http://landfill.tequilarista.org/bugzilla-tip/</ulink>
245 246 247 248 249 250 251 252 253
      </para>
      <orderedlist>
	<listitem>
	  <para>
	    Click the "Open a new Bugzilla account" link.
	  </para>
	</listitem>
	<listitem>
	  <para>
254 255 256
	    Enter your "E-mail address" and "Real Name" (or whatever
	    name you want to call yourself) in the spaces provided,
	    then select the "Create Account" button.
257 258 259 260
	  </para>
	</listitem>
	<listitem>
	  <para>
261 262 263 264 265 266
	    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 should be changed at your nearest
	    opportunity (we'll go into how to do it later).
267 268 269 270
	  </para>
	</listitem>
	<listitem>
	  <para>
271 272 273 274 275
	    Click the <quote>Log In</quote> link in the yellow area at
	    the bottom of the page in your browser, then enter your
	    <quote>E-mail address</quote> and <quote>Password</quote>
	    you just received into the spaces provided, and select
	    <quote>Login</quote>.
276 277
	    <note>
	      <para>
278 279 280 281 282
		If you ever forget your password, you can come back to
		this page, enter your <quote>E-mail address</quote>,
		then select the <quote>E-mail me a password</quote>
		button to have your password mailed to you again so
		that you can login.
283 284 285 286
	      </para>
	    </note>
	    <caution>
	      <para>
287 288 289 290 291 292 293 294 295
		Many modern browsers include an
		<quote>Auto-Complete</quote> or <quote>Form
		  Fill</quote> feature to remember the user names and
		passwords you type in at many sites.  Unfortunately,
		sometimes they attempt to guess what you will put in
		as your password, and guess wrong.  If you notice a
		text box is already filled out, please overwrite the
		contents of the text box so you can be sure to input
		the correct information.
296 297 298 299 300 301
	      </para>
	    </caution>
	  </para>
	</listitem>
      </orderedlist>
      <para>
302 303 304 305 306 307
	Congratulations!  If you followed these directions, you now
	are the proud owner of a user account on
	landfill.tequilarista.org (Landfill) or your local Bugzilla
	install.  You should now see in your browser a page called the
	<quote>Bugzilla Query Page</quote>.  It may look daunting, but with this
	Guide to walk you through it, you will master it in no time.
308 309 310 311 312 313
      </para>
    </section>
    
    <section id="query">
      <title>The Bugzilla Query Page</title>
      <para>
314 315 316 317 318
	The Bugzilla Query Page is the heart and soul of the Bugzilla
	user experience.  It is the master interface where you can
	find any bug report, comment, or patch currently in the
	Bugzilla system.  We'll go into how to create your own bug
	report later on.
319 320
      </para>
      <para>
321 322 323 324 325 326 327 328
	There are efforts underway to simplify query usage.  If you
	have a local installation of Bugzilla 2.12 or higher, you
	should have <filename>quicksearch.html</filename> available to
	use and simplify your searches.  There is also a helper for
	the query interface, called
	<filename>queryhelp.cgi</filename>.  Landfill tends to run the
	latest code, so these two utilities should be available there
	for your perusal.
329 330 331 332 333 334 335
      </para>
      <para>
	At this point, please visit the main Bugzilla site,
	<ulink url="http://bugzilla.mozilla.org/query.cgi">
	bugzilla.mozilla.org</ulink>, to see a more fleshed-out query page.
      </para>
      <para>
336 337 338 339 340
	The first thing you need to notice about the Bugzilla Query
	Page is that nearly every box you see on your screen has a
	hyperlink nearby, explaining what it is or what it does.  Near
	the upper-left-hand corner of your browser window you should
	see the word <quote>Status</quote> underlined.  Select it.
341 342
      </para>
      <para>
343 344 345 346 347 348
	Notice the page that popped up?  Every underlined word you see
	on your screen is a hyperlink that will take you to
	context-sensitive help. Click around for a while, and learn
	what everything here does.  To return to the query interface
	after pulling up a help page, use the <quote>Back</quote>
	button in your browser.
349 350
      </para>
      <para>
351 352 353 354 355
	I'm sure that after checking out the online help, you are now
	an expert on the Bugzilla Query Page.  If, however, you feel
	you haven't mastered it yet, let me walk you through making a
	few successful queries to find out what there are in the
	Bugzilla bug-tracking system itself.
356 357 358 359
      </para>
      <orderedlist>
	<listitem>
	  <para>
360 361 362 363 364 365 366 367 368 369 370
	    Ensure you are back on the <quote>Bugzilla Query
	      Page</quote>. Do nothing in the boxes marked "Status",
	    "Resolution", "Platform", "OpSys", "Priority", or
	    "Severity".  The default query for "Status" is to find all
	    bugs that are NEW, ASSIGNED, or REOPENED, which is what we
	    want.  If you don't select anything in the other 5
	    scrollboxes there, then you are saying that "any of these
	    are OK"; we're not locking ourselves into only finding
	    bugs on the "DEC" Platform, or "Windows 95" OpSys
	    (Operating System).  You're smart, I think you have it
	    figured out.
371 372
	  </para>
	  <para>
373 374 375
	    Basically, selecting <emphasis>anything</emphasis> on the
	    query page narrows your search down.  Leaving stuff
	    unselected, or text boxes unfilled, broadens your search.
376 377 378 379 380
	  </para>
	</listitem>

	<listitem>
	  <para>
381 382 383 384 385 386
	    You see the box immediately below the top six boxes that
	    contains an "Email" text box,  with the words "matching
	    as", a drop-down selection box, then some checkboxes with
	    "Assigned To" checked by default?  This allows you to
	    filter your search down based upon email address.  Let's
	    put my email address in there, and see what happens.
387 388 389 390 391 392 393 394
	  </para>
	  <para>
	    Type "barnboy@trilobyte.net" in the top Email text box.
	  </para>
	</listitem>

	<listitem>
	  <para>
395 396 397 398 399 400 401
	    Let's narrow the search some more.  Scroll down until you
	    find the box with the word "Program" over the top of it.
	    This is where we can narrow our search down to only
	    specific products (software programs or product lines) in
	    our Bugzilla database. Please notice the box is a
	    <emphasis>scrollbox</emphasis>.  Using the down arrow on
	    the scrollbox, scroll down until you can see an entry
402
	    called "Bugzilla".  Select this entry.
403 404 405 406
	  </para>
	</listitem>
	<listitem>
	  <para>
407
	    Did you notice that some of the boxes to the right changed
408
	    when you selected "Bugzilla"? Every Program (or Product)
409 410 411
	    has different Versions, Components, and Target Milestones
	    associated with it.  A "Version" is the number of a
	    software program.
412 413 414 415
	    <example>
	      <title>Some Famous Software Versions</title>
	      <informalexample>
		<para>
416 417 418 419 420 421 422 423
		  Do you remember the hype in 1995 when Microsoft
		  Windows 95(r) was released? It may have been several
		  years ago, but Microsoft(tm) spent over $300 Million
		  advertising this new Version of their software.
		  Three years later, they released Microsoft Windows
		  98(r), another new version, to great fanfare, and
		  then in 2000 quietly  released Microsoft Windows
		  ME(Millenium Edition)(r). 
424 425
		</para>
		<para>
426 427 428 429 430 431 432 433 434 435 436
		  Software "Versions" help a manufacturer
		  differentiate their current product from their
		  previous products.  Most do not identify their
		  products by the year they were released. Instead,
		  the "original" version of their software will often
		  be numbered "1.0", with small bug-fix releases on
		  subsequent tenths of a digit.  In most cases, it's
		  not a decimal number; for instance, often 1.9 is an
		  <emphasis>older</emphasis> version of the software
		  than 1.11, but is a <emphasis>newer</emphasis>
		  version than 1.1.1.
437 438
		</para>
		<para>
439 440 441 442 443
		  In general, a "Version" in Bugzilla should refer to
		  <emphasis>released</emphasis> products, not products
		  that have not yet been released  to the public.
		  Forthcoming products are what the Target Milestone
		  field is for.
444 445 446 447 448 449 450 451 452 453 454
		</para>
	      </informalexample>
	    </example>
	  </para>
	  <para>
	    A "Component" is a piece of a Product.
	    It may be a standalone program, or some other logical
	    division of a Product or Program. 
	    Normally, a Component has a single Owner, who is responsible
	    for overseeing efforts to improve that Component.
	    <example>
455
	      <title>Mozilla's Bugzilla Components</title>
456 457
	      <informalexample>
		<para>
458
		  Mozilla's "Bugzilla" Product is composed of several pieces (Components):
459
		  <simplelist>
460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
                    <member><emphasis>Administration</emphasis>,
                      Administration of a bugzilla installation, including 
                      <filename>editcomponents.cgi</filename>,
                      <filename>editgroups.cgi</filename>, 
                      <filename>editkeywords.cgi</filename>, 
                      <filename>editparams.cgi</filename>,
                      <filename>editproducts.cgi</filename>,
                      <filename>editusers.cgi</filename>,
                      <filename>editversions.cgi,</filename> and
                      <filename>sanitycheck.cgi</filename>.
                    </member>
                    <member><emphasis>Bugzilla-General</emphasis>,
                      Anything that doesn't fit in the other components, or spans
                      multiple components.
                    </member>
                    <member><emphasis>Creating/Changing Bugs</emphasis>,
                      Creating, changing, and viewing bugs.
                      <filename>enter_bug.cgi</filename>,
                      <filename>post_bug.cgi</filename>,
                      <filename>show_bug.cgi</filename> and
                      <filename>process_bug.cgi</filename>.
                    </member>
                    <member><emphasis>Documentation</emphasis>,
                      The bugzilla documentation, including anything in the
                      <filename>docs/</filename> directory and The Bugzilla Guide
                      (This document :)
                    </member>
                    <member><emphasis>Email</emphasis>,
                      Anything to do with email sent by Bugzilla.
                      <filename>processmail</filename>
                    </member>
                    <member><emphasis>Installation</emphasis>,
                      The installation process of Bugzilla. This includes
                      <filename>checksetup.pl</filename> and whatever else it evolves into.
                    </member>
                    <member><emphasis>Query/Buglist</emphasis>,
                      Anything to do with searching for bugs and viewing the buglists.
                      <filename>query.cgi</filename> and
                      <filename>buglist.cgi</filename>
                    </member>
                    <member><emphasis>Reporting/Charting</emphasis>,
                      Getting reports from Bugzilla.
                      <filename>reports.cgi</filename> and
                      <filename>duplicates.cgi</filename>
                    </member>
                    <member><emphasis>User Accounts</emphasis>,
                      Anything about managing a user account from the user's perspective.
                      <filename>userprefs.cgi</filename>, saved queries, creating accounts,
                      changing passwords, logging in, etc. 
                    </member>
                    <member><emphasis>User Interface</emphasis>,
                      General issues having to do with the user interface cosmetics (not
                      functionality) including cosmetic issues, HTML templates, etc.
                    </member>
514 515 516 517 518 519
		  </simplelist>
		</para>
	      </informalexample>
	    </example>
	  </para>
	  <para>
520 521 522 523 524 525 526 527 528 529 530 531 532
	    A "Milestone", or "Target Milestone" is a often a planned
	    future "Version" of a product.  In many cases, though,
	    Milestones simply represent significant dates for a
	    developer.  Having certain features in your Product is
	    frequently tied to revenue (money) the developer will
	    receive if the features work by the time she  reaches the
	    Target Milestone. Target Milestones are a great tool to
	    organize your time. If someone will pay you $100,000 for
	    incorporating certain features by a certain date, those
	    features by that Milestone date become a very high
	    priority.  Milestones tend to be highly malleable
	    creatures, though, that appear to be in reach but are out
	    of reach by the time the important day arrives.
533 534
	  </para>
	  <para>
535 536 537 538
	    The Bugzilla Project has set up Milestones for future
	    Bugzilla versions 2.14, 2.16, 2.18, 3.0, etc.  However, a
	    Target Milestone can just as easily be a specific date,
	    code name, or weird alphanumeric combination, like "M19".
539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
	  </para>
	</listitem>

	<listitem>
	  <para>
	    OK, now let's select the "Bugzilla" component from its scrollbox.
	  </para>
	</listitem>
	<listitem>
	  <para>
	    Skip down the page a bit -- do you see the "submit query" button?
	    Select it, and let's run
	    this query!
	  </para>
	</listitem>
	<listitem>
	  <para>
556 557 558 559 560 561
	    Congratulations!  You've completed your first Query, and
	    have before you the Bug List of the author of this Guide,
	    Matthew P. Barnson (barnboy@trilobyte.net).  If I'm doing
	    well, you'll have a cryptic "Zarro Boogs Found" message on
	    your screen.  It is just a happy hacker's way of saying
	    "Zero Bugs Found".  However, I am fairly certain I will
562 563 564 565 566 567
	    always have some bugs assigned to me that aren't done yet,
	    so you won't often see that message!
	  </para>
	</listitem>
      </orderedlist>
      <para>
568 569 570 571 572 573 574
	I encourage you to click the bug numbers in the left-hand
	column and examine my bugs.  Also notice that if you click the
	underlined  links near the top of this page, they do not take
	you to context-sensitive help here, but instead sort the
	columns of bugs on the screen! When you need to sort your bugs
	by priority, severity, or the people they are assigned to,
	this is a tremendous timesaver.
575 576 577 578
      </para>
      <para>
	A couple more interesting things about the Bug List page:
	<simplelist>
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
	  <member><emphasis>Change Columns</emphasis>: by selecting
	    this link, you can show all kinds of information in the
	    Bug List</member>
	  <member><emphasis>Change several bugs at once</emphasis>: If
	    you have sufficient rights to change all the bugs shown in
	    the Bug List, you can mass-modify them. This is a big
	    time-saver.</member>
	  <member><emphasis>Send mail to bug owners</emphasis>: If you
	    have many related bugs, you can request an update from
	    every person who owns the bugs in the Bug List asking them
	    the status.</member>
	  <member><emphasis>Edit this query</emphasis>: 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.</member>
595 596 597 598
	</simplelist>
      </para>
      <note>
	<para>
599 600 601 602 603
	  There are many more options to the Bugzilla Query Page  and
	  the Bug List than I have shown you. But this should be
	  enough for you to learn to get around. I encourage you to
	  check out the <ulink
			       url="http://www.mozilla.org/bugs/">Bugzilla Home Page</ulink> to learn about the Anatomy and Life Cycle of a Bug before continuing.
604 605 606 607 608 609 610 611 612 613 614 615 616 617
	</para>
      </note>
    </section>
    
    
    <section id="bugreports">
      <title>Creating and Managing Bug Reports</title>
      <epigraph>
	<para>And all this time, I thought we were taking bugs <emphasis>out</emphasis>...</para>
      </epigraph>
      
      <section id="bug_writing">
	<title>Writing a Great Bug Report</title>
	<para>
618 619 620 621 622 623
	  Before we plunge into writing your first bug report, I
	  encourage you to read some bug-writing guidelines.  If you
	  are reading this document as part of a Bugzilla CVS checkout
	  or un-tarred Bugzilla distribution, you should be able to
	  read them by clicking <ulink
				       url="../../bugwritinghelp.html">here</ulink>.  If you are reading this online, check out the Mozilla.org bug-writing guidelines at <ulink url="http://www.mozilla.org/quality/bug-writing-guidelines.html">http://www.mozilla.org/quality/bug-writing-guidelines.html</ulink>.  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.
624 625
	</para>
	<para>
626 627 628 629
	  While you are at it, why not learn how to find previously
	  reported bugs?  Mozilla.org has published a great tutorial
	  on finding duplicate bugs, available at <ulink
							 url="http://www.mozilla.org/quality/help/beginning-duplicate-finding.html"> http://www.mozilla.org/quality/help/beginning-duplicate-finding.html</ulink>.
630 631
	</para>
	<para>
632 633 634
	  I realize this was a lot to read.  However, understanding
	  the mentality of writing great bug reports will help us on
	  the next part!
635 636 637 638
	</para>
	<orderedlist>
	  <listitem>
	    <para>
639 640
	      Go back to <ulink
				url="http://landfill.tequilarista.org/bugzilla-tip/"> http://landfill.tequilarista.org/bugzilla-tip/</ulink> in your browser.
641 642 643 644
	    </para>
	  </listitem>
	  <listitem>
	    <para>
645 646
	      Select the  <ulink
				 url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> Enter a new bug report</ulink> link.
647 648 649 650 651 652 653 654 655
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      Select a product.
	    </para>
	  </listitem>
	  <listitem>
	    <para>
656 657 658 659 660
	      Now you should be at the "Enter Bug" form. The
	      "reporter" should have been automatically filled out for
	      you (or else Bugzilla prompted you to Log In again --
	      you did keep the email with your username and password,
	      didn't you?).
661 662 663 664 665 666 667 668 669
	    </para>
	  </listitem>
	  <listitem>
	    <para>
	      Select a Component in the scrollbox.
	    </para>
	  </listitem>
	  <listitem>
	    <para>
670 671 672 673
	      Bugzilla should have made reasonable guesses, based upon
	      your browser, for the "Platform" and "OS" drop-down
	      boxes.  If those are wrong, change them -- if you're on
	      an SGI box running IRIX, we want to know!
674 675 676 677
	    </para>
	  </listitem>
	  <listitem>
	    <para>
678 679 680 681
	      Fill in the "Assigned To" box with the email address you
	      provided earlier.  This way you don't end up sending
	      copies of your bug to lots of other people, since it's
	      just a test bug.
682 683 684 685
	    </para>
	  </listitem>
	  <listitem>
	    <para>
686 687
	      Leave the "CC" text box blank.  Fill in the "URL" box
	      with "http://www.mozilla.org".
688 689 690 691
	    </para>
	  </listitem>
	  <listitem>
	    <para>
692 693 694
	      Enter "The Bugzilla Guide" in the Summary text box, and
	      place any comments you have on this tutorial, or the
	      Guide in general, into the Description box.
695 696 697 698
	    </para>
	  </listitem>
	</orderedlist>
	<para>
699 700
	  Voila!  Select "Commit" and send in your bug report! Next
	  we'll look at resolving bugs.
701 702 703 704 705 706
	</para>
      </section>

      <section id="bug_manage">
	<title>Managing your Bug Reports</title>
	<para>
707 708 709 710
	  OK, you should have a link to the bug you just created near
	  the top of your page. It should say "Bug XXXX posted", with
	  a link to the right saying "Back to BUG# XXXX". Select this
	  link.
711 712 713 714
	</para>
	<orderedlist>
	  <listitem>
	    <para>
715 716 717 718 719 720 721 722
	      Scroll down a bit on the subsequent page, until you see
	      the "Resolve bug, changing resolution to (dropdown box).
	      Normally, you would "Accept bug (change status to
	      ASSIGNED)", fix it, and then resolve. But in this case,
	      we're going to short-circuit the process because this
	      wasn't a real bug. Change the dropdown next to "Resolve
	      Bug" to "INVALID", make sure the radio button is marked
	      next to "Resolve Bug", then click "Commit".
723 724 725 726
	    </para>
	  </listitem>
	  <listitem>
	    <para>
727 728 729 730 731
	      Hey!  It said it couldn't take the change in a big red
	      box! That's right, you must specify a Comment in order
	      to make this change.  Select the "Back" button in your
	      browser, add a Comment, then try Resolving the bug with
	      INVALID status again. This time it should work.
732 733 734 735 736
	    </para>
	  </listitem>
	</orderedlist>
	<para>
	  You have now learned the basics of Bugzilla navigation,
737 738 739 740
	  entering a bug, and bug maintenance. I encourage you to
	  explore these features, and see what you can do with them!
	  We'll spend no more time on individual Bugs or Queries from
	  this point on, so you are on your own there.
741 742 743 744 745
	</para>
	<para>
	  But I'll give a few last hints!
	</para>
	<para>
746 747
	  There is a <ulink
			    url="http://bugzilla.mozilla.org/help.html">CLUE</ulink> on the Query page that will teach you more how to use the form.
748 749
	</para>
	<para>
750 751
	  If you click the hyperlink on the <ulink
						   url="http://bugzilla.mozilla.org/describecomponents.cgi">Component</ulink> box of the Query page, you will be presented a form that will describe what all the components are.
752 753
	</para>
	<para>
754 755 756
	  Possibly the most powerful feature of the Query page is the
	  <ulink
		 url="http://bugzilla.mozilla.org/booleanchart.html">Boolean Chart</ulink> section. It's a bit confusing to use the first time, but can provide unparalleled flexibility in your queries, allowing you to build extremely powerful requests.
757 758
	</para>
	<para>
759 760
	  Finally, you can build some nifty  <ulink
						    url="http://bugzilla.mozilla.org/reports.cgi">Reports</ulink> using the "Bug Reports" link near the bottom of the query page, and also available via the "Reports" link at the footer of each page.
761 762 763 764 765 766 767
	</para>
      </section>
    </section>

  </section>

  <section id="init4me">
768
    <title>Where can I find my user preferences?</title>
769 770 771 772 773 774 775 776 777
    <epigraph>
      <para>
	Indiana, it feels like we walking on fortune cookies!
      </para>
      <para>
	These ain't fortune cookies, kid...
      </para>
    </epigraph>
    <para>
778 779 780 781 782
      Customized User Preferences offer tremendous versatility to your
      individual Bugzilla experience. Let's plunge into what you can
      do!  The first step is to click the "Edit prefs" link at the
      footer of each page once you have logged in to <ulink
							    url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1"> Landfill</ulink>.
783
    </para>
784
    <section id="accountsettings" xreflabel="Account Settings">
785 786 787
      <title>Account Settings</title>
      <para>
	On this page, you can change your basic Account Settings,
788 789 790 791 792 793 794 795 796
	including your password and full name. For security reasons,
	in order to change anything on this page you must type your
	<emphasis>current</emphasis> password into the <quote>Old
	  Password</quote> field.  If you wish to change your
	password, type the new password you want into the <quote>New
	  Password</quote> field and again into the <quote>Re-enter
	  new password</quote> field to ensure you typed your new
	password correctly.  Select the <quote>Submit</quote> button
	    and you are done.
797 798
      </para>
    </section>
799
    <section id="emailsettings" >
800
      <title>Email Settings</title>
801
      <section id="notification" xreflabel="">
802 803
	<title>Email Notification</title>
	<para>
804 805 806 807 808 809 810 811 812 813 814 815 816 817
	  Here you can reduce or increase the amount of email sent you
	  from Bugzilla.  Although this is referred to as
	  <quote>Advanced Email Filtering Options</quote>, they are,
	  in fact, the standard email filter set.  All of them are
	  self-explanatory, but you can use the filters in interesting
	  ways.  For instance, some people (notably Quality Assurance
	  personnel) often only care to receive updates regarding a
	  bug when the bug changes state, so they can track bugs on
	  their flow charts and know when it is time to pull the bug
	  onto a quality assurance platform for inspection.  Other
	  people set up email gateways to
	    <xref linkend="bonsai"> or <xref linkend="tinderbox">, and
	  restrict which types of Bugzilla information are fed to
	  these systems..
818 819 820 821 822 823
	</para>
      </section>
      <section id="newemailtech">
	<title>New Email Technology</title>
	<note>
	  <para>
824 825 826 827 828 829 830
	    This option may not be available in all Bugzilla
	    installations, depending upon the preferences of the
	    systems administrator responsible for the setup of your
	    Bugzilla. However, if you really want this functionality,
	    ask her to "enable newemailtech in Params" and "make it
	    the default for all new users", referring her to the
	    Administration section of this Guide.
831 832 833
	  </para>
	</note>
	<para>
834 835 836 837
	  Disregard the warnings about "experimental and bleeding
	  edge"; the code to handle email in a cleaner manner than
	  that historically used for Bugzilla is quite robust and
	  well-tested now.
838 839
	</para>
	<para>
840 841 842 843 844
	  I recommend you enable the option, "Click here to sign up
	  (and risk any bugs)". Your email-box will thank you for it.
	  The fundamental shift in "newemailtech" is away from
	  standard UNIX "diff" output, which is quite ugly, to a
	  prettier, better laid-out email.
845 846 847 848 849 850
	</para>
      </section>
      <section id="watchsettings">
	<title>"Watching" Users</title>
	<note>
	  <para>
851 852 853 854 855
	    This option may not be available in all Bugzilla
	    installations, depending upon the preferences of the
	    systems administrator responsible for the setup of your
	    Bugzilla. However, if you really want this functionality,
	    ask her to "enable watchers in Params".
856 857 858
	  </para>
	</note>
	<para>
859 860 861 862 863 864 865 866
	  By entering user email names into the "Users to watch" text
	  entry box, delineated by commas, you can watch bugs of other
	  users.  This powerful functionality enables seamless
	  transitions as developers change projects, managers wish to
	  get in touch with the issues faced by their direct reports,
	  or users go on vacation.  If any of these three situations
	  apply to you, you will undoubtedly find this feature quite
	  convenient.
867 868 869 870 871 872 873
	</para>
      </section>
    </section>
    <section id="footersettings">
      <title>Page Footer</title>
      <note>
	<para>
874 875 876 877 878 879
	  By default, this page is quite barren.  However, go explore
	  the Query Page some more; you will find that you can store
	  numerous queries on the server, so if you regularly run a
	  particular query it is just a drop-down menu away.  On this
	  page of Preferences, if you have many stored queries you can
	  elect to have them always one-click away!
880 881 882
	</para>
      </note>
      <para>
883 884 885 886 887 888
	If you have many stored queries on the server, here you will
	find individual drop-downs for each stored query.  Each
	drop-down gives you the option of that query appearing on the
	footer of every page in Bugzilla!  This gives you powerful
	one-click access to any complex searches you may set up, and
	is an excellent way to impress your boss...
889 890
      </para>
      <tip>
891 892 893 894 895 896 897 898 899 900 901 902
	<para>By default, the "My Bugs" link appears at the bottom of
	  each page.  However, this query gives you both the bugs you
	  have reported, as well as those you are assigned.  One of
	  the most common uses for this page is to remove the "My
	  Bugs" link, replacing it with two other queries, commonly
	  called "My Bug Reports" and "My Bugs" (but only referencing
	  bugs assigned to you).  This allows you to distinguish those
	  bugs you have reported from those you are assigned.  I
	  commonly set up complex Boolean queries in the Query page
	  and link them to my footer in this page.  When they are
	  significantly complex, a one-click reference can save hours
	  of work.</para>
903 904 905 906 907
      </tip>
    </section>
    <section id="permissionsettings">
      <title>Permissions</title>
      <para>
908 909 910 911 912 913
	This is a purely informative page which outlines your current
	permissions on this installation of Bugzilla.  If you have
	permissions to grant certain permissions to other users, the
	"other users" link appears on this page as well as the footer.
	For more information regarding user administration, please
	consult the Administration section of this Guide.
914 915 916 917 918 919 920
      </para>
    </section>
  </section>

  <section id="usingbz-conc">
    <title>Using Bugzilla-Conclusion</title>
    <para>
921 922 923 924 925
      Thank you for reading through this portion of the Bugzilla
      Guide.  I anticipate it may not yet meet the needs of all
      readers.  If you have additional comments or corrections to
      make, please submit your contributions to the <ulink
							   url="mailto://mozilla-webtools@mozilla.org">mozilla-webtools</ulink> mailing list/newsgroup.  The mailing list is mirrored to the netscape.public.mozilla.webtools newsgroup, and the newsgroup is mirrored to mozilla-webtools@mozilla.org
926 927 928 929 930 931 932 933 934
    </para>
  </section>
</chapter>


<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-always-quote-attributes:t
935 936
sgml-auto-insert-required-elements:t
sgml-balanced-tag-edit:t
937
sgml-exposed-tags:nil
938 939 940
sgml-general-insert-case:lower
sgml-indent-data:t
sgml-indent-step:2
941 942
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
943 944 945 946 947 948
sgml-minimize-attributes:nil
sgml-namecase-general:t
sgml-omittag:t
sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
949 950
End:
-->