diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/xml/administration.xml | 2527 | ||||
| -rw-r--r-- | docs/en/xml/conventions.xml | 124 | ||||
| -rw-r--r-- | docs/en/xml/gfdl.xml | 79 | ||||
| -rw-r--r-- | docs/en/xml/glossary.xml | 301 | ||||
| -rw-r--r-- | docs/en/xml/index.xml | 2 | ||||
| -rw-r--r-- | docs/en/xml/integration.xml | 63 | ||||
| -rw-r--r-- | docs/en/xml/patches.xml | 286 | ||||
| -rw-r--r-- | docs/en/xml/requiredsoftware.xml | 33 | ||||
| -rw-r--r-- | docs/en/xml/using.xml | 1169 |
9 files changed, 2324 insertions, 2260 deletions
diff --git a/docs/en/xml/administration.xml b/docs/en/xml/administration.xml index 6789ca071..cf52999e4 100644 --- a/docs/en/xml/administration.xml +++ b/docs/en/xml/administration.xml @@ -1,306 +1,361 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> - <chapter id="administration"> <title>Administering Bugzilla</title> - <subtitle> - Or, I just got this cool thing installed. Now what the heck do I - do with it? - </subtitle> - - <para> - So you followed <quote><xref linkend="installation" /></quote> to the - letter, and logged into Bugzilla for the very first time with your - super-duper god account. You sit, contentedly staring at the - Bugzilla Query Screen, the worst of the whole mad business of - installing this terrific program behind you. It seems, though, you - have nothing yet to query! Your first act of business should be to - setup the operating parameters for Bugzilla so you can get busy - getting data into your bug tracker. - </para> + + <subtitle>Or, I just got this cool thing installed. Now what the heck do I + do with it?</subtitle> + + <para>So you followed + <quote> + <xref linkend="installation" /> + </quote> + + to the letter, and logged into Bugzilla for the very first time with your + super-duper god account. You sit, contentedly staring at the Bugzilla Query + Screen, the worst of the whole mad business of installing this terrific + program behind you. It seems, though, you have nothing yet to query! Your + first act of business should be to setup the operating parameters for + Bugzilla so you can get busy getting data into your bug tracker.</para> <section id="postinstall-check"> <title>Post-Installation Checklist</title> - <para> - After installation, follow the checklist below to help ensure - that you have a successful installation. If you do not see a - recommended setting for a parameter, consider leaving it at the - default while you perform your initial tests on your Bugzilla - setup. - </para> - <indexterm> - <primary>checklist</primary> - </indexterm> + + <para>After installation, follow the checklist below to help ensure that + you have a successful installation. If you do not see a recommended + setting for a parameter, consider leaving it at the default while you + perform your initial tests on your Bugzilla setup.</para> + + <indexterm> + <primary>checklist</primary> + </indexterm> + <procedure> <step> - <para> - Bring up <filename>editparams.cgi</filename> in your web - browser. This should be available as the <quote>edit - parameters</quote> link from any Bugzilla screen once you - have logged in. - </para> + <para>Bring up + <filename>editparams.cgi</filename> + + in your web browser. This should be available as the + <quote>edit parameters</quote> + + link from any Bugzilla screen once you have logged in.</para> </step> + <step> - <para>The <quote>maintainer</quote> is the email address of - the person responsible for maintaining this Bugzilla - installation. The maintainer need not be a valid Bugzilla - user. Error pages, error emails, and administrative mail - will be sent with the maintainer as the return email - address.</para> - <para> - Set <quote>maintainer</quote> to <emphasis>your</emphasis> email address. - This allows Bugzilla's error messages to display your email - address and allow people to contact you for help. - </para> + <para>The + <quote>maintainer</quote> + + is the email address of the person responsible for maintaining this + Bugzilla installation. The maintainer need not be a valid Bugzilla + user. Error pages, error emails, and administrative mail will be sent + with the maintainer as the return email address.</para> + + <para>Set + <quote>maintainer</quote> + + to + <emphasis>your</emphasis> + + email address. This allows Bugzilla's error messages to display your + email address and allow people to contact you for help.</para> </step> + <step> - <para>The <quote>urlbase</quote> parameter defines the fully - qualified domain name and web server path to your Bugzilla - installation.</para> - <para> - For example, if your bugzilla query page is - http://www.foo.com/bugzilla/query.cgi, set your - <quote>urlbase</quote> is http://www.foo.com/bugzilla/. - </para> + <para>The + <quote>urlbase</quote> + + parameter defines the fully qualified domain name and web server path + to your Bugzilla installation.</para> + + <para>For example, if your bugzilla query page is + http://www.foo.com/bugzilla/query.cgi, set your + <quote>urlbase</quote> + + is http://www.foo.com/bugzilla/.</para> </step> + <step> - <para><quote>usebuggroups</quote> dictates whether or not to - implement group-based security for Bugzilla. If set, - Bugzilla bugs can have an associated groupmask defining - which groups of users are allowed to see and edit the - bug.</para> - <para> - Set "usebuggroups" to "on" <emphasis>only</emphasis> if you - may wish to restrict access to products. I suggest leaving - this parameter <emphasis>off</emphasis> while initially - testing your Bugzilla. - </para> + <para> + <quote>usebuggroups</quote> + + dictates whether or not to implement group-based security for + Bugzilla. If set, Bugzilla bugs can have an associated groupmask + defining which groups of users are allowed to see and edit the + bug.</para> + + <para>Set "usebuggroups" to "on" + <emphasis>only</emphasis> + + if you may wish to restrict access to products. I suggest leaving + this parameter + <emphasis>off</emphasis> + + while initially testing your Bugzilla.</para> </step> + <step> - <para> - <quote>usebuggroupsentry</quote>, when set to - <quote>on</quote>, requires that all bugs have an associated - groupmask when submitted. This parameter is made for those - installations where product isolation is a necessity. - </para> - <para> - Set "usebuggroupsentry" to "on" if you absolutely need to - restrict access to bugs from the moment they are submitted - through resolution. Once again, if you are simply testing - your installation, I suggest against turning this parameter - on; the strict security checking may stop you from being - able to modify your new entries. - </para> + <para> + <quote>usebuggroupsentry</quote> + + , when set to + <quote>on</quote> + + , requires that all bugs have an associated groupmask when submitted. + This parameter is made for those installations where product + isolation is a necessity.</para> + + <para>Set "usebuggroupsentry" to "on" if you absolutely need to + restrict access to bugs from the moment they are submitted through + resolution. Once again, if you are simply testing your installation, + I suggest against turning this parameter on; the strict security + checking may stop you from being able to modify your new + entries.</para> </step> + <step> - <para> - You run into an interesting problem when Bugzilla reaches a - high level of continuous activity. MySQL supports only - table-level write locking. What this means is that if - someone needs to make a change to a bug, they will lock the - entire table until the operation is complete. Locking for - write also blocks reads until the write is complete. The - <quote>shadowdb</quote> parameter was designed to get around - this limitation. While only a single user is allowed to - write to a table at a time, reads can continue unimpeded on - a read-only shadow copy of the database. Although your - database size will double, a shadow database can cause an - enormous performance improvement when implemented on - extremely high-traffic Bugzilla databases. - </para> - <para> - Set "shadowdb" to "bug_shadowdb" if you will be running a - *very* large installation of Bugzilla. The shadow database - enables many simultaneous users to read and write to the - database without interfering with one another. - <note> - <para> - Enabling "shadowdb" can adversely affect the stability - of your installation of Bugzilla. You should regularly - check that your database is in sync. It is often - advisable to force a shadow database sync nightly via - <quote>cron</quote>. - </para> - </note> Once again, in testing you should avoid this option - -- use it if or when you <emphasis>need</emphasis> to use - it, and have repeatedly run into the problem it was designed - to solve -- very long wait times while attempting to commit - a change to the database. Mozilla.org began needing - <quote>shadowdb</quote> when they reached around 40,000 - Bugzilla users with several hundred Bugzilla bug changes and - comments per day. - </para> - <para> - If you use the "shadowdb" option, it is only natural that - you should turn the "queryagainstshadowdb" option "On" as - well. Otherwise you are replicating data into a shadow - database for no reason! - </para> + <para>You run into an interesting problem when Bugzilla reaches a + high level of continuous activity. MySQL supports only table-level + write locking. What this means is that if someone needs to make a + change to a bug, they will lock the entire table until the operation + is complete. Locking for write also blocks reads until the write is + complete. The + <quote>shadowdb</quote> + + parameter was designed to get around this limitation. While only a + single user is allowed to write to a table at a time, reads can + continue unimpeded on a read-only shadow copy of the database. + Although your database size will double, a shadow database can cause + an enormous performance improvement when implemented on extremely + high-traffic Bugzilla databases.</para> + + <para>Set "shadowdb" to "bug_shadowdb" if you will be running a + *very* large installation of Bugzilla. The shadow database enables + many simultaneous users to read and write to the database without + interfering with one another. + <note> + <para>Enabling "shadowdb" can adversely affect the stability of + your installation of Bugzilla. You should regularly check that your + database is in sync. It is often advisable to force a shadow + database sync nightly via + <quote>cron</quote> + + .</para> + </note> + + Once again, in testing you should avoid this option -- use it if or + when you + <emphasis>need</emphasis> + + to use it, and have repeatedly run into the problem it was designed + to solve -- very long wait times while attempting to commit a change + to the database. Mozilla.org began needing + <quote>shadowdb</quote> + + when they reached around 40,000 Bugzilla users with several hundred + Bugzilla bug changes and comments per day.</para> + + <para>If you use the "shadowdb" option, it is only natural that you + should turn the "queryagainstshadowdb" option "On" as well. Otherwise + you are replicating data into a shadow database for no reason!</para> </step> + <step> - <para><quote>headerhtml</quote>, <quote>footerhtml</quote>, - <quote>errorhtml</quote>, <quote>bannerhtml</quote>, and - <quote>blurbhtml</quote> are all templates which control - display of headers, footers, errors, banners, and additional - data. We could go into some detail regarding the usage of - these, but it is really best just to monkey around with them - a bit to see what they do. I strongly recommend you copy - your <filename>data/params</filename> file somewhere safe - before playing with these values, though. If they are - changed dramatically, it may make it impossible for you to - display Bugzilla pages to fix the problem until you have - restored your <filename>data/params</filename> file.</para> <para> - If you have custom logos or HTML you must put in place to - fit within your site design guidelines, place the code in - the "headerhtml", "footerhtml", "errorhtml", "bannerhtml", - or "blurbhtml" text boxes. - <note> - <para> - The "headerhtml" text box is the HTML printed out - <emphasis>before</emphasis> any other code on the page, - except the CONTENT-TYPE header sent by the Bugzilla - engine. If you have a special banner, put the code for - it in "bannerhtml". You may want to leave these settings - at the defaults initially. - </para> - </note> - </para> + <quote>headerhtml</quote> + + , + <quote>footerhtml</quote> + + , + <quote>errorhtml</quote> + + , + <quote>bannerhtml</quote> + + , and + <quote>blurbhtml</quote> + + are all templates which control display of headers, footers, errors, + banners, and additional data. We could go into some detail regarding + the usage of these, but it is really best just to monkey around with + them a bit to see what they do. I strongly recommend you copy your + <filename>data/params</filename> + + file somewhere safe before playing with these values, though. If they + are changed dramatically, it may make it impossible for you to + display Bugzilla pages to fix the problem until you have restored + your + <filename>data/params</filename> + + file.</para> + + <para>If you have custom logos or HTML you must put in place to fit + within your site design guidelines, place the code in the + "headerhtml", "footerhtml", "errorhtml", "bannerhtml", or "blurbhtml" + text boxes. + <note> + <para>The "headerhtml" text box is the HTML printed out + <emphasis>before</emphasis> + + any other code on the page, except the CONTENT-TYPE header sent by + the Bugzilla engine. If you have a special banner, put the code for + it in "bannerhtml". You may want to leave these settings at the + defaults initially.</para> + </note> + </para> </step> + <step> - <para><quote>passwordmail</quote> is rather simple. Every - time a user creates an account, the text of this parameter - is read as the text to send to the new user along with their - password message.</para> <para> - Add any text you wish to the "passwordmail" parameter box. - For instance, many people choose to use this box to give a - quick training blurb about how to use Bugzilla at your site. - </para> + <quote>passwordmail</quote> + + is rather simple. Every time a user creates an account, the text of + this parameter is read as the text to send to the new user along with + their password message.</para> + + <para>Add any text you wish to the "passwordmail" parameter box. For + instance, many people choose to use this box to give a quick training + blurb about how to use Bugzilla at your site.</para> </step> + <step> - <para><quote>useqacontact</quote> allows you to define an - email address for each component, in addition to that of the - default owner, who will be sent carbon copies of incoming - bugs. The critical difference between a QA Contact and an - Owner is that the QA Contact follows the component. If you - reassign a bug from component A to component B, the QA - Contact for that bug will change with the reassignment, - regardless of owner.</para> - <para><quote>usestatuswhiteboard</quote> defines whether you - wish to have a free-form, overwritable field associated with - each bug. The advantage of the Status Whiteboard is that it - can be deleted or modified with ease, and provides an - easily-searchable field for indexing some bugs that have - some trait in common. Many people will put <quote>help - wanted</quote>, <quote>stalled</quote>, or <quote>waiting - on reply from somebody</quote> messages into the Status - Whiteboard field so those who peruse the bugs are aware of - their status even more than that which can be indicated by - the Resolution fields.</para> - <para> - Do you want to use the QA Contact ("useqacontact") and - status whiteboard ("usestatuswhiteboard") fields? These - fields are useful because they allow for more flexibility, - particularly when you have an existing Quality Assurance - and/or Release Engineering team, but they may not be needed - for many smaller installations. - </para> + <para> + <quote>useqacontact</quote> + + allows you to define an email address for each component, in addition + to that of the default owner, who will be sent carbon copies of + incoming bugs. The critical difference between a QA Contact and an + Owner is that the QA Contact follows the component. If you reassign a + bug from component A to component B, the QA Contact for that bug will + change with the reassignment, regardless of owner.</para> + + <para> + <quote>usestatuswhiteboard</quote> + + defines whether you wish to have a free-form, overwritable field + associated with each bug. The advantage of the Status Whiteboard is + that it can be deleted or modified with ease, and provides an + easily-searchable field for indexing some bugs that have some trait + in common. Many people will put + <quote>help wanted</quote> + + , + <quote>stalled</quote> + + , or + <quote>waiting on reply from somebody</quote> + + messages into the Status Whiteboard field so those who peruse the + bugs are aware of their status even more than that which can be + indicated by the Resolution fields.</para> + + <para>Do you want to use the QA Contact ("useqacontact") and status + whiteboard ("usestatuswhiteboard") fields? These fields are useful + because they allow for more flexibility, particularly when you have + an existing Quality Assurance and/or Release Engineering team, but + they may not be needed for many smaller installations.</para> </step> + <step> - <para> - Set "whinedays" to the amount of days you want to let bugs - go in the "New" or "Reopened" state before notifying people - they have untouched new bugs. If you do not plan to use - this feature, simply do not set up the whining cron job - described in the installation instructions, or set this - value to "0" (never whine). - </para> + <para>Set "whinedays" to the amount of days you want to let bugs go + in the "New" or "Reopened" state before notifying people they have + untouched new bugs. If you do not plan to use this feature, simply do + not set up the whining cron job described in the installation + instructions, or set this value to "0" (never whine).</para> </step> + <step> - <para><quote>commenton</quote> fields allow you to dictate - what changes can pass without comment, and which must have a - comment from the person who changed them. Often, - administrators will allow users to add themselves to the CC - list, accept bugs, or change the Status Whiteboard without - adding a comment as to their reasons for the change, yet - require that most other changes come with an - explanation.</para> - <para> - Set the "commenton" options according to your site policy. - It is a wise idea to require comments when users resolve, - reassign, or reopen bugs at the very least. - <note> - <para> - It is generally far better to require a developer - comment when resolving bugs than not. Few things are - more annoying to bug database users than having a - developer mark a bug "fixed" without any comment as to - what the fix was (or even that it was truly fixed!) - </para> - </note> - </para> + <para> + <quote>commenton</quote> + + fields allow you to dictate what changes can pass without comment, + and which must have a comment from the person who changed them. + Often, administrators will allow users to add themselves to the CC + list, accept bugs, or change the Status Whiteboard without adding a + comment as to their reasons for the change, yet require that most + other changes come with an explanation.</para> + + <para>Set the "commenton" options according to your site policy. It + is a wise idea to require comments when users resolve, reassign, or + reopen bugs at the very least. + <note> + <para>It is generally far better to require a developer comment + when resolving bugs than not. Few things are more annoying to bug + database users than having a developer mark a bug "fixed" without + any comment as to what the fix was (or even that it was truly + fixed!)</para> + </note> + </para> </step> + <step> - <para>The <quote>supportwatchers</quote> option can be an - exceptionally powerful tool in the hands of a power Bugzilla - user. By enabling this option, you allow users to receive - email updates whenever other users receive email updates. - This is, of course, subject to the groupset restrictions on - the bug; if the <quote>watcher</quote> would not normally be - allowed to view a bug, the watcher cannot get around the - system by setting herself up to watch the bugs of someone - with bugs outside her privileges. She would still only - receive email updates for those bugs she could normally - view.</para> - <para>For Bugzilla sites which require strong inter-Product - security to prevent snooping, watchers are not a good - idea.</para> - <para> - However, for most sites you should set - <quote>supportwatchers</quote> to "On". This feature is - helpful for team leads to monitor progress in their - respective areas, and can offer many other benefits, such as - allowing a developer to pick up a former engineer's bugs - without requiring her to change all the information in the - bug. - </para> + <para>The + <quote>supportwatchers</quote> + + option can be an exceptionally powerful tool in the hands of a power + Bugzilla user. By enabling this option, you allow users to receive + email updates whenever other users receive email updates. This is, of + course, subject to the groupset restrictions on the bug; if the + <quote>watcher</quote> + + would not normally be allowed to view a bug, the watcher cannot get + around the system by setting herself up to watch the bugs of someone + with bugs outside her privileges. She would still only receive email + updates for those bugs she could normally view.</para> + + <para>For Bugzilla sites which require strong inter-Product security + to prevent snooping, watchers are not a good idea.</para> + + <para>However, for most sites you should set + <quote>supportwatchers</quote> + + to "On". This feature is helpful for team leads to monitor progress + in their respective areas, and can offer many other benefits, such as + allowing a developer to pick up a former engineer's bugs without + requiring her to change all the information in the bug.</para> </step> </procedure> </section> <section id="useradmin"> <title>User Administration</title> - <para> - User administration is one of the easiest parts of Bugzilla. - Keeping it from getting out of hand, however, can become a - challenge. - </para> + + <para>User administration is one of the easiest parts of Bugzilla. + Keeping it from getting out of hand, however, can become a + challenge.</para> <section id="defaultuser"> <title>Creating the Default User</title> - <para> - When you first run checksetup.pl after installing Bugzilla, it - will prompt you for the administrative username (email - address) and password for this "super user". If for some - reason you were to delete the "super user" account, re-running - checksetup.pl will again prompt you for this username and - password. - </para> + <para>When you first run checksetup.pl after installing Bugzilla, it + will prompt you for the administrative username (email address) and + password for this "super user". If for some reason you were to delete + the "super user" account, re-running checksetup.pl will again prompt + you for this username and password.</para> + <tip> - <para> - If you wish to add more administrative users, you must use the - MySQL interface. Run "mysql" from the command line, and use - these commands ("mysql>" denotes the mysql prompt, not - something you should type in): - <command><prompt>mysql></prompt> use bugs;</command> - <command><prompt>mysql></prompt> update profiles set - groupset=0x7ffffffffffffff where login_name = "(user's - login name)"; </command> - </para> - <para>Yes, that is <emphasis>fourteen</emphasis> - <quote>f</quote>'s. A whole lot of f-ing going on if you - want to create a new administator.</para> + <para>If you wish to add more administrative users, you must use the + MySQL interface. Run "mysql" from the command line, and use these + commands ("mysql>" denotes the mysql prompt, not something you + should type in): + <command> + <prompt>mysql></prompt> + + use bugs;</command> + + <command> + <prompt>mysql></prompt> + + update profiles set groupset=0x7ffffffffffffff where login_name = + "(user's login name)";</command> + </para> + + <para>Yes, that is + <emphasis>fourteen</emphasis> + + <quote>f</quote> + + 's. A whole lot of f-ing going on if you want to create a new + administator.</para> </tip> </section> @@ -308,1111 +363,1008 @@ <title>Managing Other Users</title> <section id="login"> - <title>Logging In</title> - <orderedlist> - <listitem> - <para> - Open the index.html page for your Bugzilla installation - in your browser window. - </para> - </listitem> - <listitem> - <para> - Click the "Query Existing Bug Reports" link. - </para> - </listitem> - <listitem> - <para> - Click the "Log In" link at the foot of the page. - </para> - </listitem> - <listitem> - <para> - Type your email address, and the password which was - emailed to you when you created your Bugzilla account, - into the spaces provided. - </para> - </listitem> - </orderedlist> - <para>Congratulations, you are logged in!</para> + <title>Logging In</title> + + <orderedlist> + <listitem> + <para>Open the index.html page for your Bugzilla installation in + your browser window.</para> + </listitem> + + <listitem> + <para>Click the "Query Existing Bug Reports" link.</para> + </listitem> + + <listitem> + <para>Click the "Log In" link at the foot of the page.</para> + </listitem> + + <listitem> + <para>Type your email address, and the password which was emailed + to you when you created your Bugzilla account, into the spaces + provided.</para> + </listitem> + </orderedlist> + + <para>Congratulations, you are logged in!</para> </section> <section id="createnewusers"> - <title>Creating new users</title> - <para> - Your users can create their own user accounts by clicking - the "New Account" link at the bottom of each page. However, - should you desire to create user accounts ahead of time, - here is how you do it. - </para> - <orderedlist> - <listitem> - <para> - After logging in, click the "Users" link at the footer - of the query page. - </para> - </listitem> - <listitem> - <para> - To see a specific user, type a portion of their login - name in the box provided and click "submit". To see all - users, simply click the "submit" button. You must click - "submit" here to be able to add a new user. - </para> - <tip> - <para> - More functionality is available via the list on the - right-hand side of the text entry box. You can match - what you type as a case-insensitive substring (the - default) of all users on your system, a case-sensitive - regular expression (please see the <command>man - regexp</command> manual page for details on regular - expression syntax), or a <emphasis>reverse</emphasis> - regular expression match, where every user name which - does NOT match the regular expression is selected. - </para> - </tip> - </listitem> - <listitem> - <para> - Click the "Add New User" link at the bottom of the user - list - </para> - </listitem> - <listitem> - <para> - Fill out the form presented. This page is - self-explanatory. When done, click "submit". - </para> - <note> - <para> - Adding a user this way will <emphasis>not</emphasis> - send an email informing them of their username and - password. While useful for creating dummy accounts - (watchers which shuttle mail to another system, for - instance, or email addresses which are a mailing - list), in general it is preferable to log out and use - the <quote>New Account</quote> button to create users, - as it will pre-populate all the required fields and - also notify the user of her account name and - password. - </para> - </note> - </listitem> - </orderedlist> + <title>Creating new users</title> + + <para>Your users can create their own user accounts by clicking the + "New Account" link at the bottom of each page. However, should you + desire to create user accounts ahead of time, here is how you do + it.</para> + + <orderedlist> + <listitem> + <para>After logging in, click the "Users" link at the footer of + the query page.</para> + </listitem> + + <listitem> + <para>To see a specific user, type a portion of their login name + in the box provided and click "submit". To see all users, simply + click the "submit" button. You must click "submit" here to be + able to add a new user.</para> + + <tip> + <para>More functionality is available via the list on the + right-hand side of the text entry box. You can match what you + type as a case-insensitive substring (the default) of all users + on your system, a case-sensitive regular expression (please see + the + <command>man regexp</command> + + manual page for details on regular expression syntax), or a + <emphasis>reverse</emphasis> + + regular expression match, where every user name which does NOT + match the regular expression is selected.</para> + </tip> + </listitem> + + <listitem> + <para>Click the "Add New User" link at the bottom of the user + list</para> + </listitem> + + <listitem> + <para>Fill out the form presented. This page is self-explanatory. + When done, click "submit".</para> + + <note> + <para>Adding a user this way will + <emphasis>not</emphasis> + + send an email informing them of their username and password. + While useful for creating dummy accounts (watchers which + shuttle mail to another system, for instance, or email + addresses which are a mailing list), in general it is + preferable to log out and use the + <quote>New Account</quote> + + button to create users, as it will pre-populate all the + required fields and also notify the user of her account name + and password.</para> + </note> + </listitem> + </orderedlist> </section> <section id="disableusers"> - <title>Disabling Users</title> - <para> - I bet you noticed that big "Disabled Text" entry box - available from the "Add New User" screen, when you edit an - account? By entering any text in this box and selecting - "submit", you have prevented the user from using Bugzilla - via the web interface. Your explanation, written in this - text box, will be presented to the user the next time she - attempts to use the system. - <warning> - <para> - Don't disable your own administrative account, or you - will hate life! - </para> - <para>At this time, <quote>Disabled Text</quote> does not - prevent a user from using the email interface. If you - have the email interface enabled, they can still - continue to submit bugs and comments that way. We need - a patch to fix this.</para> - </warning> - </para> + <title>Disabling Users</title> + + <para>I bet you noticed that big "Disabled Text" entry box available + from the "Add New User" screen, when you edit an account? By entering + any text in this box and selecting "submit", you have prevented the + user from using Bugzilla via the web interface. Your explanation, + written in this text box, will be presented to the user the next time + she attempts to use the system. + <warning> + <para>Don't disable your own administrative account, or you will + hate life!</para> + + <para>At this time, + <quote>Disabled Text</quote> + + does not prevent a user from using the email interface. If you have + the email interface enabled, they can still continue to submit bugs + and comments that way. We need a patch to fix this.</para> + </warning> + </para> </section> <section id="modifyusers"> - <title>Modifying Users</title> - <para> - Here I will attempt to describe the function of each option - on the Edit User screen. - </para> - <itemizedlist> - <listitem> - <para> - <emphasis>Login Name</emphasis>: This is generally the - user's email address. However, if you have edited your - system parameters, this may just be the user's login - name or some other identifier. - <tip> - <para> - For compatability reasons, you should probably stick - with email addresses as user login names. It will - make your life easier. - </para> - </tip> - </para> - </listitem> - <listitem> - <para> - <emphasis>Real Name</emphasis>: Duh! - </para> - </listitem> - <listitem> - <para> - <emphasis>Password</emphasis>: You can change the user - password here. It is normal to only see asterisks. - </para> - </listitem> - <listitem> - <para> - <emphasis>Disable Text</emphasis>: If you type anything - in this box, including just a space, the user account is - disabled from making any changes to bugs via the web - interface, and what you type in this box is presented as - the reason. - <warning> - <para>Don't disable the administrator account!</para> - </warning> - <note> - <para> - As of this writing, the user can still submit bugs - via the e-mail gateway, if you set it up, despite - the disabled text field. The e-mail gateway should - <emphasis>not</emphasis> be enabled for secure - installations of Bugzilla. - </para> - </note> - </para> - </listitem> - <listitem> - <para> - <emphasis>CanConfirm</emphasis>: This field is only used - if you have enabled "unconfirmed" status in your - parameters screen. If you enable this for a user, that - user can then move bugs from "Unconfirmed" to - "Confirmed" status (e.g.: "New" status). Be judicious - about allowing users to turn this bit on for other - users. - </para> - </listitem> - <listitem> - <para> - <emphasis>Creategroups</emphasis>: This option will - allow a user to create and destroy groups in Bugzilla. - Unless you are using the Bugzilla GroupSentry security - option "usebuggroupsentry" in your parameters, this - setting has no effect. - </para> - </listitem> - <listitem> - <para> - <emphasis>Editbugs</emphasis>: Unless a user has this - bit set, they can only edit those bugs for which they - are the assignee or the reporter. - <note> - <para> - Leaving this option unchecked does not prevent users - from adding comments to a bug! They simply cannot - change a bug priority, severity, etc. unless they - are the assignee or reporter. - </para> - </note> - </para> - </listitem> - <listitem> - <para> - <emphasis>Editcomponents</emphasis>: This flag allows a - user to create new products and components, as well as - modify and destroy those that have no bugs associated - with them. If a product or component has bugs - associated with it, those bugs must be moved to a - different product or component before Bugzilla will - allow them to be destroyed. The name of a product or - component can be changed without affecting the - associated bugs, but it tends to annoy the hell out of - your users when these change a lot. - </para> - </listitem> - <listitem> - <para> - <emphasis>Editkeywords</emphasis>: If you use Bugzilla's - keyword functionality, enabling this feature allows a - user can create and destroy keywords. As always, the - keywords for existing bugs containing the keyword the - user wishes to destroy must be changed before Bugzilla - will allow it to die. You must be very careful about - creating too many new keywords if you run a very large - Bugzilla installation; keywords are global variables - across products, and you can often run into a phenomenon - called "keyword bloat". This confuses users, and then - the feature goes unused. - </para> - </listitem> - <listitem> - <para> - <emphasis>Editusers</emphasis>: This flag allows a user - do what you're doing right now: edit other users. This - will allow those with the right to do so to remove - administrator privileges from other users or grant them - to themselves. Enable with care. - </para> - </listitem> - <listitem> - <para> - <emphasis>PRODUCT</emphasis>: PRODUCT bugs access. This - allows an administrator, with product-level granularity, - to specify in which products a user can edit bugs. The - user must still have the "editbugs" privelege to edit - bugs in this area; this simply restricts them from even - seeing bugs outside these boundaries if the - administrator has enabled the group sentry parameter - "usebuggroupsentry". Unless you are using bug groups, - this option has no effect. - </para> - </listitem> - </itemizedlist> + <title>Modifying Users</title> + + <para>Here I will attempt to describe the function of each option on + the Edit User screen.</para> + + <itemizedlist> + <listitem> + <para> + <emphasis>Login Name</emphasis> + + : This is generally the user's email address. However, if you + have edited your system parameters, this may just be the user's + login name or some other identifier. + <tip> + <para>For compatability reasons, you should probably stick with + email addresses as user login names. It will make your life + easier.</para> + </tip> + </para> + </listitem> + + <listitem> + <para> + <emphasis>Real Name</emphasis> + + : Duh!</para> + </listitem> + + <listitem> + <para> + <emphasis>Password</emphasis> + + : You can change the user password here. It is normal to only see + asterisks.</para> + </listitem> + + <listitem> + <para> + <emphasis>Disable Text</emphasis> + + : If you type anything in this box, including just a space, the + user account is disabled from making any changes to bugs via the + web interface, and what you type in this box is presented as the + reason. + <warning> + <para>Don't disable the administrator account!</para> + </warning> + + <note> + <para>As of this writing, the user can still submit bugs via + the e-mail gateway, if you set it up, despite the disabled text + field. The e-mail gateway should + <emphasis>not</emphasis> + + be enabled for secure installations of Bugzilla.</para> + </note> + </para> + </listitem> + + <listitem> + <para> + <emphasis>CanConfirm</emphasis> + + : This field is only used if you have enabled "unconfirmed" + status in your parameters screen. If you enable this for a user, + that user can then move bugs from "Unconfirmed" to "Confirmed" + status (e.g.: "New" status). Be judicious about allowing users to + turn this bit on for other users.</para> + </listitem> + + <listitem> + <para> + <emphasis>Creategroups</emphasis> + + : This option will allow a user to create and destroy groups in + Bugzilla. Unless you are using the Bugzilla GroupSentry security + option "usebuggroupsentry" in your parameters, this setting has + no effect.</para> + </listitem> + + <listitem> + <para> + <emphasis>Editbugs</emphasis> + + : Unless a user has this bit set, they can only edit those bugs + for which they are the assignee or the reporter. + <note> + <para>Leaving this option unchecked does not prevent users from + adding comments to a bug! They simply cannot change a bug + priority, severity, etc. unless they are the assignee or + reporter.</para> + </note> + </para> + </listitem> + + <listitem> + <para> + <emphasis>Editcomponents</emphasis> + + : This flag allows a user to create new products and components, + as well as modify and destroy those that have no bugs associated + with them. If a product or component has bugs associated with it, + those bugs must be moved to a different product or component + before Bugzilla will allow them to be destroyed. The name of a + product or component can be changed without affecting the + associated bugs, but it tends to annoy the hell out of your users + when these change a lot.</para> + </listitem> + + <listitem> + <para> + <emphasis>Editkeywords</emphasis> + + : If you use Bugzilla's keyword functionality, enabling this + feature allows a user can create and destroy keywords. As always, + the keywords for existing bugs containing the keyword the user + wishes to destroy must be changed before Bugzilla will allow it + to die. You must be very careful about creating too many new + keywords if you run a very large Bugzilla installation; keywords + are global variables across products, and you can often run into + a phenomenon called "keyword bloat". This confuses users, and + then the feature goes unused.</para> + </listitem> + + <listitem> + <para> + <emphasis>Editusers</emphasis> + + : This flag allows a user do what you're doing right now: edit + other users. This will allow those with the right to do so to + remove administrator privileges from other users or grant them to + themselves. Enable with care.</para> + </listitem> + + <listitem> + <para> + <emphasis>PRODUCT</emphasis> + + : PRODUCT bugs access. This allows an administrator, with + product-level granularity, to specify in which products a user + can edit bugs. The user must still have the "editbugs" privelege + to edit bugs in this area; this simply restricts them from even + seeing bugs outside these boundaries if the administrator has + enabled the group sentry parameter "usebuggroupsentry". Unless + you are using bug groups, this option has no effect.</para> + </listitem> + </itemizedlist> </section> </section> </section> <section id="programadmin"> - <title>Product, Component, Milestone, and Version - Administration</title> + <title>Product, Component, Milestone, and Version Administration</title> + <epigraph> - <para> - Dear Lord, we have to get our users to do WHAT? - </para> + <para>Dear Lord, we have to get our users to do WHAT?</para> </epigraph> <section id="products"> <title>Products</title> + <subtitle>Formerly, and in some spots still, called - "Programs"</subtitle> - <para> - <glossterm linkend="gloss-product" baseform="product">Products</glossterm> are - the broadest category in Bugzilla, and you should have the - least of these. If your company makes computer games, you - should have one product per game, and possibly a few special - products (website, meetings...) - </para> + "Programs"</subtitle> + <para> - A Product (formerly called "Program", and still referred to - that way in some portions of the source code) controls some - very important functions. The number of "votes" available for - users to vote for the most important bugs is set per-product, - as is the number of votes required to move a bug automatically - from the UNCONFIRMED status to the NEW status. One can close - a Product for further bug entry and define various Versions - available from the Edit product screen. - </para> + <glossterm linkend="gloss-product" baseform="product"> + Products</glossterm> + + are the broadest category in Bugzilla, and you should have the least of + these. If your company makes computer games, you should have one + product per game, and possibly a few special products (website, + meetings...)</para> + + <para>A Product (formerly called "Program", and still referred to that + way in some portions of the source code) controls some very important + functions. The number of "votes" available for users to vote for the + most important bugs is set per-product, as is the number of votes + required to move a bug automatically from the UNCONFIRMED status to the + NEW status. One can close a Product for further bug entry and define + various Versions available from the Edit product screen.</para> + <para>To create a new product:</para> + <orderedlist> - <listitem> - <para> - Select "components" from the yellow footer - </para> - <tip> - <para> - It may seem counterintuitive to click "components" when - you want to edit the properties associated with - Products. This is one of a long list of things we want - in Bugzilla 3.0... - </para> - </tip> - </listitem> - <listitem> - <para> - Select the "Add" link to the right of "Add a new product". - </para> - </listitem> - <listitem> - <para> - Enter the name of the product and a description. The - Description field is free-form. - </para> - </listitem> + <listitem> + <para>Select "components" from the yellow footer</para> + + <tip> + <para>It may seem counterintuitive to click "components" when you + want to edit the properties associated with Products. This is one + of a long list of things we want in Bugzilla 3.0...</para> + </tip> + </listitem> + + <listitem> + <para>Select the "Add" link to the right of "Add a new + product".</para> + </listitem> + + <listitem> + <para>Enter the name of the product and a description. The + Description field is free-form.</para> + </listitem> </orderedlist> + <tip> - <para> - Don't worry about the "Closed for bug entry", "Maximum Votes - per person", "Maximum votes a person can put on a single - bug", "Number of votes a bug in this Product needs to - automatically get out of the UNCOMFIRMED state", and - "Version" options yet. We'll cover those in a few moments. - </para> + <para>Don't worry about the "Closed for bug entry", "Maximum Votes + per person", "Maximum votes a person can put on a single bug", + "Number of votes a bug in this Product needs to automatically get out + of the UNCOMFIRMED state", and "Version" options yet. We'll cover + those in a few moments.</para> </tip> </section> - + <section id="components"> <title>Components</title> - <para> - Components are subsections of a Product. - - <example> - <title>Creating some Components</title> - <informalexample> - <para> - The computer game you are designing may have a "UI" - component, an "API" component, a "Sound System" - component, and a "Plugins" component, each overseen by - a different programmer. It often makes sense to divide - Components in Bugzilla according to the natural - divisions of responsibility within your Product or - company. - </para> - </informalexample> - </example> Each component has a owner and (if you turned it on - in the parameters), a QA Contact. The owner should be the - primary person who fixes bugs in that component. The QA - Contact should be the person who will ensure these bugs are - completely fixed. The Owner, QA Contact, and Reporter will get - email when new bugs are created in this Component and when - these bugs change. Default Owner and Default QA Contact fields - only dictate the <emphasis>default assignments</emphasis>; the - Owner and QA Contact fields in a bug are otherwise unrelated - to the Component. - </para> - <para> - To create a new Component: - </para> + <para>Components are subsections of a Product. + <example> + <title>Creating some Components</title> + + <informalexample> + <para>The computer game you are designing may have a "UI" + component, an "API" component, a "Sound System" component, and a + "Plugins" component, each overseen by a different programmer. It + often makes sense to divide Components in Bugzilla according to the + natural divisions of responsibility within your Product or + company.</para> + </informalexample> + </example> + + Each component has a owner and (if you turned it on in the parameters), + a QA Contact. The owner should be the primary person who fixes bugs in + that component. The QA Contact should be the person who will ensure + these bugs are completely fixed. The Owner, QA Contact, and Reporter + will get email when new bugs are created in this Component and when + these bugs change. Default Owner and Default QA Contact fields only + dictate the + <emphasis>default assignments</emphasis> + + ; the Owner and QA Contact fields in a bug are otherwise unrelated to + the Component.</para> + + <para>To create a new Component:</para> + <orderedlist> - <listitem> - <para> - Select the "Edit components" link from the "Edit product" - page - </para> - </listitem> - <listitem> - <para> - Select the "Add" link to the right of the "Add a new - component" text on the "Select Component" page. - </para> - </listitem> - <listitem> - <para> - Fill out the "Component" field, a short "Description", and - the "Initial Owner". The Component and Description fields - are free-form; the "Initial Owner" field must be that of a - user ID already existing in the database. If the initial - owner does not exist, Bugzilla will refuse to create the - component. - <tip> - <para> - Is your "Default Owner" a user who is not yet in the - database? No problem. - <orderedlist> - <listitem> - <para> - Select the "Log out" link on the footer of the - page. - </para> - </listitem> - <listitem> - <para> - Select the "New Account" link on the footer of - the "Relogin" page - </para> - </listitem> - <listitem> - <para> - Type in the email address of the default owner - you want to create in the "E-mail address" - field, and her full name in the "Real name" - field, then select the "Submit Query" button. - </para> - </listitem> - <listitem> - <para> - Now select "Log in" again, type in your login - information, and you can modify the product to - use the Default Owner information you require. - </para> - </listitem> - </orderedlist> - </para> - </tip> - </para> - </listitem> - <listitem> - <para> - Either Edit more components or return to the Bugzilla - Query Page. To return to the Product you were editing, you - must select the Components link as before. - </para> - </listitem> + <listitem> + <para>Select the "Edit components" link from the "Edit product" + page</para> + </listitem> + + <listitem> + <para>Select the "Add" link to the right of the "Add a new + component" text on the "Select Component" page.</para> + </listitem> + + <listitem> + <para>Fill out the "Component" field, a short "Description", and + the "Initial Owner". The Component and Description fields are + free-form; the "Initial Owner" field must be that of a user ID + already existing in the database. If the initial owner does not + exist, Bugzilla will refuse to create the component. + <tip> + <para>Is your "Default Owner" a user who is not yet in the + database? No problem. + <orderedlist> + <listitem> + <para>Select the "Log out" link on the footer of the + page.</para> + </listitem> + + <listitem> + <para>Select the "New Account" link on the footer of the + "Relogin" page</para> + </listitem> + + <listitem> + <para>Type in the email address of the default owner you want + to create in the "E-mail address" field, and her full name in + the "Real name" field, then select the "Submit Query" + button.</para> + </listitem> + + <listitem> + <para>Now select "Log in" again, type in your login + information, and you can modify the product to use the + Default Owner information you require.</para> + </listitem> + </orderedlist> + </para> + </tip> + </para> + </listitem> + + <listitem> + <para>Either Edit more components or return to the Bugzilla Query + Page. To return to the Product you were editing, you must select + the Components link as before.</para> + </listitem> </orderedlist> </section> - + <section id="versions"> <title>Versions</title> - <para> - Versions are the revisions of the product, such as "Flinders - 3.1", "Flinders 95", and "Flinders 2000". Using Versions - helps you isolate code changes and are an aid in reporting. - - <example> - <title>Common Use of Versions</title> - <informalexample> - <para> - A user reports a bug against Version "Beta 2.0" of your - product. The current Version of your software is - "Release Candidate 1", and no longer has the bug. This - will help you triage and classify bugs according to - their relevance. It is also possible people may report - bugs against bleeding-edge beta versions that are not - evident in older versions of the software. This can - help isolate code changes that caused the bug - </para> - </informalexample> - </example> - <example> - <title>A Different Use of Versions</title> - <informalexample> - <para> - This field has been used to good effect by an online - service provider in a slightly different way. They had - three versions of the product: "Production", "QA", and - "Dev". Although it may be the same product, a bug in - the development environment is not normally as critical - as a Production bug, nor does it need to be reported - publicly. When used in conjunction with Target - Milestones, one can easily specify the environment where - a bug can be reproduced, and the Milestone by which it - will be fixed. - </para> - </informalexample> - </example> - </para> - <para> - To create and edit Versions: + + <para>Versions are the revisions of the product, such as "Flinders + 3.1", "Flinders 95", and "Flinders 2000". Using Versions helps you + isolate code changes and are an aid in reporting. + <example> + <title>Common Use of Versions</title> + + <informalexample> + <para>A user reports a bug against Version "Beta 2.0" of your + product. The current Version of your software is "Release Candidate + 1", and no longer has the bug. This will help you triage and + classify bugs according to their relevance. It is also possible + people may report bugs against bleeding-edge beta versions that are + not evident in older versions of the software. This can help + isolate code changes that caused the bug</para> + </informalexample> + </example> + + <example> + <title>A Different Use of Versions</title> + + <informalexample> + <para>This field has been used to good effect by an online service + provider in a slightly different way. They had three versions of + the product: "Production", "QA", and "Dev". Although it may be the + same product, a bug in the development environment is not normally + as critical as a Production bug, nor does it need to be reported + publicly. When used in conjunction with Target Milestones, one can + easily specify the environment where a bug can be reproduced, and + the Milestone by which it will be fixed.</para> + </informalexample> + </example> </para> + + <para>To create and edit Versions:</para> + <orderedlist> - <listitem> - <para> - From the "Edit product" screen, select "Edit Versions" - </para> - </listitem> - <listitem> - <para> - You will notice that the product already has the default - version "undefined". If your product doesn't use version - numbers, you may want to leave this as it is or edit it so - that it is "---". You can then go back to the edit - versions page and add new versions to your product. - </para> - <para> - Otherwise, click the "Add" button to the right of the "Add - a new version" text. - </para> - </listitem> - <listitem> - <para> - Enter the name of the Version. This can be free-form - characters up to the limit of the text box. Then select - the "Add" button. - </para> - </listitem> - <listitem> - <para> - At this point you can select "Edit" to edit more Versions, - or return to the "Query" page, from which you can navigate - back to the product through the "components" link at the - foot of the Query page. - </para> - </listitem> + <listitem> + <para>From the "Edit product" screen, select "Edit Versions"</para> + </listitem> + + <listitem> + <para>You will notice that the product already has the default + version "undefined". If your product doesn't use version numbers, + you may want to leave this as it is or edit it so that it is "---". + You can then go back to the edit versions page and add new versions + to your product.</para> + + <para>Otherwise, click the "Add" button to the right of the "Add a + new version" text.</para> + </listitem> + + <listitem> + <para>Enter the name of the Version. This can be free-form + characters up to the limit of the text box. Then select the "Add" + button.</para> + </listitem> + + <listitem> + <para>At this point you can select "Edit" to edit more Versions, or + return to the "Query" page, from which you can navigate back to the + product through the "components" link at the foot of the Query + page.</para> + </listitem> </orderedlist> </section> - + <section id="milestones"> <title>Milestones</title> - <para> - Milestones are "targets" that you plan to get a bug fixed by. - For example, you have a bug that you plan to fix for your 3.0 - release, it would be assigned the milestone of 3.0. Or, you - have a bug that you plan to fix for 2.8, this would have a - milestone of 2.8. - </para> + + <para>Milestones are "targets" that you plan to get a bug fixed by. For + example, you have a bug that you plan to fix for your 3.0 release, it + would be assigned the milestone of 3.0. Or, you have a bug that you + plan to fix for 2.8, this would have a milestone of 2.8.</para> + <note> - <para> - Milestone options will only appear for a Product if you - turned the "usetargetmilestone" field in the "Edit - Parameters" screen "On". - </para> + <para>Milestone options will only appear for a Product if you turned + the "usetargetmilestone" field in the "Edit Parameters" screen + "On".</para> </note> - <para> - To create new Milestones, set Default Milestones, and set - Milestone URL: - </para> + + <para>To create new Milestones, set Default Milestones, and set + Milestone URL:</para> + <orderedlist> - <listitem> - <para> - Select "edit milestones" - </para> - </listitem> - <listitem> - <para> - Select "Add" to the right of the "Add a new milestone" - text - </para> - </listitem> - <listitem> - <para> - Enter the name of the Milestone in the "Milestone" field. - You can optionally set the "Sortkey", which is a positive - or negative number (-255 to 255) that defines where in the - list this particular milestone appears. Select "Add". - </para> - <example> - <title>Using SortKey with Target Milestone</title> - <informalexample> - <para> - Let's say you create a target milestone called - "Release 1.0", with Sortkey set to "0". Later, you - realize that you will have a public beta, called - "Beta1". You can create a Milestone called "Beta1", - with a Sortkey of "-1" in order to ensure people will - see the Target Milestone of "Beta1" earlier on the - list than "Release 1.0" - </para> - </informalexample> - </example> - </listitem> - <listitem> - <para> - If you want to add more milestones, select the "Edit" - link. If you don't, well shoot, you have to go back to the - "query" page and select "components" again, and make your - way back to the Product you were editing. - <note> - <para> - This is another in the list of unusual user interface - decisions that we'd like to get cleaned up. Shouldn't - there be a link to the effect of "edit the Product I - was editing when I ended up here"? In any case, - clicking "components" in the footer takes you back to - the "Select product" screen, from which you can begin - editing your product again. - </para> - </note> - </para> - </listitem> - <listitem> - <para> - From the Edit product screen again (once you've made your - way back), enter the URL for a description of what your - milestones are for this product in the "Milestone URL" - field. It should be of the format - "http://www.foo.com/bugzilla/product_milestones.html" - </para> - <para> - Some common uses of this field include product - descriptions, product roadmaps, and of course a simple - description of the meaning of each milestone. - </para> - </listitem> - <listitem> - <para> - If you're using Target Milestones, the "Default Milestone" - field must have some kind of entry. If you really don't - care if people set coherent Target Milestones, simply - leave this at the default, "---". However, controlling - and regularly updating the Default Milestone field is a - powerful tool when reporting the status of projects. - </para> - <para>Select the "Update" button when you are done.</para> - </listitem> + <listitem> + <para>Select "edit milestones"</para> + </listitem> + + <listitem> + <para>Select "Add" to the right of the "Add a new milestone" + text</para> + </listitem> + + <listitem> + <para>Enter the name of the Milestone in the "Milestone" field. You + can optionally set the "Sortkey", which is a positive or negative + number (-255 to 255) that defines where in the list this particular + milestone appears. Select "Add".</para> + + <example> + <title>Using SortKey with Target Milestone</title> + + <informalexample> + <para>Let's say you create a target milestone called "Release + 1.0", with Sortkey set to "0". Later, you realize that you will + have a public beta, called "Beta1". You can create a Milestone + called "Beta1", with a Sortkey of "-1" in order to ensure + people will see the Target Milestone of "Beta1" earlier on the + list than "Release 1.0"</para> + </informalexample> + </example> + </listitem> + + <listitem> + <para>If you want to add more milestones, select the "Edit" link. + If you don't, well shoot, you have to go back to the "query" page + and select "components" again, and make your way back to the + Product you were editing. + <note> + <para>This is another in the list of unusual user interface + decisions that we'd like to get cleaned up. Shouldn't there be a + link to the effect of "edit the Product I was editing when I + ended up here"? In any case, clicking "components" in the footer + takes you back to the "Select product" screen, from which you can + begin editing your product again.</para> + </note> + </para> + </listitem> + + <listitem> + <para>From the Edit product screen again (once you've made your way + back), enter the URL for a description of what your milestones are + for this product in the "Milestone URL" field. It should be of the + format "http://www.foo.com/bugzilla/product_milestones.html"</para> + + <para>Some common uses of this field include product descriptions, + product roadmaps, and of course a simple description of the meaning + of each milestone.</para> + </listitem> + + <listitem> + <para>If you're using Target Milestones, the "Default Milestone" + field must have some kind of entry. If you really don't care if + people set coherent Target Milestones, simply leave this at the + default, "---". However, controlling and regularly updating the + Default Milestone field is a powerful tool when reporting the + status of projects.</para> + + <para>Select the "Update" button when you are done.</para> + </listitem> </orderedlist> </section> - + <section id="voting"> <title>Voting</title> - <para> - The concept of "voting" is a poorly understood, yet powerful - feature for the management of open-source projects. Each user - is assigned so many Votes per product, which they can freely - reassign (or assign multiple votes to a single bug). This - allows developers to gauge user need for a particular - enhancement or bugfix. By allowing bugs with a certain number - of votes to automatically move from "UNCONFIRMED" to "NEW", - users of the bug system can help high-priority bugs garner - attention so they don't sit for a long time awaiting triage. - </para> - <para> - The daunting challenge of Votes is deciding where you draw the - line for a "vocal majority". If you only have a user base of - 100 users, setting a low threshold for bugs to move from - UNCONFIRMED to NEW makes sense. As the Bugzilla user base - expands, however, these thresholds must be re-evaluated. You - should gauge whether this feature is worth the time and close - monitoring involved, and perhaps forego implementation until - you have a critical mass of users who demand it. - </para> + + <para>The concept of "voting" is a poorly understood, yet powerful + feature for the management of open-source projects. Each user is + assigned so many Votes per product, which they can freely reassign (or + assign multiple votes to a single bug). This allows developers to gauge + user need for a particular enhancement or bugfix. By allowing bugs with + a certain number of votes to automatically move from "UNCONFIRMED" to + "NEW", users of the bug system can help high-priority bugs garner + attention so they don't sit for a long time awaiting triage.</para> + + <para>The daunting challenge of Votes is deciding where you draw the + line for a "vocal majority". If you only have a user base of 100 users, + setting a low threshold for bugs to move from UNCONFIRMED to NEW makes + sense. As the Bugzilla user base expands, however, these thresholds + must be re-evaluated. You should gauge whether this feature is worth + the time and close monitoring involved, and perhaps forego + implementation until you have a critical mass of users who demand + it.</para> + <para>To modify Voting settings:</para> + <orderedlist> - <listitem> - <para> - Navigate to the "Edit product" screen for the Product you - wish to modify - </para> - </listitem> - <listitem> - <para> - Set "Maximum Votes per person" to your calculated value. - Setting this field to "0" disables voting. - </para> - </listitem> - <listitem> - <para> - Set "Maximum Votes a person can put on a single bug" to - your calculated value. It should probably be some number - lower than the "Maximum votes per person". Setting this - field to "0" disables voting, but leaves the voting - options open to the user. This is confusing. - </para> - </listitem> - <listitem> - <para> - Set "Number of votes a bug in this product needs to - automatically get out of the UNCONFIRMED state" to your - calculated number. Setting this field to "0" disables - the automatic move of bugs from UNCONFIRMED to NEW. Some - people advocate leaving this at "0", but of what use are - Votes if your Bugzilla user base is unable to affect which - bugs appear on Development radar? - <tip> - <para> - You should probably set this number to higher than a - small coalition of Bugzilla users can influence it. - Most sites use this as a "referendum" mechanism -- if - users are able to vote a bug out of UNCONFIRMED, it is - a <emphasis>really</emphasis> bad bug! - </para> - </tip> - </para> - </listitem> - <listitem> - <para> - Once you have adjusted the values to your preference, - select the "Update" button. - </para> - </listitem> + <listitem> + <para>Navigate to the "Edit product" screen for the Product you + wish to modify</para> + </listitem> + + <listitem> + <para>Set "Maximum Votes per person" to your calculated value. + Setting this field to "0" disables voting.</para> + </listitem> + + <listitem> + <para>Set "Maximum Votes a person can put on a single bug" to your + calculated value. It should probably be some number lower than the + "Maximum votes per person". Setting this field to "0" disables + voting, but leaves the voting options open to the user. This is + confusing.</para> + </listitem> + + <listitem> + <para>Set "Number of votes a bug in this product needs to + automatically get out of the UNCONFIRMED state" to your calculated + number. Setting this field to "0" disables the automatic move of + bugs from UNCONFIRMED to NEW. Some people advocate leaving this at + "0", but of what use are Votes if your Bugzilla user base is unable + to affect which bugs appear on Development radar? + <tip> + <para>You should probably set this number to higher than a small + coalition of Bugzilla users can influence it. Most sites use this + as a "referendum" mechanism -- if users are able to vote a bug + out of UNCONFIRMED, it is a + <emphasis>really</emphasis> + + bad bug!</para> + </tip> + </para> + </listitem> + + <listitem> + <para>Once you have adjusted the values to your preference, select + the "Update" button.</para> + </listitem> </orderedlist> - </section> + </section> <section id="groups"> <title>Groups and Group Security</title> - <para> - Groups can be very useful in bugzilla, because they allow - users to isolate bugs or products that should only be seen by - certain people. Groups can also be a complicated minefield of - interdependencies and weirdness if mismanaged. - - <example> - <title>When to Use Group Security</title> - <informalexample> - <para> - Many Bugzilla sites isolate "Security-related" bugs from - all other bugs. This way, they can have a fix ready - before the security vulnerability is announced to the - world. You can create a "Security" product which, by - default, has no members, and only add members to the - group (in their individual User page, as described under - User Administration) who should have priveleged access - to "Security" bugs. Alternately, you may create a Group - independently of any Product, and change the Group mask - on individual bugs to restrict access to members only of - certain Groups. - </para> - </informalexample> - </example> Groups only work if you enable the "usebuggroups" - paramater. In addition, if the "usebuggroupsentry" parameter - is "On", one can restrict access to products by groups, so - that only members of a product group are able to view bugs - within that product. Group security in Bugzilla can be divided - into two categories: Generic and Product-Based. - </para> + + <para>Groups can be very useful in bugzilla, because they allow users + to isolate bugs or products that should only be seen by certain people. + Groups can also be a complicated minefield of interdependencies and + weirdness if mismanaged. + <example> + <title>When to Use Group Security</title> + + <informalexample> + <para>Many Bugzilla sites isolate "Security-related" bugs from all + other bugs. This way, they can have a fix ready before the security + vulnerability is announced to the world. You can create a + "Security" product which, by default, has no members, and only add + members to the group (in their individual User page, as described + under User Administration) who should have priveleged access to + "Security" bugs. Alternately, you may create a Group independently + of any Product, and change the Group mask on individual bugs to + restrict access to members only of certain Groups.</para> + </informalexample> + </example> + + Groups only work if you enable the "usebuggroups" paramater. In + addition, if the "usebuggroupsentry" parameter is "On", one can + restrict access to products by groups, so that only members of a + product group are able to view bugs within that product. Group security + in Bugzilla can be divided into two categories: Generic and + Product-Based.</para> + <note> - <para> - Groups in Bugzilla are a complicated beast that evolved out - of very simple user permission bitmasks, apparently itself - derived from common concepts in UNIX access controls. A - "bitmask" is a fixed-length number whose value can describe - one, and only one, set of states. For instance, UNIX file - permissions are assigned bitmask values: "execute" has a - value of 1, "write" has a value of 2, and "read" has a - value of 4. Add them together, and a file can be read, - written to, and executed if it has a bitmask of "7". (This - is a simplified example -- anybody who knows UNIX security - knows there is much more to it than this. Please bear with - me for the purpose of this note.) The only way a bitmask - scheme can work is by doubling the bit count for each value. - Thus if UNIX wanted to offer another file permission, the - next would have to be a value of 8, then the next 16, the - next 32, etc. - </para> - <para> - Similarly, Bugzilla offers a bitmask to define group - permissions, with an internal limit of 64. Several are - already occupied by built-in permissions. The way around - this limitation is to avoid assigning groups to products if - you have many products, avoid bloating of group lists, and - religiously prune irrelevant groups. In reality, most - installations of Bugzilla support far fewer than 64 groups, - so this limitation has not hit for most sites, but it is on - the table to be revised for Bugzilla 3.0 because it - interferes with the security schemes of some administrators. - </para> + <para>Groups in Bugzilla are a complicated beast that evolved out of + very simple user permission bitmasks, apparently itself derived from + common concepts in UNIX access controls. A "bitmask" is a + fixed-length number whose value can describe one, and only one, set + of states. For instance, UNIX file permissions are assigned bitmask + values: "execute" has a value of 1, "write" has a value of 2, and + "read" has a value of 4. Add them together, and a file can be read, + written to, and executed if it has a bitmask of "7". (This is a + simplified example -- anybody who knows UNIX security knows there is + much more to it than this. Please bear with me for the purpose of + this note.) The only way a bitmask scheme can work is by doubling the + bit count for each value. Thus if UNIX wanted to offer another file + permission, the next would have to be a value of 8, then the next 16, + the next 32, etc.</para> + + <para>Similarly, Bugzilla offers a bitmask to define group + permissions, with an internal limit of 64. Several are already + occupied by built-in permissions. The way around this limitation is + to avoid assigning groups to products if you have many products, + avoid bloating of group lists, and religiously prune irrelevant + groups. In reality, most installations of Bugzilla support far fewer + than 64 groups, so this limitation has not hit for most sites, but it + is on the table to be revised for Bugzilla 3.0 because it interferes + with the security schemes of some administrators.</para> </note> - <para> - To enable Generic Group Security ("usebuggroups"): - </para> + + <para>To enable Generic Group Security ("usebuggroups"):</para> + <orderedlist> - <listitem> - <para> - Turn "On" "usebuggroups" in the "Edit Parameters" screen. - </para> - </listitem> - <listitem> - <para> - You will generally have no groups set up. Select the - "groups" link in the footer. - </para> - </listitem> - <listitem> - <para> - Take a moment to understand the instructions on the "Edit - Groups" screen. Once you feel confident you understand - what is expected of you, select the "Add Group" link. - </para> - </listitem> - <listitem> - <para> - Fill out the "New Name" (remember, no spaces!), "New - Description", and "New User RegExp" fields. "New User - RegExp" allows you to automatically place all users who - fulfill the Regular Expression into the new group. - - <example> - <title>Creating a New Group</title> - <informalexample> - <para> - I created a group called DefaultGroup with a - description of <quote>This is simply a group to play - with</quote>, and a New User RegExp of <quote>.*@mydomain.tld</quote>. - This new group automatically includes all Bugzilla - users with "@mydomain.tld" at the end of their user id. - When I finished, my new group was assigned bit #128. - </para> - </informalexample> - </example> When you have finished, select the Add - button. - </para> - </listitem> + <listitem> + <para>Turn "On" "usebuggroups" in the "Edit Parameters" + screen.</para> + </listitem> + + <listitem> + <para>You will generally have no groups set up. Select the "groups" + link in the footer.</para> + </listitem> + + <listitem> + <para>Take a moment to understand the instructions on the "Edit + Groups" screen. Once you feel confident you understand what is + expected of you, select the "Add Group" link.</para> + </listitem> + + <listitem> + <para>Fill out the "New Name" (remember, no spaces!), "New + Description", and "New User RegExp" fields. "New User RegExp" + allows you to automatically place all users who fulfill the Regular + Expression into the new group. + <example> + <title>Creating a New Group</title> + + <informalexample> + <para>I created a group called DefaultGroup with a description + of + <quote>This is simply a group to play with</quote> + + , and a New User RegExp of + <quote>.*@mydomain.tld</quote> + + . This new group automatically includes all Bugzilla users with + "@mydomain.tld" at the end of their user id. When I finished, + my new group was assigned bit #128.</para> + </informalexample> + </example> + + When you have finished, select the Add button.</para> + </listitem> </orderedlist> - <para> - To enable Product-Based Group Security (usebuggroupsentry): - </para> + <para>To enable Product-Based Group Security + (usebuggroupsentry):</para> + <warning> - <para> - Don't forget that you only have 64 groups masks available, - total, for your installation of Bugzilla! If you plan on - having more than 50 products in your individual Bugzilla - installation, and require group security for your products, - you should consider either running multiple Bugzillas or - using Generic Group Security instead of Product-Based - ("usebuggroupsentry") Group Security. - </para> + <para>Don't forget that you only have 64 groups masks available, + total, for your installation of Bugzilla! If you plan on having more + than 50 products in your individual Bugzilla installation, and + require group security for your products, you should consider either + running multiple Bugzillas or using Generic Group Security instead of + Product-Based ("usebuggroupsentry") Group Security.</para> </warning> + <orderedlist> - <listitem> - <para> - Turn "On" "usebuggroups" and "usebuggroupsentry" in the - "Edit Parameters" screen. - </para> - <warning> - <para> - "usebuggroupsentry" has the capacity to prevent the - administrative user from directly altering bugs because - of conflicting group permissions. If you plan on using - "usebuggroupsentry", you should plan on restricting - administrative account usage to administrative duties - only. In other words, manage bugs with an unpriveleged - user account, and manage users, groups, Products, etc. - with the administrative account. - </para> - </warning> - </listitem> - <listitem> - <para> - You will generally have no Groups set up, unless you - enabled "usebuggroupsentry" prior to creating any - Products. To create "Generic Group Security" groups, - follow the instructions given above. To create - Product-Based Group security, simply follow the - instructions for creating a new Product. If you need to - add users to these new groups as you create them, you will - find the option to add them to the group available under - the "Edit User" screens. - </para> - </listitem> + <listitem> + <para>Turn "On" "usebuggroups" and "usebuggroupsentry" in the "Edit + Parameters" screen.</para> + + <warning> + <para>"usebuggroupsentry" has the capacity to prevent the + administrative user from directly altering bugs because of + conflicting group permissions. If you plan on using + "usebuggroupsentry", you should plan on restricting + administrative account usage to administrative duties only. In + other words, manage bugs with an unpriveleged user account, and + manage users, groups, Products, etc. with the administrative + account.</para> + </warning> + </listitem> + + <listitem> + <para>You will generally have no Groups set up, unless you enabled + "usebuggroupsentry" prior to creating any Products. To create + "Generic Group Security" groups, follow the instructions given + above. To create Product-Based Group security, simply follow the + instructions for creating a new Product. If you need to add users + to these new groups as you create them, you will find the option to + add them to the group available under the "Edit User" + screens.</para> + </listitem> </orderedlist> - <para> - You may find this example illustrative for how bug groups work. - <example> - <title>Bugzilla Groups</title> - <literallayout> -Bugzilla Groups example ------------------------ - -For this example, let us suppose we have four groups, call them -Group1, Group2, Group3, and Group4. - -We have 5 users, User1, User2, User3, User4, User5. - -We have 8 bugs, Bug1, ..., Bug8. - -Group membership is defined by this chart: -(X denotes that user is in that group.) -(I apologize for the nasty formatting of this table. Try viewing -it in a text-based browser or something for now. -MPB) - - G G G G - r r r r - o o o o - u u u u - p p p p - 1 2 3 4 - +-+-+-+-+ -User1|X| | | | - +-+-+-+-+ -User2| |X| | | - +-+-+-+-+ -User3|X| |X| | - +-+-+-+-+ -User4|X|X|X| | - +-+-+-+-+ -User5| | | | | - +-+-+-+-+ - -Bug restrictions are defined by this chart: -(X denotes that bug is restricted to that group.) - - G G G G - r r r r - o o o o - u u u u - p p p p - 1 2 3 4 - +-+-+-+-+ -Bug1| | | | | - +-+-+-+-+ -Bug2| |X| | | - +-+-+-+-+ -Bug3| | |X| | - +-+-+-+-+ -Bug4| | | |X| - +-+-+-+-+ -Bug5|X|X| | | - +-+-+-+-+ -Bug6|X| |X| | - +-+-+-+-+ -Bug7|X|X|X| | - +-+-+-+-+ -Bug8|X|X|X|X| - +-+-+-+-+ - -Who can see each bug? - -Bug1 has no group restrictions. Therefore, Bug1 can be seen by any -user, whatever their group membership. This is going to be the only -bug that User5 can see, because User5 isn't in any groups. - -Bug2 can be seen by anyone in Group2, that is User2 and User4. - -Bug3 can be seen by anyone in Group3, that is User3 and User4. - -Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of -these users can see Bug4. - -Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This -is only User4. User1 cannot see it because he is not in Group2, and -User2 cannot see it because she is not in Group1. - -Bug6 can be seen by anyone who is in both Group1 and Group3. This -would include User3 and User4. Similar to Bug5, User1 cannot see Bug6 -because he is not in Group3. - -Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This -is only User4. All of the others are missing at least one of those -group privileges, and thus cannot see the bug. - -Bug8 can be seen by anyone who is in Group1, Group2, Group3, and -Group4. There is nobody in all four of these groups, so nobody can -see Bug8. It doesn't matter that User4 is in Group1, Group2, and -Group3, since he isn't in Group4. - </literallayout> - </example> + + <para>You may find this example illustrative for how bug groups work. + <example> + <title>Bugzilla Groups</title> + + <literallayout>Bugzilla Groups example ----------------------- For + this example, let us suppose we have four groups, call them Group1, + Group2, Group3, and Group4. We have 5 users, User1, User2, User3, + User4, User5. We have 8 bugs, Bug1, ..., Bug8. Group membership is + defined by this chart: (X denotes that user is in that group.) (I + apologize for the nasty formatting of this table. Try viewing it in a + text-based browser or something for now. -MPB) G G G G r r r r o o o + o u u u u p p p p 1 2 3 4 +-+-+-+-+ User1|X| | | | +-+-+-+-+ User2| + |X| | | +-+-+-+-+ User3|X| |X| | +-+-+-+-+ User4|X|X|X| | +-+-+-+-+ + User5| | | | | +-+-+-+-+ Bug restrictions are defined by this chart: + (X denotes that bug is restricted to that group.) G G G G r r r r o o + o o u u u u p p p p 1 2 3 4 +-+-+-+-+ Bug1| | | | | +-+-+-+-+ Bug2| + |X| | | +-+-+-+-+ Bug3| | |X| | +-+-+-+-+ Bug4| | | |X| +-+-+-+-+ + Bug5|X|X| | | +-+-+-+-+ Bug6|X| |X| | +-+-+-+-+ Bug7|X|X|X| | + +-+-+-+-+ Bug8|X|X|X|X| +-+-+-+-+ Who can see each bug? Bug1 has no + group restrictions. Therefore, Bug1 can be seen by any user, whatever + their group membership. This is going to be the only bug that User5 + can see, because User5 isn't in any groups. Bug2 can be seen by + anyone in Group2, that is User2 and User4. Bug3 can be seen by anyone + in Group3, that is User3 and User4. Bug4 can be seen by anyone in + Group4. Nobody is in Group4, so none of these users can see Bug4. + Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This + is only User4. User1 cannot see it because he is not in Group2, and + User2 cannot see it because she is not in Group1. Bug6 can be seen by + anyone who is in both Group1 and Group3. This would include User3 and + User4. Similar to Bug5, User1 cannot see Bug6 because he is not in + Group3. Bug7 can be seen by anyone who is in Group1, Group2, and + Group3. This is only User4. All of the others are missing at least + one of those group privileges, and thus cannot see the bug. Bug8 can + be seen by anyone who is in Group1, Group2, Group3, and Group4. There + is nobody in all four of these groups, so nobody can see Bug8. It + doesn't matter that User4 is in Group1, Group2, and Group3, since he + isn't in Group4.</literallayout> + </example> </para> </section> </section> - + <section id="security"> <title>Bugzilla Security</title> + <epigraph> - <para> - Putting your money in a wall safe is better protection than - depending on the fact that no one knows that you hide your - money in a mayonnaise jar in your fridge. - </para> + <para>Putting your money in a wall safe is better protection than + depending on the fact that no one knows that you hide your money in a + mayonnaise jar in your fridge.</para> </epigraph> + <note> - <para> - Poorly-configured MySQL, Bugzilla, and FTP installations have - given attackers full access to systems in the past. Please - take these guidelines seriously, even for Bugzilla machines - hidden away behind your firewall. 80% of all computer - trespassers are insiders, not anonymous crackers. - </para> + <para>Poorly-configured MySQL, Bugzilla, and FTP installations have + given attackers full access to systems in the past. Please take these + guidelines seriously, even for Bugzilla machines hidden away behind + your firewall. 80% of all computer trespassers are insiders, not + anonymous crackers.</para> </note> - <para> - Secure your installation. - <note> - <para> - These instructions must, of necessity, be somewhat vague - since Bugzilla runs on so many different platforms. If you - have refinements of these directions for specific platforms, - please submit them to <ulink url="mailto://mozilla-webtools@mozilla.org">mozilla-webtools@mozilla.org</ulink> - </para> - </note> - <orderedlist> - <listitem> - <para> - Ensure you are running at least MysQL version 3.22.32 or - newer. Earlier versions had notable security holes and - poorly secured default configuration choices. - </para> - </listitem> - <listitem> - <para><emphasis>There is no substitute for understanding the - tools on your system!</emphasis> Read <ulink url="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> The MySQL Privilege System</ulink> until you can recite it from memory!</para> - <para> - At the very least, ensure you password the "mysql -u root" - account and the "bugs" account, establish grant table - rights (consult the Keystone guide in Appendix C: The - Bugzilla Database for some easy-to-use details) that do - not allow CREATE, DROP, RELOAD, SHUTDOWN, and PROCESS for - user "bugs". I wrote up the Keystone advice back when I - knew far less about security than I do now : ) - </para> - </listitem> - <listitem> - <para> - Lock down /etc/inetd.conf. Heck, disable inet entirely on - this box. It should only listen to port 25 for Sendmail - and port 80 for Apache. - </para> - </listitem> - <listitem> - <para> - Do not run Apache as <quote>nobody</quote>. This will - require very lax permissions in your Bugzilla directories. - Run it, instead, as a user with a name, set via your - httpd.conf file. - <note> - <para> - <quote>nobody</quote> is a real user on UNIX systems. - Having a process run as user id <quote>nobody</quote> - is absolutely no protection against system crackers - versus using any other user account. As a general - security measure, I recommend you create unique user - ID's for each daemon running on your system and, if - possible, use "chroot" to jail that process away from - the rest of your system. - </para> - </note> - </para> - </listitem> - <listitem> - <para> - Ensure you have adequate access controls for the - $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/ - directories, as well as the $BUGZILLA_HOME/localconfig and - $BUGZILLA_HOME/globals.pl files. The localconfig file - stores your "bugs" user password, which would be terrible - to have in the hands of a criminal, while the "globals.pl" - stores some default information regarding your - installation which could aid a system cracker. In - addition, some files under $BUGZILLA_HOME/data/ store - sensitive information, and $BUGZILLA_HOME/shadow/ stores - bug information for faster retrieval. If you fail to - secure these directories and this file, you will expose - bug information to those who may not be allowed to see it. - </para> - <note> - <para> - Bugzilla provides default .htaccess files to protect the - most common Apache installations. However, you should - verify these are adequate according to the site-wide - security policy of your web server, and ensure that the - .htaccess files are allowed to "override" default - permissions set in your Apache configuration files. - Covering Apache security is beyond the scope of this - Guide; please consult the Apache documentation for - details. - </para> - <para> - If you are using a web server that does not support the - .htaccess control method, <emphasis>you are at - risk!</emphasis> After installing, check to see if - you can view the file "localconfig" in your web browser - (e.g.: <ulink url="http://bugzilla.mozilla.org/localconfig"> http://bugzilla.mozilla.org/localconfig</ulink>). If you can read the contents of this file, your web server has not secured your bugzilla directory properly and you must fix this problem before deploying Bugzilla. If, however, it gives you a "Forbidden" error, then it probably respects the .htaccess conventions and you are good to go. - </para> - </note> - <para> - When you run checksetup.pl, the script will attempt to modify various - permissions on files which Bugzilla uses. If you do not have a - webservergroup set in the localconfig file, then Bugzilla will have to - make certain files world readable and/or writable. <emphasis>THIS IS - INSECURE!</emphasis>. This means that anyone who can get access to - your system can do whatever they want to your Bugzilla installation. + + <para>Secure your installation. + <note> + <para>These instructions must, of necessity, be somewhat vague since + Bugzilla runs on so many different platforms. If you have refinements + of these directions for specific platforms, please submit them to + <ulink url="mailto://mozilla-webtools@mozilla.org"> + mozilla-webtools@mozilla.org</ulink> </para> - <note> + </note> + + <orderedlist> + <listitem> + <para>Ensure you are running at least MysQL version 3.22.32 or newer. + Earlier versions had notable security holes and poorly secured + default configuration choices.</para> + </listitem> + + <listitem> <para> - This also means that if your webserver runs all cgi scripts as the - same user/group, anyone on the system who can run cgi scripts will - be able to take control of your Bugzilla installation. + <emphasis>There is no substitute for understanding the tools on your + system!</emphasis> + + Read + <ulink + url="http://www.mysql.com/documentation/mysql/bychapter/manual_Privilege_system.html"> + The MySQL Privilege System</ulink> + + until you can recite it from memory!</para> + + <para>At the very least, ensure you password the "mysql -u root" + account and the "bugs" account, establish grant table rights (consult + the Keystone guide in Appendix C: The Bugzilla Database for some + easy-to-use details) that do not allow CREATE, DROP, RELOAD, + SHUTDOWN, and PROCESS for user "bugs". I wrote up the Keystone advice + back when I knew far less about security than I do now : )</para> + </listitem> + + <listitem> + <para>Lock down /etc/inetd.conf. Heck, disable inet entirely on this + box. It should only listen to port 25 for Sendmail and port 80 for + Apache.</para> + </listitem> + + <listitem> + <para>Do not run Apache as + <quote>nobody</quote> + + . This will require very lax permissions in your Bugzilla + directories. Run it, instead, as a user with a name, set via your + httpd.conf file. + <note> + <para> + <quote>nobody</quote> + + is a real user on UNIX systems. Having a process run as user id + <quote>nobody</quote> + + is absolutely no protection against system crackers versus using + any other user account. As a general security measure, I recommend + you create unique user ID's for each daemon running on your system + and, if possible, use "chroot" to jail that process away from the + rest of your system.</para> + </note> </para> - </note> - <para> - On Apache, you can use .htaccess files to protect access - to these directories, as outlined in <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug 57161</ulink> for the localconfig file, and <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572"> Bug 65572</ulink> for adequate protection in your data/ and shadow/ directories. - </para> - <para> - Note the instructions which follow are Apache-specific. - If you use IIS, Netscape, or other non-Apache web servers, - please consult your system documentation for how to secure - these files from being transmitted to curious users. - </para> - <para> - Place the following text into a file named ".htaccess", - readable by your web server, in your $BUGZILLA_HOME/data - directory. <literallayout> <Files comments> allow - from all </Files> deny from all </literallayout> - </para> - <para> - Place the following text into a file named ".htaccess", - readable by your web server, in your $BUGZILLA_HOME/ - directory. <literallayout> <Files localconfig> deny - from all </Files> allow from all </literallayout> - </para> - <para> - Place the following text into a file named ".htaccess", - readable by your web server, in your $BUGZILLA_HOME/shadow - directory. <literallayout> deny from all </literallayout> - </para> - </listitem> - </orderedlist> + </listitem> + + <listitem> + <para>Ensure you have adequate access controls for the + $BUGZILLA_HOME/data/ and $BUGZILLA_HOME/shadow/ directories, as well + as the $BUGZILLA_HOME/localconfig and $BUGZILLA_HOME/globals.pl + files. The localconfig file stores your "bugs" user password, which + would be terrible to have in the hands of a criminal, while the + "globals.pl" stores some default information regarding your + installation which could aid a system cracker. In addition, some + files under $BUGZILLA_HOME/data/ store sensitive information, and + $BUGZILLA_HOME/shadow/ stores bug information for faster retrieval. + If you fail to secure these directories and this file, you will + expose bug information to those who may not be allowed to see + it.</para> + + <note> + <para>Bugzilla provides default .htaccess files to protect the most + common Apache installations. However, you should verify these are + adequate according to the site-wide security policy of your web + server, and ensure that the .htaccess files are allowed to + "override" default permissions set in your Apache configuration + files. Covering Apache security is beyond the scope of this Guide; + please consult the Apache documentation for details.</para> + + <para>If you are using a web server that does not support the + .htaccess control method, + <emphasis>you are at risk!</emphasis> + + After installing, check to see if you can view the file + "localconfig" in your web browser (e.g.: + <ulink url="http://bugzilla.mozilla.org/localconfig"> + http://bugzilla.mozilla.org/localconfig</ulink> + + ). If you can read the contents of this file, your web server has + not secured your bugzilla directory properly and you must fix this + problem before deploying Bugzilla. If, however, it gives you a + "Forbidden" error, then it probably respects the .htaccess + conventions and you are good to go.</para> + </note> + + <para>When you run checksetup.pl, the script will attempt to modify + various permissions on files which Bugzilla uses. If you do not have + a webservergroup set in the localconfig file, then Bugzilla will have + to make certain files world readable and/or writable. + <emphasis>THIS IS INSECURE!</emphasis> + + . This means that anyone who can get access to your system can do + whatever they want to your Bugzilla installation.</para> + + <note> + <para>This also means that if your webserver runs all cgi scripts + as the same user/group, anyone on the system who can run cgi + scripts will be able to take control of your Bugzilla + installation.</para> + </note> + + <para>On Apache, you can use .htaccess files to protect access to + these directories, as outlined in + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=57161">Bug + 57161</ulink> + + for the localconfig file, and + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=65572">Bug + 65572</ulink> + + for adequate protection in your data/ and shadow/ directories.</para> + + <para>Note the instructions which follow are Apache-specific. If you + use IIS, Netscape, or other non-Apache web servers, please consult + your system documentation for how to secure these files from being + transmitted to curious users.</para> + + <para>Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/data directory. + <literallayout><Files comments> allow from all </Files> + deny from all</literallayout> + </para> + + <para>Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/ directory. + <literallayout><Files localconfig> deny from all </Files> + allow from all</literallayout> + </para> + + <para>Place the following text into a file named ".htaccess", + readable by your web server, in your $BUGZILLA_HOME/shadow directory. + + <literallayout>deny from all</literallayout> + </para> + </listitem> + </orderedlist> </para> </section> </chapter> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -1433,3 +1385,4 @@ sgml-shorttag:t sgml-tag-region-if-active:t End: --> + diff --git a/docs/en/xml/conventions.xml b/docs/en/xml/conventions.xml index 6382985b6..f6aa00338 100644 --- a/docs/en/xml/conventions.xml +++ b/docs/en/xml/conventions.xml @@ -1,99 +1,156 @@ <!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> - <section id="conventions"> <title>Document Conventions</title> - + <indexterm zone="conventions"> <primary>conventions</primary> </indexterm> - - <para> - This document uses the following conventions - </para> - + + <para>This document uses the following conventions</para> + <informaltable frame="none"> <tgroup cols="2"> <thead> <row> <entry>Descriptions</entry> + <entry>Appearance</entry> </row> </thead> + <tbody> <row> <entry>Warnings</entry> - <entry><caution> + + <entry> + <caution> <para>Don't run with scissors!</para> - </caution></entry> + </caution> + </entry> </row> + <row> <entry>Hint</entry> - <entry><tip> + + <entry> + <tip> <para>Warm jar lids under the hot tap to loosen them.</para> - </tip></entry> + </tip> + </entry> </row> + <row> <entry>Notes</entry> - <entry><note> + + <entry> + <note> <para>Dear John...</para> - </note></entry> + </note> + </entry> </row> + <row> <entry>Information requiring special attention</entry> - <entry><warning> + + <entry> + <warning> <para>Read this or the cat gets it.</para> - </warning></entry> + </warning> + </entry> </row> + <row> <entry>File Names</entry> - <entry><filename>file.extension</filename></entry> + + <entry> + <filename>file.extension</filename> + </entry> </row> + <row> <entry>Directory Names</entry> - <entry><filename class="directory">directory</filename></entry> + + <entry> + <filename class="directory">directory</filename> + </entry> </row> + <row> <entry>Commands to be typed</entry> - <entry><command>command</command></entry> + + <entry> + <command>command</command> + </entry> </row> + <row> <entry>Applications Names</entry> - <entry><application>application</application></entry> + + <entry> + <application>application</application> + </entry> </row> + <row> - <entry><foreignphrase>Prompt</foreignphrase> of users command under bash shell</entry> + <entry> + <foreignphrase>Prompt</foreignphrase> + + of users command under bash shell</entry> + <entry>bash$</entry> </row> + <row> - <entry><foreignphrase>Prompt</foreignphrase> of root users command under bash shell</entry> + <entry> + <foreignphrase>Prompt</foreignphrase> + + of root users command under bash shell</entry> + <entry>bash#</entry> </row> - <row> - <entry><foreignphrase>Prompt</foreignphrase> of user command under tcsh shell</entry> - <entry>tcsh$</entry> - </row> + + <row> + <entry> + <foreignphrase>Prompt</foreignphrase> + + of user command under tcsh shell</entry> + + <entry>tcsh$</entry> + </row> + <row> <entry>Environment Variables</entry> - <entry><envar>VARIABLE</envar></entry> + + <entry> + <envar>VARIABLE</envar> + </entry> </row> + <row> <entry>Emphasized word</entry> - <entry><emphasis>word</emphasis></entry> + + <entry> + <emphasis>word</emphasis> + </entry> </row> + <row> <entry>Code Example</entry> - <entry><programlisting><sgmltag class="starttag">para</sgmltag>Beginning and end of paragraph<sgmltag class="endtag">para</sgmltag></programlisting></entry> + + <entry> + <programlisting> + <sgmltag class="starttag">para</sgmltag> + + Beginning and end of paragraph + <sgmltag class="endtag">para</sgmltag> + </programlisting> + </entry> </row> </tbody> </tgroup> </informaltable> - </section> - - - - <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -114,3 +171,4 @@ sgml-shorttag:t sgml-tag-region-if-active:t End: --> + diff --git a/docs/en/xml/gfdl.xml b/docs/en/xml/gfdl.xml index 1d84d1255..d9e18de38 100644 --- a/docs/en/xml/gfdl.xml +++ b/docs/en/xml/gfdl.xml @@ -4,7 +4,7 @@ <!-- - GNU Project - Free Software Foundation (FSF) --> <!-- LINK REV="made" HREF="mailto:webmasters@gnu.org" --> -<!-- section> +<!-- sect1> <title>GNU Free Documentation License</title --> <para>Version 1.1, March 2000</para> @@ -15,8 +15,8 @@ not allowed.</para> </blockquote> - <section label="0" id="gfdl-0"> - <title>Preamble</title> + <sect1 label="0" id="gfdl-0"> + <title>PREAMBLE</title> <para>The purpose of this License is to make a manual, textbook, or other written document "free" in the sense of freedom: to assure everyone the @@ -38,10 +38,10 @@ can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.</para> - </section> + </sect1> - <section label="1" id="gfdl-1"> - <title>Applicability and Definition</title> + <sect1 label="1" id="gfdl-1"> + <title>APPLICABILITY AND DEFINITIONS</title> <para>This License applies to any manual or other work that contains a notice placed by the copyright holder saying it can be distributed under @@ -98,10 +98,10 @@ which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work's title, preceding the beginning of the body of the text.</para> - </section> + </sect1> - <section label="2" id="gfdl-2"> - <title>Verbatim Copying</title> + <sect1 label="2" id="gfdl-2"> + <title>VERBATIM COPYING</title> <para>You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the @@ -115,10 +115,10 @@ <para>You may also lend copies, under the same conditions stated above, and you may publicly display copies.</para> - </section> + </sect1> - <section label="3" id="gfdl-3"> - <title>Copying in Quantity</title> + <sect1 label="3" id="gfdl-3"> + <title>COPYING IN QUANTITY</title> <para>If you publish printed copies of the Document numbering more than 100, and the Document's license notice requires Cover Texts, you must @@ -154,10 +154,10 @@ the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.</para> - </section> + </sect1> - <section label="4" id="gfdl-4"> - <title>Modifications</title> + <sect1 label="4" id="gfdl-4"> + <title>MODIFICATIONS</title> <para>You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release @@ -284,10 +284,10 @@ <para>The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.</para> - </section> + </sect1> - <section label="5" id="gfdl-5"> - <title>Combining Documents</title> + <sect1 label="5" id="gfdl-5"> + <title>COMBINING DOCUMENTS</title> <para>You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified @@ -310,10 +310,10 @@ "History"; likewise combine any sections entitled "Acknowledgements", and any sections entitled "Dedications". You must delete all sections entitled "Endorsements."</para> - </section> + </sect1> - <section label="6" id="gfdl-6"> - <title>Collections of Documents</title> + <sect1 label="6" id="gfdl-6"> + <title>COLLECTIONS OF DOCUMENTS</title> <para>You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies @@ -326,10 +326,10 @@ distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.</para> - </section> + </sect1> - <section label="7" id="gfdl-7"> - <title>Aggregation with Independent Works</title> + <sect1 label="7" id="gfdl-7"> + <title>AGGREGATION WITH INDEPENDENT WORKS</title> <para>A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a @@ -345,10 +345,10 @@ the entire aggregate, the Document's Cover Texts may be placed on covers that surround only the Document within the aggregate. Otherwise they must appear on covers around the whole aggregate.</para> - </section> + </sect1> - <section label="8" id="gfdl-8"> - <title>Translation</title> + <sect1 label="8" id="gfdl-8"> + <title>TRANSLATION</title> <para>Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. @@ -360,10 +360,10 @@ License. In case of a disagreement between the translation and the original English version of this License, the original English version will prevail.</para> - </section> + </sect1> - <section label="9" id="gfdl-9"> - <title>Termination</title> + <sect1 label="9" id="gfdl-9"> + <title>TERMINATION</title> <para>You may not copy, modify, sublicense, or distribute the Document except as expressly provided for under this License. Any other attempt to @@ -372,16 +372,19 @@ who have received copies, or rights, from you under this License will not have their licenses terminated so long as such parties remain in full compliance.</para> - </section> + </sect1> - <section label="10" id="gfdl-10"> - <title>Future Revisions of this License</title> + <sect1 label="10" id="gfdl-10"> + <title>FUTURE REVISIONS OF THIS LICENSE</title> <para>The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See - <ulink url="http://www.gnu.org/copyleft/"/>.</para> + <ulink url="http://www.gnu.org/copyleft/"> + http://www.gnu.org/copyleft/</ulink> + + .</para> <para>Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of @@ -391,9 +394,9 @@ Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation.</para> - </section> + </sect1> - <section label="" id="gfdl-howto"> + <sect1 label="" id="gfdl-howto"> <title>How to use this License for your documents</title> <para>To use this License in a document you have written, include a copy @@ -419,7 +422,7 @@ recommend releasing these examples in parallel under your choice of free software license, such as the GNU General Public License, to permit their use in free software.</para> - </section> + </sect1> </appendix> <!-- Keep this comment at the end of the file @@ -437,7 +440,7 @@ sgml-local-ecat-files:nil sgml-minimize-attributes:nil sgml-namecase-general:t sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") sgml-shorttag:t sgml-tag-region-if-active:t End: diff --git a/docs/en/xml/glossary.xml b/docs/en/xml/glossary.xml index 3893094c0..3e40df58a 100644 --- a/docs/en/xml/glossary.xml +++ b/docs/en/xml/glossary.xml @@ -15,7 +15,10 @@ to keep secret files which would otherwise compromise your installation - e.g. the <filename>localconfig</filename> - file contains the password to your database. + + file contains the password to your database. If this information were + generally available, and remote access to your database turned on, + you risk corruption of your database by computer criminals or the curious.</para> </glossdef> </glossentry> @@ -24,66 +27,23 @@ <glossdiv id="gloss-a"> <title>A</title> - <glossentry id="gloss-apache"> + <glossentry> <glossterm>Apache</glossterm> <glossdef> <para>In this context, Apache is the web server most commonly used - for serving up Bugzilla + for serving up + <glossterm>Bugzilla</glossterm> + pages. Contrary to popular belief, the apache web server has nothing to do with the ancient and noble Native American tribe, but instead derived its name from the fact that it was <quote>a patchy</quote> + version of the original <acronym>NCSA</acronym> - world-wide-web server.</para> - <variablelist> - <title>Useful Directives when configuring Bugzilla</title> - - <varlistentry> - <term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#addhandler">AddHandler</ulink></computeroutput></term> - <listitem> - <para>Tell Apache that it's OK to run CGI scripts.</para> - </listitem> - </varlistentry> - <varlistentry> - <term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#allowoverride">AllowOverride</ulink></computeroutput></term> - <term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#options">Options</ulink></computeroutput></term> - <listitem> - <para>These directives are used to tell Apache many things about - the directory they apply to. For Bugzilla's purposes, we need - them to allow script execution and <filename>.htaccess</filename> - overrides. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/mod_dir.html#directoryindex">DirectoryIndex</ulink></computeroutput></term> - <listitem> - <para>Used to tell Apache what files are indexes. If you can - not add <filename>index.cgi</filename> to the list of valid files, - you'll need to set <computeroutput>$index_html</computeroutput> to - 1 in <filename>localconfig</filename> so - <command>./checksetup.pl</command> will create an - <filename>index.html</filename> that redirects to - <filename>index.cgi</filename>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><computeroutput><ulink url="http://httpd.apache.org/docs-2.0/mod/core.html#scriptinterpretersource">ScriptInterpreterSource</ulink></computeroutput></term> - <listitem> - <para>Used when running Apache on windows so the shebang line - doesn't have to be changed in every Bugzilla script. - </para> - </listitem> - </varlistentry> - </variablelist> - - <para>For more information about how to configure Apache for Bugzilla, - see <xref linkend="http-apache"/>. - </para> + world-wide-web server.</para> </glossdef> </glossentry> </glossdiv> @@ -96,7 +56,7 @@ <glossdef> <para>A - <quote>bug</quote> + <quote>Bug</quote> in Bugzilla refers to an issue entered into the database which has an associated number, assignments, comments, etc. Some also refer to a @@ -111,36 +71,40 @@ <glossterm>Bug Number</glossterm> <glossdef> - <para>Each Bugzilla bug is assigned a number that uniquely identifies - that bug. The bug associated with a bug number can be pulled up via a + <para>Each Bugzilla Bug is assigned a number that uniquely identifies + that Bug. The Bug associated with a Bug Number can be pulled up via a query, or easily from the very front page by typing the number in the "Find" box.</para> </glossdef> </glossentry> - <glossentry id="gloss-bugzilla"> - <glossterm>Bugzilla</glossterm> + <glossentry> + <glossterm>Bug Life Cycle</glossterm> <glossdef> - <para>Bugzilla is the world-leading free software bug tracking system. - </para> + <para>A Bug has stages through which it must pass before becoming a + <quote>closed bug</quote>, + including acceptance, resolution, and verification. The + <quote>Bug Life Cycle</quote> + + is moderately flexible according to the needs of the organization + using it, though.</para> </glossdef> </glossentry> - </glossdiv> - <glossdiv id="gloss-c"> - <title>C</title> + <glossentry> + <glossterm>Bugzilla</glossterm> - <glossentry id="gloss-cgi"> - <glossterm>Common Gateway Interface</glossterm> - <acronym>CGI</acronym> <glossdef> - <para><acronym>CGI</acronym> is an acronym for Common Gateway Interface. This is - a standard for interfacing an external application with a web server. Bugzilla - is an example of a <acronym>CGI</acronym> application. - </para> + <para>Bugzilla is the industry-standard bug tracking system. It is + quite popular among Open Source enthusiasts.</para> </glossdef> </glossentry> + </glossdiv> + + <glossdiv id="gloss-c"> + <title> + </title> <glossentry id="gloss-component"> <glossterm>Component</glossterm> @@ -154,40 +118,23 @@ </glossentry> <glossentry id="gloss-cpan"> - <glossterm>Comprehensive Perl Archive Network</glossterm> - <acronym>CPAN</acronym> + <glossterm> + <acronym>CPAN</acronym> + </glossterm> - <!-- TODO: Rewrite def for CPAN --> <glossdef> <para> <acronym>CPAN</acronym> stands for the - <quote>Comprehensive Perl Archive Network</quote>. - CPAN maintains a large number of extremely useful - <glossterm>Perl</glossterm> - modules - encapsulated chunks of code for performing a - particular task.</para> - </glossdef> - </glossentry> + <quote>Comprehensive Perl Archive Network</quote> - <glossentry id="gloss-contrib"> - <glossterm><filename class="directory">contrib</filename></glossterm> + . CPAN maintains a large number of extremely useful + <glossterm>Perl</glossterm> - <glossdef> - <para>The <filename class="directory">contrib</filename> directory is - a location to put scripts that have been contributed to Bugzilla but - are not a part of the official distribution. These scripts are written - by third parties and may be in languages other than perl. For those - that are in perl, there may be additional modules or other requirements - than those of the offical distribution. - <note> - <para>Scripts in the <filename class="directory">contrib</filename> - directory are not offically supported by the Bugzilla team and may - break in between versions. - </para> - </note> - </para> + modules. By themselves, Perl modules generally do nothing, but when + used as part of a larger program, they provide much-needed algorithms + and functionality.</para> </glossdef> </glossentry> </glossdiv> @@ -211,9 +158,10 @@ </glossdiv> <glossdiv id="gloss-g"> - <title>G</title> + <title> + </title> - <glossentry id="gloss-groups"> + <glossentry> <glossterm>Groups</glossterm> <glossdef> @@ -221,24 +169,29 @@ <quote>Groups</quote> has a very special meaning to Bugzilla. Bugzilla's main security - mechanism comes by placing users in groups, and assigning those - groups certain privileges to view bugs in particular + mechanism comes by lumping users into groups, and assigning those + groups certain privileges to <glossterm>Products</glossterm> + + and + <glossterm>Components</glossterm> + in the <glossterm>Bugzilla</glossterm> + database.</para> </glossdef> </glossentry> </glossdiv> - <glossdiv id="gloss-j"> - <title>J</title> + <glossdiv id="gloss-i"> + <title>I</title> + + <glossentry id="gloss-infiniteloop"> + <glossterm>Infinite Loop</glossterm> - <glossentry id="gloss-javascript"> - <glossterm>JavaScript</glossterm> <glossdef> - <para>JavaScript is cool, we should talk about it. - </para> + <para>A loop of information that never ends; see recursion.</para> </glossdef> </glossentry> </glossdiv> @@ -246,56 +199,17 @@ <glossdiv id="gloss-m"> <title>M</title> - <glossentry id="gloss-mta"> - <glossterm>Message Transport Agent</glossterm> - <acronym>MTA</acronym> + <glossentry> + <glossterm>mysqld</glossterm> <glossdef> - <para>A Message Transport Agent is used to control the flow of email - on a system. Many unix based systems use - <ulink url="http://www.sendmail.org">sendmail</ulink> which is what - Bugzilla expects to find by default at <filename>/usr/sbin/sendmail</filename>. - Many other MTA's will work, but they all require that the - <option>sendmailnow</option> param be set to <literal>on</literal>. - </para> - </glossdef> - </glossentry> - - <glossentry id="gloss-mysql"> - <glossterm>MySQL</glossterm> + <para>mysqld is the name of the + <glossterm>daemon</glossterm> - <glossdef> - <para>MySQL is currently the required - <glossterm linkend="gloss-rdbms">RDBMS</glossterm> for Bugzilla. MySQL - can be downloaded from <ulink url="http://www.mysql.com"/>. While you - should familiarize yourself with all of the documentation, some high - points are: - </para> - <variablelist> - <varlistentry> - <term><ulink url="http://www.mysql.com/doc/en/Backup.html">Backup</ulink></term> - <listitem> - <para>Methods for backing up your Bugzilla database. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://www.mysql.com/doc/en/Option_files.html">Option Files</ulink></term> - <listitem> - <para>Information about how to configure MySQL using - <filename>my.cnf</filename>. - </para> - </listitem> - </varlistentry> - <varlistentry> - <term><ulink url="http://www.mysql.com/doc/en/Privilege_system.html">Privilege System</ulink></term> - <listitem> - <para>Much more detailed information about the suggestions in - <xref linkend="security-mysql"/>. - </para> - </listitem> - </varlistentry> - </variablelist> + for the MySQL database. In general, it is invoked automatically + through the use of the System V init scripts on GNU/Linux and + AT&T System V-based systems, such as Solaris and HP/UX, or + through the RC scripts on BSD-based systems.</para> </glossdef> </glossentry> </glossdiv> @@ -303,25 +217,14 @@ <glossdiv id="gloss-p"> <title>P</title> - <glossentry id="gloss-ppm"> - <glossterm>Perl Package Manager</glossterm> - <acronym>PPM</acronym> - - <glossdef> - <para><ulink url="http://aspn.activestate.com/ASPN/Downloads/ActivePerl/PPM/"/> - </para> - </glossdef> - </glossentry> - <glossentry> <glossterm id="gloss-product">Product</glossterm> <glossdef> - <para>A Product is a broad category of types of bugs, normally - representing a single piece of software or entity. In general, - there are several Components to a Product. A Product may define a + <para>A Product is a broad category of types of bugs. In general, + there are several Components to a Product. A Product may also define a group (used for security) for all bugs entered into - its Components.</para> + components beneath it.</para> </glossdef> </glossentry> @@ -359,7 +262,7 @@ bugs over their life cycle, thus the need for the <quote>QA Contact</quote> - field in a bug.</para> + field in a Bug.</para> </glossdef> </glossentry> </glossdiv> @@ -367,25 +270,16 @@ <glossdiv id="gloss-r"> <title>R</title> - <glossentry id="gloss-rdbms"> - <glossterm>Relational DataBase Managment System</glossterm> - <acronym>RDBMS</acronym> - - <glossdef> - <para>A relational database management system is a database system - that stores information in tables that are related to each other. - </para> - </glossdef> - </glossentry> - - <glossentry id="gloss-regexp"> - <glossterm>Regular Expression</glossterm> - <acronym>regexp</acronym> + <glossentry id="gloss-recursion" xreflabel="Recursion"> + <glossterm>Recursion</glossterm> <glossdef> - <para>A regular expression is an expression used for pattern matching. - <ulink url="http://perldoc.com/perl5.6/pod/perlre.html#Regular-Expressions">Documentation</ulink> - </para> + <para>The property of a function looking back at itself for + something. + <quote>GNU</quote>, for instance, stands for + <quote>GNU's Not UNIX</quote>, + thus recursing upon itself for definition. For further clarity, see + Infinite Loop.</para> </glossdef> </glossentry> </glossdiv> @@ -450,51 +344,18 @@ fixed, or an enhancement will be implemented.</para> </glossdef> </glossentry> - - <glossentry id="gloss-tcl"> - <glossterm>Tool Command Language</glossterm> - <acronym>TCL</acronym> - <glossdef> - <para>TCL is an open source scripting language available for Windows, - Macintosh, and Unix based systems. Bugzilla 1.0 was written in TCL but - never released. The first release of Bugzilla was 2.0, which was when - it was ported to perl. - </para> - </glossdef> - </glossentry> </glossdiv> <glossdiv id="gloss-z"> <title>Z</title> - <glossentry id="gloss-zarro"> + <glossentry id="zarro-boogs-found" xreflabel="Zarro Boogs Found"> <glossterm>Zarro Boogs Found</glossterm> <glossdef> - <para>This is just a goofy way of saying that there were no bugs - found matching your query. When asked to explain this message, - Terry had the following to say: - </para> - - <blockquote> - <attribution>Terry Weissman</attribution> - <para>I've been asked to explain this ... way back when, when - Netscape released version 4.0 of its browser, we had a release - party. Naturally, there had been a big push to try and fix every - known bug before the release. Naturally, that hadn't actually - happened. (This is not unique to Netscape or to 4.0; the same thing - has happened with every software project I've ever seen.) Anyway, - at the release party, T-shirts were handed out that said something - like "Netscape 4.0: Zarro Boogs". Just like the software, the - T-shirt had no known bugs. Uh-huh. - </para> - - <para>So, when you query for a list of bugs, and it gets no results, - you can think of this as a friendly reminder. Of *course* there are - bugs matching your query, they just aren't in the bugsystem yet... - </para> - </blockquote> - + <para>This is the cryptic response sent by Bugzilla when a query + returned no results. It is just a goofy way of saying "Zero Bugs + Found".</para> </glossdef> </glossentry> </glossdiv> @@ -515,7 +376,7 @@ sgml-local-ecat-files:nil sgml-minimize-attributes:nil sgml-namecase-general:t sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") sgml-shorttag:t sgml-tag-region-if-active:t End: diff --git a/docs/en/xml/index.xml b/docs/en/xml/index.xml index 7fc1a4c14..3b3516e14 100644 --- a/docs/en/xml/index.xml +++ b/docs/en/xml/index.xml @@ -13,7 +13,7 @@ sgml-local-ecat-files:nil sgml-minimize-attributes:nil sgml-namecase-general:t sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") sgml-shorttag:t sgml-tag-region-if-active:t End: diff --git a/docs/en/xml/integration.xml b/docs/en/xml/integration.xml index 598baffca..e801847d6 100644 --- a/docs/en/xml/integration.xml +++ b/docs/en/xml/integration.xml @@ -1,6 +1,6 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > --> <!-- Keep these tools listings in alphabetical order please. -MPB --> -<section id="integration"> +<chapter id="integration"> <title>Integrating Bugzilla with Third-Party Tools</title> <section id="bonsai" @@ -13,31 +13,43 @@ . Using Bonsai, administrators can control open/closed status of trees, query a fast relational database back-end for change, branch, and comment information, and view changes made since the last time the tree was - closed. Bonsai - also integrates with - <xref linkend="tinderbox" />. - </para> + closed. These kinds of changes cause the engineer responsible to be + <quote>on the hook</quote> + + (include cool URL link here for Hook policies at mozilla.org). Bonsai + also includes gateways to + <xref linkend="tinderbox" /> + + and Bugzilla</para> </section> <section id="cvs" xreflabel="CVS, the Concurrent Versioning System"> <title>CVS</title> <para>CVS integration is best accomplished, at this point, using the - Bugzilla Email Gateway.</para> + Bugzilla Email Gateway. There have been some files submitted to allow + greater CVS integration, but we need to make certain that Bugzilla is not + tied into one particular software management package.</para> - <para>Follow the instructions in this Guide for enabling Bugzilla e-mail + <para>Follow the instructions in the FAQ for enabling Bugzilla e-mail integration. Ensure that your check-in script sends an email to your Bugzilla e-mail gateway with the subject of - <quote>[Bug XXXX]</quote>, - and you can have CVS check-in comments append to your Bugzilla bug. If - you want to have the bug be closed automatically, you'll have to modify - the <filename>contrib/bugzilla_email_append.pl</filename> script. - </para> - - <para>There is also a CVSZilla project, based upon somewhat dated - Bugzilla code, to integrate CVS and Bugzilla through CVS' ability to - email. Check it out at: <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/"/>. - </para> + <quote>[Bug XXXX]</quote> + + , and you can have CVS check-in comments append to your Bugzilla bug. If + you have your check-in script include an @resolution field, you can even + change the Bugzilla bug state.</para> + + <para>There is also a project, based upon somewhat dated Bugzilla code, + to integrate CVS and Bugzilla through CVS' ability to email. Check it out + at: + <ulink url="http://homepages.kcbbs.gen.nz/~tonyg/"> + http://homepages.kcbbs.gen.nz/~tonyg/</ulink> + + , under the + <quote>cvszilla</quote> + + link.</para> </section> <section id="scm" @@ -47,14 +59,16 @@ <para>You can find the project page for Bugzilla and Teamtrack Perforce integration (p4dti) at: - <ulink url="http://www.ravenbrook.com/project/p4dti/"/> + <ulink url="http://www.ravenbrook.com/project/p4dti/"> + http://www.ravenbrook.com/project/p4dti</ulink> . <quote>p4dti</quote> is now an officially supported product from Perforce, and you can find the "Perforce Public Depot" p4dti page at - <ulink url="http://public.perforce.com/public/perforce/p4dti/index.html"/> + <ulink url="http://public.perforce.com/public/perforce/p4dti/index.html"> + http://public.perforce.com/public/perforce/p4dti/index.html</ulink> .</para> @@ -70,14 +84,9 @@ xreflabel="Tinderbox, the Mozilla automated build management system"> <title>Tinderbox/Tinderbox2</title> - <para>Tinderbox is a continuous-build system which can integrate with - Bugzilla - see - <ulink url="http://www.mozilla.org/projects/tinderbox"/> for details - of Tinderbox, and - <ulink url="http://tinderbox.mozilla.org/showbuilds.cgi"/> to see it - in action.</para> + <para>We need Tinderbox integration information.</para> </section> -</section> +</chapter> <!-- Keep this comment at the end of the file Local variables: @@ -94,7 +103,7 @@ sgml-local-ecat-files:nil sgml-minimize-attributes:nil sgml-namecase-general:t sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") sgml-shorttag:t sgml-tag-region-if-active:t End: diff --git a/docs/en/xml/patches.xml b/docs/en/xml/patches.xml index 6b755cbce..540109feb 100644 --- a/docs/en/xml/patches.xml +++ b/docs/en/xml/patches.xml @@ -1,42 +1,185 @@ -<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> +<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> <appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla"> - <title>Contrib</title> + <title>Useful Patches and Utilities for Bugzilla</title> - <para>There are a number of unofficial Bugzilla add-ons in the - <filename class="directory">$BUGZILLA_ROOT/contrib/</filename> - directory. This section documents them.</para> + <para>Are you looking for a way to put your Bugzilla into overdrive? Catch + some of the niftiest tricks here in this section.</para> + + <section id="rewrite" xreflabel="Apache mod_rewrite magic"> + <title>Apache + <filename>mod_rewrite</filename> + + magic</title> + + <para>Apache's + <filename>mod_rewrite</filename> + + module lets you do some truly amazing things with URL rewriting. Here are + a couple of examples of what you can do.</para> + + <orderedlist> + <listitem> + <para>Make it so if someone types + <computeroutput>http://www.foo.com/12345</computeroutput> + + , Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try + setting up your VirtualHost section for Bugzilla with a rule like + this:</para> + + <programlisting> +<![CDATA[ +<VirtualHost 12.34.56.78> +RewriteEngine On +RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] +</VirtualHost> +]]> + </programlisting> + </listitem> + + <listitem> + <para>There are many, many more things you can do with mod_rewrite. + As time goes on, I will include many more in the Guide. For now, + though, please refer to the mod_rewrite documentation at + <ulink url="http://www.apache.org">http://www.apache.org</ulink> + </para> + </listitem> + </orderedlist> + </section> + + <section id="setperl" xreflabel="The setperl.csh Utility"> + <title>The setperl.csh Utility</title> + + <para>You can use the "setperl.csh" utility to quickly and easily change + the path to perl on all your Bugzilla files. This is a C-shell script; if + you do not have "csh" or "tcsh" in the search path on your system, it + will not work!</para> + + <procedure> + <step> + <para>Download the "setperl.csh" utility to your Bugzilla directory + and make it executable.</para> + + <substeps> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>cd /your/path/to/bugzilla</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>wget -O setperl.csh + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>chmod u+x setperl.csh</command> + </computeroutput> + </para> + </step> + </substeps> + </step> + + <step> + <para>Prepare (and fix) Bugzilla file permissions.</para> + + <substeps> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>chmod u+w *</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>chmod u+x duplicates.cgi</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>chmod a-x bug_status.html</command> + </computeroutput> + </para> + </step> + </substeps> + </step> + + <step> + <para>Run the script:</para> + + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>./setperl.csh /your/path/to/perl</command> + </computeroutput> + + <example> + <title>Using Setperl to set your perl path</title> + + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>./setperl.csh /usr/bin/perl</command> + </computeroutput> + </para> + </example> + </para> + </step> + </procedure> + </section> <section id="cmdline"> - <title>Command-line Search Interface</title> - - <para>There are a suite of Unix utilities for searching Bugzilla from the - command line. They live in the - <filename class="directory">contrib/cmdline</filename> - directory. However, they - have not yet been updated to work with 2.16 (post-templatisation.). - There are three files - <filename>query.conf</filename>, - <filename>buglist</filename> and <filename>bugs</filename>.</para> - - <para><filename>query.conf</filename> - contains the mapping from options to field + <title>Command-line Bugzilla Queries</title> + + <para>Users can query Bugzilla from the command line using this suite of + utilities.</para> + + <para>The query.conf file contains the mapping from options to field names and comparison types. Quoted option names are "grepped" for, so it should be easy to edit this file. Comments (#) have no effect; you must - make sure these lines do not contain any quoted "option".</para> + make sure these lines do not contain any quoted "option"</para> - <para><filename>buglist</filename> - is a shell script which submits a Bugzilla query and writes + <para>buglist is a shell script which submits a Bugzilla query and writes the resulting HTML page to stdout. It supports both short options, (such as "-Afoo" or "-Rbar") and long options (such as "--assignedto=foo" or "--reporter=bar"). If the first character of an option is not "-", it is treated as if it were prefixed with "--default=".</para> - <para>The column list is taken from the COLUMNLIST environment variable. + <para>The columlist is taken from the COLUMNLIST environment variable. This is equivalent to the "Change Columns" option when you list bugs in - buglist.cgi. If you have already used Bugzilla, grep for COLUMNLIST - in your cookies file to see your current COLUMNLIST setting.</para> + buglist.cgi. If you have already used Bugzilla, use + <command>grep COLUMLIST ~/.netscape/cookies</command> - <para><filename>bugs</filename> is a simple shell script which calls - <filename>buglist</filename> and extracts the + to see your current COLUMNLIST setting.</para> + + <para>bugs is a simple shell script which calls buglist and extracts the bug numbers from the output. Adding the prefix "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list into a working link if any bugs are found. Counting bugs is easy. Pipe the @@ -44,13 +187,100 @@ <command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command> </para> - <para>Akkana Peck says she has good results piping - <filename>buglist</filename> output through + <para>Akkana says she has good results piping buglist output through <command>w3m -T text/html -dump</command> </para> + <procedure> + <step> + <para>Download three files:</para> + + <substeps> + <step> + <para> + <computeroutput> + <prompt>bash$</prompt> + + <command>wget -O query.conf + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>bash$</prompt> + + <command>wget -O buglist + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> + </computeroutput> + </para> + </step> + + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + + <command>wget -O bugs + 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> + </computeroutput> + </para> + </step> + </substeps> + </step> + + <step> + <para>Make your utilities executable: + <computeroutput> + <prompt>bash$</prompt> + + <command>chmod u+x buglist bugs</command> + </computeroutput> + </para> + </step> + </procedure> </section> + <section id="quicksearch"> + <title>The Quicksearch Utility</title> + + <para>Quicksearch is a new, experimental feature of the 2.12 release. It + consist of two Javascript files, "quicksearch.js" and "localconfig.js", + and two documentation files, "quicksearch.html" and + "quicksearchhack.html"</para> + + <para>The index.html page has been updated to include the QuickSearch + text box.</para> + + <para>To take full advantage of the query power, the Bugzilla maintainer + must edit "localconfig.js" according to the value sets used in the local + installation.</para> + + <para>Currently, keywords must be hard-coded in localconfig.js. If they + are not, keywords are not automatically recognized. This means, if + localconfig.js is left unconfigured, that searching for a bug with the + "foo" keyword will only find bugs with "foo" in the summary, status + whiteboard, product or component name, but not those with the keyword + "foo".</para> + + <para>Workarounds for Bugzilla users: + <simplelist> + <member>search for '!foo' (this will find only bugs with the keyword + "foo"</member> + + <member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member> + </simplelist> + </para> + + <para>When this tool is ported from client-side JavaScript to server-side + Perl, the requirement for hard-coding keywords can be fixed. + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This + bug</ulink> + + has details.</para> + </section> </appendix> <!-- Keep this comment at the end of the file @@ -68,7 +298,7 @@ sgml-local-ecat-files:nil sgml-minimize-attributes:nil sgml-namecase-general:t sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") sgml-shorttag:t sgml-tag-region-if-active:t End: diff --git a/docs/en/xml/requiredsoftware.xml b/docs/en/xml/requiredsoftware.xml index 8a8c35774..f32f0dc2f 100644 --- a/docs/en/xml/requiredsoftware.xml +++ b/docs/en/xml/requiredsoftware.xml @@ -6,52 +6,59 @@ stay current for a while.</para> <para>Apache Web Server: - <ulink url="http://www.apache.org/"/> + <ulink url="http://www.apache.org/">http://www.apache.org</ulink> Optional web server for Bugzilla, but recommended because of broad user base and support.</para> <para>Bugzilla: - <ulink url="http://www.bugzilla.org/"/> + <ulink url="http://www.bugzilla.org/"> + http://www.bugzilla.org/</ulink> </para> <para>MySQL: - <ulink url="http://www.mysql.com/"/> + <ulink url="http://www.mysql.com/">http://www.mysql.com/</ulink> </para> <para>Perl: - <ulink url="http://www.perl.org/"/> + <ulink url="http://www.perl.org">http://www.perl.org/</ulink> </para> <para>CPAN: - <ulink url="http://www.cpan.org/"/> + <ulink url="http://www.cpan.org/">http://www.cpan.org/</ulink> </para> <para>DBI Perl module: - <ulink url="http://www.cpan.org/modules/by-module/DBI/"/> + <ulink url="http://www.cpan.org/modules/by-module/DBI/"> + http://www.cpan.org/modules/by-module/DBI/</ulink> </para> <para>Data::Dumper module: - <ulink url="http://www.cpan.org/modules/by-module/Data/"/> + <ulink url="http://www.cpan.org/modules/by-module/Data/"> + http://www.cpan.org/modules/by-module/Data/</ulink> </para> <para>MySQL related Perl modules: - <ulink url="http://www.cpan.org/modules/by-module/Mysql/"/> + <ulink url="http://www.cpan.org/modules/by-module/Mysql/"> + http://www.cpan.org/modules/by-module/Mysql/</ulink> </para> <para>TimeDate Perl module collection: - <ulink url="http://www.cpan.org/modules/by-module/Date/"/> + <ulink url="http://www.cpan.org/modules/by-module/Date/"> + http://www.cpan.org/modules/by-module/Date/</ulink> </para> <para>GD Perl module: - <ulink url="http://www.cpan.org/modules/by-module/GD/"/> + <ulink url="http://www.cpan.org/modules/by-module/GD/"> + http://www.cpan.org/modules/by-module/GD/</ulink> Alternately, you should be able to find the latest version of GD at - <ulink url="http://www.boutell.com/gd/"/> + <ulink url="http://www.boutell.com/gd/">http://www.boutell.com/gd/</ulink> </para> <para>Chart::Base module: - <ulink url="http://www.cpan.org/modules/by-module/Chart/"/> + <ulink url="http://www.cpan.org/modules/by-module/Chart/"> + http://www.cpan.org/modules/by-module/Chart/</ulink> </para> <para>(But remember, Bundle::Bugzilla will install all the modules for you.) @@ -73,7 +80,7 @@ sgml-local-ecat-files:nil sgml-minimize-attributes:nil sgml-namecase-general:t sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") +sgml-parent-document:("Bugzilla-Guide.sgml" "book" "chapter") sgml-shorttag:t sgml-tag-region-if-active:t End: diff --git a/docs/en/xml/using.xml b/docs/en/xml/using.xml index 892961729..b447ef9c0 100644 --- a/docs/en/xml/using.xml +++ b/docs/en/xml/using.xml @@ -1,5 +1,4 @@ <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> - <!-- TOC Chapter: Using Bugzilla Create an account @@ -26,668 +25,611 @@ Chapter: Using Bugzilla Miscellaneous usage hints --> - <chapter id="using"> -<title>Using Bugzilla</title> - <epigraph> - <para> - What, Why, How, & Where? - </para> - </epigraph> + <title>Using Bugzilla</title> <section id="whatis"> <title>What is Bugzilla?</title> - <para> - 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 by -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. - </para> - <para> - Bugzilla has matured immensely, and now boasts many advanced features. These include: - <itemizedlist> - -<listitem><para>Powerful searching</para></listitem> -<listitem><para>User-configurable email notifications of bug changes</para></listitem> -<listitem><para>Full change history</para></listitem> -<listitem><para>Inter-bug dependency tracking and graphing</para></listitem> -<listitem><para>Excellent attachment management</para></listitem> -<listitem><para>Integrated, product-based, granular security schema</para></listitem> -<listitem><para>Fully security-audited, and runs under Perl's taint mode</para></listitem> -<listitem><para>A robust, stable RDBMS back-end</para></listitem> -<listitem><para>Web, XML, email and console interfaces</para></listitem> -<listitem><para>Completely customisable and/or localisable web user interface</para></listitem> -<listitem><para>Extensive configurability</para></listitem> -<listitem><para>Smooth upgrade pathway between versions</para></listitem> - - </itemizedlist> + + <para>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 by 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.</para> + + <para>Bugzilla has matured immensely, and now boasts many advanced + features. These include: + <itemizedlist> + <listitem> + <para>Powerful searching</para> + </listitem> + + <listitem> + <para>User-configurable email notifications of bug changes</para> + </listitem> + + <listitem> + <para>Full change history</para> + </listitem> + + <listitem> + <para>Inter-bug dependency tracking and graphing</para> + </listitem> + + <listitem> + <para>Excellent attachment management</para> + </listitem> + + <listitem> + <para>Integrated, product-based, granular security schema</para> + </listitem> + + <listitem> + <para>Fully security-audited, and runs under Perl's taint mode</para> + </listitem> + + <listitem> + <para>A robust, stable RDBMS back-end</para> + </listitem> + + <listitem> + <para>Web, XML, email and console interfaces</para> + </listitem> + + <listitem> + <para>Completely customisable and/or localisable web user + interface</para> + </listitem> + + <listitem> + <para>Extensive configurability</para> + </listitem> + + <listitem> + <para>Smooth upgrade pathway between versions</para> + </listitem> + </itemizedlist> </para> </section> - + <section id="why"> <title>Why Should We Use Bugzilla?</title> - <epigraph> - <para> - No, Who's on first... - </para> - </epigraph> - <para> - 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 - dropped or ignored. - </para> - <para> - 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. - </para> - <para> - But why should <emphasis>you</emphasis> use Bugzilla? - </para> - <para> - 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 - </para> - <para> - 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. - </para> - <para> - 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. - </para> + + <para>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 dropped or ignored.</para> + + <para>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.</para> + + <para>But why should + <emphasis>you</emphasis> + + use Bugzilla?</para> + + <para>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</para> + + <para>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.</para> + + <para>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.</para> </section> - + <section id="how"> <title>How do I use Bugzilla?</title> - <epigraph> - <para> - Hey! I'm Woody! Howdy, Howdy, Howdy! - </para> - </epigraph> - - <para> - This section contains information for end-users of Bugzilla. - If you are administering a Bugzilla installation, please consult the - Installing and Administering Bugzilla portions of this Guide. - </para> - <para> - There is a Bugzilla test installation, called - <ulink url="http://landfill.tequilarista.org/"> - Landfill</ulink>, which you are welcome to play with. - 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. - </para> - + + <para>This section contains information for end-users of Bugzilla. If you + are administering a Bugzilla installation, please consult the Installing + and Administering Bugzilla portions of this Guide.</para> + + <para>There is a Bugzilla test installation, called + <ulink url="http://landfill.tequilarista.org/">Landfill</ulink> + + , which you are welcome to play with. 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.</para> + <section id="myaccount"> <title>Create a Bugzilla Account</title> - <para> - 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: <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/"> http://landfill.tequilarista.org/bugzilla-tip/</ulink> + + <para>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: + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> + http://landfill.tequilarista.org/bugzilla-tip/</ulink> </para> + <orderedlist> - <listitem> - <para> - Click the <quote>Open a new Bugzilla account</quote> link, enter your - email address and, optionally, your name in the spaces provided, - then click <quote>Create Account</quote>. - </para> - </listitem> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - Click the <quote>Log In</quote> 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 - <quote>Login</quote>. - </para> - </listitem> + <listitem> + <para>Click the + <quote>Open a new Bugzilla account</quote> + + link, enter your email address and, optionally, your name in the + spaces provided, then click + <quote>Create Account</quote> + + .</para> + </listitem> + + <listitem> + <para>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.</para> + </listitem> + + <listitem> + <para>Click the + <quote>Log In</quote> + + 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 + <quote>Login</quote> + + .</para> + </listitem> </orderedlist> - <para> - You are now logged in. Bugzilla uses cookies for authentication, so - (unless your IP address changes) you should not have to log in again. - </para> + + <para>You are now logged in. Bugzilla uses cookies for authentication, + so (unless your IP address changes) you should not have to log in + again.</para> </section> - + <section id="bug_page"> <title>Anatomy of a Bug</title> - <para> - The core of Bugzilla is the screen which displays a particular bug. - It's a good place to explain some Bugzilla concepts. - <ulink url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1">Bug 1 on Landfill</ulink> is a good example. Note that the names of most fields - are hyperlinks; clicking them will take you to context-sensitive - help on that particular field. - </para> - - <orderedlist> - <listitem> - <para> - <emphasis>Product and Component</emphasis>: - 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: - <simplelist> - <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>, + + <para>The core of Bugzilla is the screen which displays a particular + bug. It's a good place to explain some Bugzilla concepts. + <ulink + url="http://landfill.tequilarista.org/bugzilla-tip/show_bug.cgi?id=1"> + Bug 1 on Landfill</ulink> + + is a good example. Note that the names of most fields are hyperlinks; + clicking them will take you to context-sensitive help on that + particular field.</para> + + <orderedlist> + <listitem> + <para> + <emphasis>Product and Component</emphasis> + + : 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: + <simplelist> + <member> + <emphasis>Administration:</emphasis> + + Administration of a Bugzilla installation.</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 - - </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>, + multiple components.</member> + + <member> + <emphasis>Creating/Changing Bugs:</emphasis> + + Creating, changing, and viewing bugs.</member> + + <member> + <emphasis>Documentation:</emphasis> + + The Bugzilla documentation, including The Bugzilla Guide.</member> + + <member> + <emphasis>Email:</emphasis> + + Anything to do with email sent by Bugzilla.</member> + + <member> + <emphasis>Installation:</emphasis> + + The installation process of Bugzilla.</member> + + <member> + <emphasis>Query/Buglist:</emphasis> + + Anything to do with searching for bugs and viewing the + buglists.</member> + + <member> + <emphasis>Reporting/Charting:</emphasis> + + Getting reports from Bugzilla.</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>, + 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> - </simplelist> - </para> - </listitem> - - <listitem> - <para> - <emphasis>Status and Resolution</emphasis>: - A bug passes through several Statuses in its lifetime, and ends up in the - RESOLVED status, with one of a set of Resolutions (e.g. FIXED, INVALID.) - The different possible - values for Status and Resolution on your installation will be documented - in the context-sensitive help for those items. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Assigned To</emphasis>: - The person responsible for fixing the bug. - </para> - </listitem> - - <listitem> - <para> - <emphasis>URL</emphasis>: - A URL associated with the bug, if any. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Summary</emphasis>: - A one-sentence summary of the problem. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Status Whiteboard</emphasis>: (a.k.a. Whiteboard) A - free-form text area for adding short notes and tags to a bug. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Keywords</emphasis>: - 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. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Platform and OS</emphasis>: - These indicate the computing environment where the bug was found. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Version</emphasis>: - 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. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Priority</emphasis>: - 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. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Severity</emphasis>: - 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. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Target</emphasis>: - (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. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Reporter</emphasis>: - The person who filed the bug. - </para> - </listitem> - - <listitem> - <para> - <emphasis>CC list</emphasis>: - A list of people who get mail when the bug changes. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Attachments</emphasis>: - You can attach files (e.g. testcases or patches) to bugs. If there are - any attachments, they are listed in this section. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Dependencies</emphasis>: - 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. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Votes</emphasis>: - Whether this bug has any votes. - </para> - </listitem> - - <listitem> - <para> - <emphasis>Additional Comments</emphasis>: - You can add your two cents to the bug discussion here, if you have - something worthwhile to say. - </para> - </listitem> - - </orderedlist> - + functionality) including cosmetic issues, HTML templates, + etc.</member> + </simplelist> + </para> + </listitem> + + <listitem> + <para> + <emphasis>Status and Resolution:</emphasis> + + A bug passes through several Statuses in its lifetime, and ends up + in the RESOLVED status, with one of a set of Resolutions (e.g. + FIXED, INVALID.) The different possible values for Status and + Resolution on your installation will be documented in the + context-sensitive help for those items.</para> + </listitem> + + <listitem> + <para> + <emphasis>Assigned To:</emphasis> + + The person responsible for fixing the bug.</para> + </listitem> + + <listitem> + <para> + <emphasis>URL:</emphasis> + + A URL associated with the bug, if any.</para> + </listitem> + + <listitem> + <para> + <emphasis>Summary:</emphasis> + + A one-sentence summary of the problem.</para> + </listitem> + + <listitem> + <para> + <emphasis>Status Whiteboard:</emphasis> + + (a.k.a. Whiteboard) A free-form text area for adding short notes + and tags to a bug.</para> + </listitem> + + <listitem> + <para> + <emphasis>Keywords:</emphasis> + + 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.</para> + </listitem> + + <listitem> + <para> + <emphasis>Platform and OS:</emphasis> + + These indicate the computing environment where the bug was + found.</para> + </listitem> + + <listitem> + <para> + <emphasis>Version:</emphasis> + + 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.</para> + </listitem> + + <listitem> + <para> + <emphasis>Priority:</emphasis> + + 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.</para> + </listitem> + + <listitem> + <para> + <emphasis>Severity:</emphasis> + + 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.</para> + </listitem> + + <listitem> + <para> + <emphasis>Target:</emphasis> + + (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.</para> + </listitem> + + <listitem> + <para> + <emphasis>Reporter:</emphasis> + + The person who filed the bug.</para> + </listitem> + + <listitem> + <para> + <emphasis>CC list:</emphasis> + + A list of people who get mail when the bug changes.</para> + </listitem> + + <listitem> + <para> + <emphasis>Attachments:</emphasis> + + You can attach files (e.g. testcases or patches) to bugs. If there + are any attachments, they are listed in this section.</para> + </listitem> + + <listitem> + <para> + <emphasis>Dependencies:</emphasis> + + 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.</para> + </listitem> + + <listitem> + <para> + <emphasis>Votes:</emphasis> + + Whether this bug has any votes.</para> + </listitem> + + <listitem> + <para> + <emphasis>Additional Comments:</emphasis> + + You can add your two cents to the bug discussion here, if you have + something worthwhile to say.</para> + </listitem> + </orderedlist> </section> - + <section id="query"> <title>Searching for Bugs</title> - <para> - 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: - <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi"> - landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink>. - </para> - - <para> - 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. - </para> - - <para> - Highly advanced querying is done using Boolean Charts, which have their - own <ulink url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html">context-sensitive help</ulink>. - </para> - + + <para>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: + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi"> + landfill.tequilarista.org/bugzilla-tip/query.cgi</ulink> + + .</para> + + <para>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.</para> + + <para>Highly advanced querying is done using Boolean Charts, which have + their own + <ulink + url="http://landfill.tequilarista.org/bugzilla-tip/booleanchart.html"> + context-sensitive help</ulink> + + .</para> </section> - + <section id="list"> <title>Bug Lists</title> - <para> - 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! - </para> - <para> - 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: - <simplelist> - <member><emphasis>Long Format</emphasis>: this gives you a large page - with a non-editable summary of the fields of each bug.</member> - <member><emphasis>Change Columns</emphasis>: change the bug - attributes which appear in the list.</member> - <member><emphasis>Change several bugs at once</emphasis>: If - your account is sufficiently empowered, you can make the same - change to all the bugs in the list - for example, changing their - owner.</member> - <member><emphasis>Send mail to bug owners</emphasis>: Sends mail - to the owners of all bugs on the list.</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> - </simplelist> + + <para>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!</para> + + <para>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: + <simplelist> + <member> + <emphasis>Long Format:</emphasis> + + this gives you a large page with a non-editable summary of the fields + of each bug.</member> + + <member> + <emphasis>Change Columns:</emphasis> + + change the bug attributes which appear in the list.</member> + + <member> + <emphasis>Change several bugs at once:</emphasis> + + If your account is sufficiently empowered, you can make the same + change to all the bugs in the list - for example, changing their + owner.</member> + + <member> + <emphasis>Send mail to bug owners:</emphasis> + + Sends mail to the owners of all bugs on the list.</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> + </simplelist> </para> </section> - - + <section id="bugreports"> <title>Filing Bugs</title> - <epigraph> - <para>And all this time, I thought we were taking bugs <emphasis>out</emphasis>...</para> - </epigraph> - - <para> - Years of bug writing experience has been distilled for your reading - pleasure into the <ulink url="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html"> - Bug Writing Guidelines</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. - </para> - <para> - The procedure for filing a test bug is as follows: - </para> - - <orderedlist> - <listitem> - <para> - Go to <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/">Landfill</ulink> - in your browser and click - <ulink - url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> Enter a new bug report</ulink>. - </para> - </listitem> - <listitem> - <para> - Select a product - any one will do. - </para> - </listitem> - <listitem> - <para> - 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. - </para> - </listitem> - <listitem> - <para> - Select "Commit" and send in your bug report. - </para> - </listitem> - </orderedlist> - </section> + <para>Years of bug writing experience has been distilled for your + reading pleasure into the + <ulink + url="http://landfill.tequilarista.org/bugzilla-tip/bugwritinghelp.html"> + Bug Writing Guidelines</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.</para> + + <para>The procedure for filing a test bug is as follows:</para> + + <orderedlist> + <listitem> + <para>Go to + <ulink url="http://landfill.tequilarista.org/bugzilla-tip/"> + Landfill</ulink> + + in your browser and click + <ulink + url="http://landfill.tequilarista.org/bugzilla-tip/enter_bug.cgi"> + Enter a new bug report</ulink> + + .</para> + </listitem> + + <listitem> + <para>Select a product - any one will do.</para> + </listitem> + + <listitem> + <para>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.</para> + </listitem> + + <listitem> + <para>Select "Commit" and send in your bug report.</para> + </listitem> + </orderedlist> + </section> </section> <section id="init4me"> - <title>Where can I find my user preferences?</title> - <epigraph> - <para> - Indiana, it feels like we walking on fortune cookies! - </para> - <para> - These ain't fortune cookies, kid... - </para> - </epigraph> - <para> - 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>. - </para> + <title>User Preferences</title> + + <para>You can customise various aspects of Bugzilla, via the "Edit prefs" + link in the page footer, once you have logged in, e.g. to + <ulink + url="http://landfill.tequilarista.org/bugzilla-tip/query.cgi?GoAheadAndLogIn=1"> + Landfill</ulink> + + . The preferences are split into four tabs.</para> + <section id="accountsettings" xreflabel="Account Settings"> <title>Account Settings</title> - <para> - On this page, you can change your basic Account Settings, - 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. - </para> + + <para>On this tab, you can change your basic Account Settings, + including your password, email address and real name. For security + reasons, in order to change anything on this page you must type your + <emphasis>current</emphasis> + + password into the + <quote>Password</quote> + + field. If you attempt to change your email address, a confirmation + email is sent to both the old and new addresses, with a link to use to + confirm the change. This helps to prevent account hijacking.</para> </section> - <section id="emailsettings" > + + <section id="emailsettings"> <title>Email Settings</title> - <section id="notification" xreflabel=""> - <title>Email Notification</title> - <para> - 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.. - </para> - </section> - <section id="newemailtech"> - <title>New Email Technology</title> - <note> - <para> - 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. - </para> - </note> - <para> - 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. - </para> - <para> - 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. - </para> - </section> - <section id="watchsettings"> - <title>"Watching" Users</title> - <note> - <para> - 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". - </para> - </note> - <para> - 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. - </para> - </section> + + <para>On this tab you can reduce or increase the amount of email sent + you from Bugzilla, opting in our out depending on your relationship to + the bug and the change that was made to it. (Note that you can also do + client-side filtering using the X-Bugzilla-Reason header which Bugzilla + adds to all bugmail.)</para> + + <para>By entering user email names, delineated by commas, into the + "Users to watch" text entry box you can receive a copy of all the + bugmail of other users (security settings permitting.) 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.</para> + + <note> + <para>This option may not be available in all Bugzilla installations. + Ask your administrator.</para> + </note> </section> + <section id="footersettings"> <title>Page Footer</title> - <note> - <para> - 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! - </para> - </note> - <para> - 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... - </para> - <tip> - <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> - </tip> + + <para>By default, this page is quite barren. However, if you explore + the Search 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. Once you have a stored query, you can come + here to request that it also be displayed in your page footer.</para> </section> + <section id="permissionsettings"> <title>Permissions</title> - <para> - 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. - </para> - </section> - </section> - <section id="usingbz-conc"> - <title>Using Bugzilla-Conclusion</title> - <para> - 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 - </para> + <para>This is a purely informative page which outlines your current + permissions on this installation of Bugzilla - what product groups you + are in, and whether you can edit bugs or perform various administration + functions.</para> + </section> </section> </chapter> - <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -708,3 +650,4 @@ sgml-shorttag:t sgml-tag-region-if-active:t End: --> + |