Skip to content

bugzilla
bugzilla
Commit 96a0037a authored by gerv%gerv.net's avatar gerv%gerv.net
Browse files
Options

Another pre-2.17.7 rev.

parent cb5afb1e
Hide whitespace changes
Inline Side-by-side
Showing with 1200 additions and 1334 deletions
docs/html/Bugzilla-Guide.html
View file @ 96a0037a
...@@ -155,46 +155,51 @@ HREF="#using" ...@@ -155,46 +155,51 @@ HREF="#using"
><DL ><DL
><DT ><DT
>3.1. <A >3.1. <A
HREF="#using-intro"
>Introduction</A
></DT
><DT
>3.2. <A
HREF="#myaccount" HREF="#myaccount"
>Create a Bugzilla Account</A >Create a Bugzilla Account</A
></DT ></DT
><DT ><DT
>3.2. <A >3.3. <A
HREF="#bug_page" HREF="#bug_page"
>Anatomy of a Bug</A >Anatomy of a Bug</A
></DT ></DT
><DT ><DT
>3.3. <A >3.4. <A
HREF="#query" HREF="#query"
>Searching for Bugs</A >Searching for Bugs</A
></DT ></DT
><DT ><DT
>3.4. <A >3.5. <A
HREF="#list" HREF="#list"
>Bug Lists</A >Bug Lists</A
></DT ></DT
><DT ><DT
>3.5. <A >3.6. <A
HREF="#bugreports" HREF="#bugreports"
>Filing Bugs</A >Filing Bugs</A
></DT ></DT
><DT ><DT
>3.6. <A >3.7. <A
HREF="#patchviewer" HREF="#patchviewer"
>Patch Viewer</A >Patch Viewer</A
></DT ></DT
><DT ><DT
>3.7. <A >3.8. <A
HREF="#hintsandtips" HREF="#hintsandtips"
>Hints and Tips</A >Hints and Tips</A
></DT ></DT
><DT ><DT
>3.8. <A >3.9. <A
HREF="#userpreferences" HREF="#userpreferences"
>User Preferences</A >User Preferences</A
></DT ></DT
><DT ><DT
>3.9. <A >3.10. <A
HREF="#reporting" HREF="#reporting"
>Reports</A >Reports</A
></DT ></DT
...@@ -598,25 +603,23 @@ NAME="newversions" ...@@ -598,25 +603,23 @@ NAME="newversions"
</P </P
><P ><P
>&#13; The newest version of this guide can always be found at <A >&#13; The latest version of this guide can always be found at <A
HREF="http://www.bugzilla.org" HREF="http://www.bugzilla.org"
TARGET="_top" TARGET="_top"
>http://www.bugzilla.org</A >http://www.bugzilla.org</A
>; however, you should read the version >, or checked out via CVS.
which came with the Bugzilla release you are using. (Please follow the <A
</P
><P
>&#13; The latest version of this document can always be checked out via CVS.
Please follow the <A
HREF="http://www.mozilla.org/cvs.html" HREF="http://www.mozilla.org/cvs.html"
TARGET="_top" TARGET="_top"
>Mozilla CVS</A >Mozilla
> CVS</A
instructions and check out the <TT > instructions and check out the
<TT
CLASS="filename" CLASS="filename"
>mozilla/webtools/bugzilla/docs/</TT >mozilla/webtools/bugzilla/docs/</TT
> >
subtree. subtree.) However, you should read the version
which came with the Bugzilla release you are using.
</P </P
><P ><P
>&#13; The Bugzilla Guide is currently only available in English. >&#13; The Bugzilla Guide is currently only available in English.
...@@ -648,7 +651,7 @@ NAME="credits" ...@@ -648,7 +651,7 @@ NAME="credits"
><P ><P
>&#13; Last but not least, all the members of the >&#13; Last but not least, all the members of the
<A <A
HREF="news://news.mozilla.org/netscape/public/mozilla/webtools" HREF="news://news.mozilla.org/netscape.public.mozilla.webtools"
TARGET="_top" TARGET="_top"
>&#13; netscape.public.mozilla.webtools</A >&#13; netscape.public.mozilla.webtools</A
> >
...@@ -669,7 +672,7 @@ NAME="conventions" ...@@ -669,7 +672,7 @@ NAME="conventions"
><DIV ><DIV
CLASS="informaltable" CLASS="informaltable"
><A ><A
NAME="AEN73" NAME="AEN72"
></A ></A
><P ><P
></P ></P
...@@ -693,7 +696,7 @@ VALIGN="MIDDLE" ...@@ -693,7 +696,7 @@ VALIGN="MIDDLE"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>Warnings</TD >Warning</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -767,7 +770,7 @@ VALIGN="TOP" ...@@ -767,7 +770,7 @@ VALIGN="TOP"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>Notes</TD >Note</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -841,7 +844,7 @@ VALIGN="TOP" ...@@ -841,7 +844,7 @@ VALIGN="TOP"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>File and directory names</TD >File or directory name</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -855,7 +858,7 @@ CLASS="filename" ...@@ -855,7 +858,7 @@ CLASS="filename"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>Commands to be typed</TD >Command to be typed</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -869,7 +872,7 @@ CLASS="command" ...@@ -869,7 +872,7 @@ CLASS="command"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>Applications names</TD >Application name</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -883,12 +886,7 @@ CLASS="application" ...@@ -883,12 +886,7 @@ CLASS="application"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>&#13; <I >&#13; Normal user's prompt under bash shell</TD
CLASS="foreignphrase"
>Prompt</I
>
of users command under bash shell</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -898,12 +896,7 @@ VALIGN="MIDDLE" ...@@ -898,12 +896,7 @@ VALIGN="MIDDLE"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>&#13; <I >&#13; Root user's prompt under bash shell</TD
CLASS="foreignphrase"
>Prompt</I
>
of root users command under bash shell</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -913,12 +906,7 @@ VALIGN="MIDDLE" ...@@ -913,12 +906,7 @@ VALIGN="MIDDLE"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>&#13; <I >&#13; Normal user's prompt under tcsh shell</TD
CLASS="foreignphrase"
>Prompt</I
>
of user command under tcsh shell</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -1040,23 +1028,15 @@ NAME="why-tracking" ...@@ -1040,23 +1028,15 @@ NAME="why-tracking"
></A ></A
>2.2. Why use a bug-tracking system?</H1 >2.2. Why use a bug-tracking system?</H1
><P ><P
>For many years, defect-tracking software was principally >Those who do not use a bug-tracking system tend to rely on
the domain of large software development houses. Most smaller shops shared lists, email, spreadsheets and/or Post-It notes to monitor the
simply relied on status of defects. This procedure
shared lists and email to monitor the status of defects. This procedure is usually error-prone and tends to cause those bugs judged least
was error-prone and tended to cause those bugs judged least significant by significant by developers to be dropped or ignored.</P
developers to be dropped or ignored.</P
><P ><P
>Integrated >Integrated defect-tracking systems make sure that nothing gets
defect-tracking systems reduce downtime, increase productivity, and raise swept under the carpet; they provide a method of creating, storing,
customer satisfaction with their systems. Along with full disclosure, an arranging and processing defect reports and enhancement requests.</P
open bug-tracker allows you to keep in touch with your 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 method for accounting for unusual system or software
issues.</P
></DIV ></DIV
><DIV ><DIV
CLASS="section" CLASS="section"
...@@ -1067,7 +1047,8 @@ NAME="why-bugzilla" ...@@ -1067,7 +1047,8 @@ NAME="why-bugzilla"
></A ></A
>2.3. Why use Bugzilla?</H1 >2.3. Why use Bugzilla?</H1
><P ><P
>Bugzilla boasts many advanced features. These include: >Bugzilla is the leading open-source/free software bug tracking
system. It boasts many advanced features, including:
<P <P
></P ></P
><UL ><UL
...@@ -1105,12 +1086,12 @@ NAME="why-bugzilla" ...@@ -1105,12 +1086,12 @@ NAME="why-bugzilla"
></LI ></LI
><LI ><LI
><P ><P
>Web, XML, email and console interfaces</P >Completely customisable and/or localisable web user
interface</P
></LI ></LI
><LI ><LI
><P ><P
>Completely customisable and/or localisable web user >Additional XML, email and console interfaces</P
interface</P
></LI ></LI
><LI ><LI
><P ><P
...@@ -1145,8 +1126,7 @@ HREF="http://www.perforce.com" ...@@ -1145,8 +1126,7 @@ HREF="http://www.perforce.com"
TARGET="_top" TARGET="_top"
>Perforce SCM</A >Perforce SCM</A
>, Bugzilla >, Bugzilla
provides a powerful, easy-to-use solution to configuration management and provides a powerful, easy-to-use configuration management solution.</P
replication problems.</P
></DIV ></DIV
></DIV ></DIV
><DIV ><DIV
...@@ -1156,18 +1136,27 @@ CLASS="chapter" ...@@ -1156,18 +1136,27 @@ CLASS="chapter"
NAME="using" NAME="using"
></A ></A
>Chapter 3. Using Bugzilla</H1 >Chapter 3. Using Bugzilla</H1
><DIV
CLASS="section"
><H1
CLASS="section"
><A
NAME="using-intro"
></A
>3.1. Introduction</H1
><P ><P
>This section contains information for end-users of Bugzilla. >This section contains information for end-users of Bugzilla.
There is a Bugzilla test installation, called There is a Bugzilla test installation, called
<A <A
HREF="http://landfill.bugzilla.org/bugzilla-tip/" HREF="http://landfill.bugzilla.org/bugzilla-tip/"
TARGET="_top" TARGET="_top"
>Landfill</A >Landfill</A
>, >,
which you are welcome to play with (if it's up.) which you are welcome to play with (if it's up.)
However, it does not necessarily However, it does not necessarily
have all Bugzilla features enabled, and runs an up-to-the-minute version, have all Bugzilla features enabled, and runs an up-to-the-minute version,
so some things may not quite work as this document describes.</P so some things may not quite work as this document describes.</P
></DIV
><DIV ><DIV
CLASS="section" CLASS="section"
><HR><H1 ><HR><H1
...@@ -1175,7 +1164,7 @@ CLASS="section" ...@@ -1175,7 +1164,7 @@ CLASS="section"
><A ><A
NAME="myaccount" NAME="myaccount"
></A ></A
>3.1. Create a Bugzilla Account</H1 >3.2. Create a Bugzilla Account</H1
><P ><P
>If you want to use Bugzilla, first you need to create an account. >If you want to use Bugzilla, first you need to create an account.
Consult with the administrator responsible for your installation of Consult with the administrator responsible for your installation of
...@@ -1245,7 +1234,7 @@ CLASS="section" ...@@ -1245,7 +1234,7 @@ CLASS="section"
><A ><A
NAME="bug_page" NAME="bug_page"
></A ></A
>3.2. Anatomy of a Bug</H1 >3.3. Anatomy of a Bug</H1
><P ><P
>The core of Bugzilla is the screen which displays a particular >The core of Bugzilla is the screen which displays a particular
bug. It's a good place to explain some Bugzilla concepts. bug. It's a good place to explain some Bugzilla concepts.
...@@ -1512,7 +1501,7 @@ CLASS="section" ...@@ -1512,7 +1501,7 @@ CLASS="section"
><A ><A
NAME="query" NAME="query"
></A ></A
>3.3. Searching for Bugs</H1 >3.4. Searching for Bugs</H1
><P ><P
>The Bugzilla Search page is is the interface where you can find >The Bugzilla Search page is is the interface where you can find
any bug report, comment, or patch currently in the Bugzilla system. You any bug report, comment, or patch currently in the Bugzilla system. You
...@@ -1542,7 +1531,7 @@ CLASS="section" ...@@ -1542,7 +1531,7 @@ CLASS="section"
><A ><A
NAME="list" NAME="list"
></A ></A
>3.4. Bug Lists</H1 >3.5. Bug Lists</H1
><P ><P
>If you run a search, a list of matching bugs will be returned. >If you run a search, a list of matching bugs will be returned.
</P </P
...@@ -1567,6 +1556,15 @@ BORDER="0" ...@@ -1567,6 +1556,15 @@ BORDER="0"
><TR ><TR
><TD ><TD
>&#13; <EM >&#13; <EM
>CSV:</EM
>
get the buglist as comma-separated values, for import into e.g.
a spreadsheet.</TD
></TR
><TR
><TD
>&#13; <EM
>Change Columns:</EM >Change Columns:</EM
> >
...@@ -1593,13 +1591,23 @@ BORDER="0" ...@@ -1593,13 +1591,23 @@ BORDER="0"
><TR ><TR
><TD ><TD
>&#13; <EM >&#13; <EM
>Edit this query:</EM >Edit Search:</EM
> >
If you didn't get exactly the results you were looking for, you can 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 return to the Query page through this link and make small revisions
to the query you just made so you get more accurate results.</TD to the query you just made so you get more accurate results.</TD
></TR ></TR
><TR
><TD
>&#13; <EM
>Remember Search As:</EM
>
You can give a search a name and remember it; a link will appear
in your page footer giving you quick access to run it again later.
</TD
></TR
></TBODY ></TBODY
></TABLE ></TABLE
><P ><P
...@@ -1614,7 +1622,7 @@ CLASS="section" ...@@ -1614,7 +1622,7 @@ CLASS="section"
><A ><A
NAME="bugreports" NAME="bugreports"
></A ></A
>3.5. Filing Bugs</H1 >3.6. Filing Bugs</H1
><P ><P
>Years of bug writing experience has been distilled for your >Years of bug writing experience has been distilled for your
reading pleasure into the reading pleasure into the
...@@ -1666,6 +1674,22 @@ TARGET="_top" ...@@ -1666,6 +1674,22 @@ TARGET="_top"
>Select "Commit" and send in your bug report.</P >Select "Commit" and send in your bug report.</P
></LI ></LI
></OL ></OL
><P
>Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
ensure your original information is easily accessible.
</P
><P
>&#13; You do not need to put "any" or similar strings in the URL field.
If there is no specific URL associated with the bug, leave this
field blank.
</P
><P
>If you feel a bug you filed was incorrectly marked as a
DUPLICATE of another, please question it in your bug, not
the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed.
</P
></DIV ></DIV
><DIV ><DIV
CLASS="section" CLASS="section"
...@@ -1674,7 +1698,7 @@ CLASS="section" ...@@ -1674,7 +1698,7 @@ CLASS="section"
><A ><A
NAME="patchviewer" NAME="patchviewer"
></A ></A
>3.6. Patch Viewer</H1 >3.7. Patch Viewer</H1
><P ><P
>Viewing and reviewing patches in Bugzilla is often difficult due to >Viewing and reviewing patches in Bugzilla is often difficult due to
lack of context, improper format and the inherent readability issues that lack of context, improper format and the inherent readability issues that
...@@ -1732,7 +1756,7 @@ CLASS="section" ...@@ -1732,7 +1756,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_view" NAME="patchviewer_view"
></A ></A
>3.6.1. Viewing Patches in Patch Viewer</H2 >3.7.1. Viewing Patches in Patch Viewer</H2
><P ><P
>The main way to view a patch in patch viewer is to click on the >The main way to view a patch in patch viewer is to click on the
"Diff" link next to a patch in the Attachments list on a bug. You may "Diff" link next to a patch in the Attachments list on a bug. You may
...@@ -1746,7 +1770,7 @@ CLASS="section" ...@@ -1746,7 +1770,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_diff" NAME="patchviewer_diff"
></A ></A
>3.6.2. Seeing the Difference Between Two Patches</H2 >3.7.2. Seeing the Difference Between Two Patches</H2
><P ><P
>To see the difference between two patches, you must first view the >To see the difference between two patches, you must first view the
newer patch in Patch Viewer. Then select the older patch from the newer patch in Patch Viewer. Then select the older patch from the
...@@ -1761,7 +1785,7 @@ CLASS="section" ...@@ -1761,7 +1785,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_context" NAME="patchviewer_context"
></A ></A
>3.6.3. Getting More Context in a Patch</H2 >3.7.3. Getting More Context in a Patch</H2
><P ><P
>To get more context in a patch, you put a number in the textbox at >To get more context in a patch, you put a number in the textbox at
the top of Patch Viewer ("Patch / File / [textbox]") and hit enter. the top of Patch Viewer ("Patch / File / [textbox]") and hit enter.
...@@ -1777,7 +1801,7 @@ CLASS="section" ...@@ -1777,7 +1801,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_collapse" NAME="patchviewer_collapse"
></A ></A
>3.6.4. Collapsing and Expanding Sections of a Patch</H2 >3.7.4. Collapsing and Expanding Sections of a Patch</H2
><P ><P
>To view only a certain set of files in a patch (for example, if a >To view only a certain set of files in a patch (for example, if a
patch is absolutely huge and you want to only review part of it at a patch is absolutely huge and you want to only review part of it at a
...@@ -1793,7 +1817,7 @@ CLASS="section" ...@@ -1793,7 +1817,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_link" NAME="patchviewer_link"
></A ></A
>3.6.5. Linking to a Section of a Patch</H2 >3.7.5. Linking to a Section of a Patch</H2
><P ><P
>To link to a section of a patch (for example, if you want to be >To link to a section of a patch (for example, if you want to be
able to give someone a URL to show them which part you are talking able to give someone a URL to show them which part you are talking
...@@ -1808,7 +1832,7 @@ CLASS="section" ...@@ -1808,7 +1832,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_bonsai_lxr" NAME="patchviewer_bonsai_lxr"
></A ></A
>3.6.6. Going to Bonsai and LXR</H2 >3.7.6. Going to Bonsai and LXR</H2
><P ><P
>To go to Bonsai to get blame for the lines you are interested in, >To go to Bonsai to get blame for the lines you are interested in,
you can click the "Lines XX-YY" link on the section header you are you can click the "Lines XX-YY" link on the section header you are
...@@ -1826,7 +1850,7 @@ CLASS="section" ...@@ -1826,7 +1850,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_unified_diff" NAME="patchviewer_unified_diff"
></A ></A
>3.6.7. Creating a Unified Diff</H2 >3.7.7. Creating a Unified Diff</H2
><P ><P
>If the patch is not in a format that you like, you can turn it >If the patch is not in a format that you like, you can turn it
into a unified diff format by clicking the "Raw Unified" link at the top into a unified diff format by clicking the "Raw Unified" link at the top
...@@ -1840,7 +1864,7 @@ CLASS="section" ...@@ -1840,7 +1864,7 @@ CLASS="section"
><A ><A
NAME="hintsandtips" NAME="hintsandtips"
></A ></A
>3.7. Hints and Tips</H1 >3.8. Hints and Tips</H1
><P ><P
>This section distills some Bugzilla tips and best practices >This section distills some Bugzilla tips and best practices
that have been developed.</P that have been developed.</P
...@@ -1849,9 +1873,9 @@ CLASS="section" ...@@ -1849,9 +1873,9 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN358" NAME="AEN363"
></A ></A
>3.7.1. Autolinkification</H2 >3.8.1. Autolinkification</H2
><P ><P
>Bugzilla comments are plain text - so typing &#60;U&#62; will >Bugzilla comments are plain text - so typing &#60;U&#62; will
produce less-than, U, greater-than rather than underlined text. produce less-than, U, greater-than rather than underlined text.
...@@ -1920,7 +1944,7 @@ CLASS="section" ...@@ -1920,7 +1944,7 @@ CLASS="section"
><A ><A
NAME="quicksearch" NAME="quicksearch"
></A ></A
>3.7.2. Quicksearch</H2 >3.8.2. Quicksearch</H2
><P ><P
>Quicksearch is a single-text-box query tool which uses >Quicksearch is a single-text-box query tool which uses
metacharacters to indicate what is to be searched. For example, typing metacharacters to indicate what is to be searched. For example, typing
...@@ -1953,7 +1977,7 @@ CLASS="section" ...@@ -1953,7 +1977,7 @@ CLASS="section"
><A ><A
NAME="commenting" NAME="commenting"
></A ></A
>3.7.3. Comments</H2 >3.8.3. Comments</H2
><P ><P
>If you are changing the fields on a bug, only comment if >If you are changing the fields on a bug, only comment if
either you have something pertinent to say, or Bugzilla requires it. either you have something pertinent to say, or Bugzilla requires it.
...@@ -1977,7 +2001,7 @@ CLASS="section" ...@@ -1977,7 +2001,7 @@ CLASS="section"
><A ><A
NAME="attachments" NAME="attachments"
></A ></A
>3.7.4. Attachments</H2 >3.8.4. Attachments</H2
><P ><P
>&#13; Use attachments, rather than comments, for large chunks of ASCII data, >&#13; Use attachments, rather than comments, for large chunks of ASCII data,
such as trace, debugging output files, or log files. That way, it doesn't such as trace, debugging output files, or log files. That way, it doesn't
...@@ -1996,31 +2020,6 @@ NAME="attachments" ...@@ -1996,31 +2020,6 @@ NAME="attachments"
out of the bug. out of the bug.
</P </P
></DIV ></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN388"
></A
>3.7.5. Filing Bugs</H2
><P
>Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
ensure your original information is easily accessible.
</P
><P
>&#13; You do not need to put "any" or similar strings in the URL field.
If there is no specific URL associated with the bug, leave this
field blank.
</P
><P
>If you feel a bug you filed was incorrectly marked as a
DUPLICATE of another, please question it in your bug, not
the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed.
</P
></DIV
></DIV ></DIV
><DIV ><DIV
CLASS="section" CLASS="section"
...@@ -2029,7 +2028,7 @@ CLASS="section" ...@@ -2029,7 +2028,7 @@ CLASS="section"
><A ><A
NAME="userpreferences" NAME="userpreferences"
></A ></A
>3.8. User Preferences</H1 >3.9. User Preferences</H1
><P ><P
>Once you have logged in, you can customise various aspects of >Once you have logged in, you can customise various aspects of
Bugzilla via the "Edit prefs" link in the page footer. Bugzilla via the "Edit prefs" link in the page footer.
...@@ -2041,7 +2040,7 @@ CLASS="section" ...@@ -2041,7 +2040,7 @@ CLASS="section"
><A ><A
NAME="accountsettings" NAME="accountsettings"
></A ></A
>3.8.1. Account Settings</H2 >3.9.1. Account Settings</H2
><P ><P
>On this tab, you can change your basic account information, >On this tab, you can change your basic account information,
including your password, email address and real name. For security including your password, email address and real name. For security
...@@ -2066,7 +2065,7 @@ CLASS="section" ...@@ -2066,7 +2065,7 @@ CLASS="section"
><A ><A
NAME="emailsettings" NAME="emailsettings"
></A ></A
>3.8.2. Email Settings</H2 >3.9.2. Email Settings</H2
><P ><P
>On this tab you can reduce or increase the amount of email sent >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 you from Bugzilla, opting in our out depending on your relationship to
...@@ -2121,7 +2120,7 @@ CLASS="section" ...@@ -2121,7 +2120,7 @@ CLASS="section"
><A ><A
NAME="permissionsettings" NAME="permissionsettings"
></A ></A
>3.8.3. Permissions</H2 >3.9.3. Permissions</H2
><P ><P
>This is a purely informative page which outlines your current >This is a purely informative page which outlines your current
permissions on this installation of Bugzilla - what product groups you permissions on this installation of Bugzilla - what product groups you
...@@ -2136,7 +2135,7 @@ CLASS="section" ...@@ -2136,7 +2135,7 @@ CLASS="section"
><A ><A
NAME="reporting" NAME="reporting"
></A ></A
>3.9. Reports</H1 >3.10. Reports</H1
><P ><P
><EM ><EM
>To be written</EM >To be written</EM
...@@ -2170,7 +2169,8 @@ CLASS="productname" ...@@ -2170,7 +2169,8 @@ CLASS="productname"
<A <A
HREF="#os-specific" HREF="#os-specific"
>Section 4.4</A >Section 4.4</A
>, so be sure to check out that section before >, so unless you are on Linux,
be sure to check out that section before
you start your installation. you start your installation.
</P </P
><DIV ><DIV
...@@ -2228,7 +2228,8 @@ ALIGN="LEFT" ...@@ -2228,7 +2228,8 @@ ALIGN="LEFT"
VALIGN="TOP" VALIGN="TOP"
><P ><P
>While installing Bugzilla, it is a good idea to ensure that there >While installing Bugzilla, it is a good idea to ensure that there
is some kind of firewall between you and the rest of the Internet is some kind of configurable firewall between you and the rest of the
Internet
as your machine may be insecure for periods during the install. Many as your machine may be insecure for periods during the install. Many
installation steps require an active Internet connection to complete, installation steps require an active Internet connection to complete,
but you must take care to ensure that at no point is your machine but you must take care to ensure that at no point is your machine
...@@ -2240,19 +2241,18 @@ VALIGN="TOP" ...@@ -2240,19 +2241,18 @@ VALIGN="TOP"
><P ><P
>This guide assumes that you already have your operating system >This guide assumes that you already have your operating system
installed, network configured, and have administrative access to the installed, network configured, and have administrative access to the
shell on the machine you are installing Bugzilla onto. It is possible to machine onto which you are installing Bugzilla. It is possible to
install and run Bugzilla without administrative access, but you have to install and run Bugzilla itself without administrative access, but you
have to
either make sure all the required software is installed or get somebody either make sure all the required software is installed or get somebody
with administrative access to install it for you. with administrative access to install it for you.
</P </P
><P ><P
>&#13; You are strongly recommended to make a backup of your system >&#13; You are strongly recommended to make a backup of your system
before installing Bugzilla and at regular intervals thereafter. before installing Bugzilla (and at regular intervals thereafter :-).
</P </P
><P ><P
>The listing below is a basic step-by-step list. More information >Here's a basic step-by-step list:
can be found in the sections below. Minimum versions will be
included in parenthesis where appropriate.
</P </P
><DIV ><DIV
CLASS="procedure" CLASS="procedure"
...@@ -2264,7 +2264,7 @@ TYPE="1" ...@@ -2264,7 +2264,7 @@ TYPE="1"
HREF="#install-perl" HREF="#install-perl"
>Install Perl</A >Install Perl</A
> >
(5.6) (5.6.0 or above)
</P </P
></LI ></LI
><LI ><LI
...@@ -2273,7 +2273,7 @@ HREF="#install-perl" ...@@ -2273,7 +2273,7 @@ HREF="#install-perl"
HREF="#install-mysql" HREF="#install-mysql"
>Install MySQL</A >Install MySQL</A
> >
(3.23.41) (3.23.41 or above)
</P </P
></LI ></LI
><LI ><LI
...@@ -2320,17 +2320,18 @@ NAME="install-perl" ...@@ -2320,17 +2320,18 @@ NAME="install-perl"
>4.1.1. Perl</H2 >4.1.1. Perl</H2
><P ><P
>Any machine that doesn't have Perl on it is a sad machine indeed. >Any machine that doesn't have Perl on it is a sad machine indeed.
Perl can be got in source form from <A If your OS doesn't come with it, Perl can be got in source form
from <A
HREF="http://www.perl.com" HREF="http://www.perl.com"
TARGET="_top" TARGET="_top"
>http://www.perl.com</A >http://www.perl.com</A
>. >.
There are also binary versions available for many platforms, most of which There are also binary versions available for many platforms, most of which
are linked to from perl.com. are linked to from perl.com.
Although Bugzilla runs with perl 5.6, Although Bugzilla runs with perl 5.6.0,
it's a good idea to be up to the very latest version it's a good idea to be up to the very latest version
if you can when running Bugzilla. As of this writing, that is Perl if you can when running Bugzilla. As of this writing, that is Perl
version 5.8.</P version 5.8.2.</P
></DIV ></DIV
><DIV ><DIV
CLASS="section" CLASS="section"
...@@ -2341,7 +2342,8 @@ NAME="install-mysql" ...@@ -2341,7 +2342,8 @@ NAME="install-mysql"
></A ></A
>4.1.2. MySQL</H2 >4.1.2. MySQL</H2
><P ><P
>Visit the MySQL homepage at >If your OS doesn't come with it or provide official packages,
visit the MySQL homepage at
<A <A
HREF="http://www.mysql.com" HREF="http://www.mysql.com"
TARGET="_top" TARGET="_top"
...@@ -2440,7 +2442,7 @@ set-variable = max_allowed_packet=1M ...@@ -2440,7 +2442,7 @@ set-variable = max_allowed_packet=1M
>If you are running Bugzilla and MySQL on the same machine, you may >If you are running Bugzilla and MySQL on the same machine, you may
also wish to utilize the <TT also wish to utilize the <TT
CLASS="option" CLASS="option"
>skip-networking</TT >--skip-networking</TT
> option as > option as
mentioned in <A mentioned in <A
HREF="#security-mysql" HREF="#security-mysql"
...@@ -2454,7 +2456,7 @@ CLASS="section" ...@@ -2454,7 +2456,7 @@ CLASS="section"
><A ><A
NAME="install-setupdatabase" NAME="install-setupdatabase"
></A ></A
>4.1.2.1. Configuring MySQL</H3 >4.1.2.1. Adding a user to MySQL</H3
><P ><P
>This first thing you'll want to do is make sure you've given the >This first thing you'll want to do is make sure you've given the
<SPAN <SPAN
...@@ -2464,7 +2466,8 @@ CLASS="QUOTE" ...@@ -2464,7 +2466,8 @@ CLASS="QUOTE"
<A <A
HREF="#security-mysql" HREF="#security-mysql"
>Section 4.5.2</A >Section 4.5.2</A
>. For clarity, these instructions will >. Then, you need to add a user for
Bugzilla to use. For clarity, these instructions will
assume that your MySQL user for Bugzilla will be <SPAN assume that your MySQL user for Bugzilla will be <SPAN
CLASS="QUOTE" CLASS="QUOTE"
>"bugs_user"</SPAN >"bugs_user"</SPAN
...@@ -2507,14 +2510,14 @@ VALIGN="TOP" ...@@ -2507,14 +2510,14 @@ VALIGN="TOP"
CLASS="QUOTE" CLASS="QUOTE"
>"bugs"</SPAN >"bugs"</SPAN
> for both the user and > for both the user and
database name. database name. Don't use it for the password, though...
</P </P
></TD ></TD
></TR ></TR
></TABLE ></TABLE
></DIV ></DIV
><P ><P
>Next, we use an SQL <B >We use an SQL <B
CLASS="command" CLASS="command"
>GRANT</B >GRANT</B
> command to create a > command to create a
...@@ -2522,8 +2525,7 @@ CLASS="command" ...@@ -2522,8 +2525,7 @@ CLASS="command"
CLASS="QUOTE" CLASS="QUOTE"
>"bugs_user"</SPAN >"bugs_user"</SPAN
> >
user, and grant sufficient permissions for checksetup.pl, which we'll user. This also restricts the
use later, to work its magic. This also restricts the
<SPAN <SPAN
CLASS="QUOTE" CLASS="QUOTE"
>"bugs_user"</SPAN >"bugs_user"</SPAN
...@@ -2593,7 +2595,12 @@ CLASS="computeroutput" ...@@ -2593,7 +2595,12 @@ CLASS="computeroutput"
<TT <TT
CLASS="computeroutput" CLASS="computeroutput"
>CREATE TEMPORARY TABLES</TT >CREATE TEMPORARY TABLES</TT
> permissions. > permissions,
so add them to the list in the
<TT
CLASS="computeroutput"
>GRANT</TT
> command.
</P </P
></TD ></TD
></TR ></TR
...@@ -2703,32 +2710,30 @@ ALT="Tip"></TD ...@@ -2703,32 +2710,30 @@ ALT="Tip"></TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="TOP" VALIGN="TOP"
><P ><P
>If you symlink the bugzilla directory into your Apache's HTML >If you symlink the bugzilla directory into your Apache's
<TT
CLASS="filename"
>html</TT
>
hierarchy, you may receive hierarchy, you may receive
<SPAN <SPAN
CLASS="errorname" CLASS="errorname"
>Forbidden</SPAN >Forbidden</SPAN
> >
errors unless you add the errors unless you add the
<SPAN <TT
CLASS="QUOTE" CLASS="filename"
>"FollowSymLinks"</SPAN >FollowSymLinks</TT
> >
directive to the &#60;Directory&#62; entry for the HTML root directive to the <TT
in httpd.conf.</P CLASS="filename"
>&#60;Directory&#62;</TT
> entry for
the HTML root directory in httpd.conf.</P
></TD ></TD
></TR ></TR
></TABLE ></TABLE
></DIV ></DIV
><P
>Once all the files are in a web accessible directory, make that
directory writable by your webserver's user. This is a temporary step
until you run the post-install
<TT
CLASS="filename"
>checksetup.pl</TT
>
script, which locks down your installation.</P
><DIV ><DIV
CLASS="caution" CLASS="caution"
><P ><P
...@@ -2765,6 +2770,166 @@ CLASS="option" ...@@ -2765,6 +2770,166 @@ CLASS="option"
></TR ></TR
></TABLE ></TABLE
></DIV ></DIV
><P
>Once all the files are in a web accessible directory, make that
directory writable by your webserver's user. This is a temporary step
until you run the post-install
<TT
CLASS="filename"
>checksetup.pl</TT
>
script, which locks down your installation.</P
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN522"
></A
>4.1.5. <TT
CLASS="filename"
>checksetup.pl</TT
></H2
><P
>Next, run the magic checksetup.pl script.
This is designed to check whether you have all of the right
Perl modules in the correct
versions, and that Bugzilla is generally set up correctly.
</P
><P
>&#13; Eventually,
it will make sure Bugzilla files and directories have reasonable
permissions, set up the
<TT
CLASS="filename"
>data</TT
>
directory, and create all the MySQL tables. But the first time you
run it, it's highly likely to tell you that you are missing a few
Perl modules. Make a note of which ones they are, and then proceed to
the next section to install them.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="screen"
>&#13;<TT
CLASS="prompt"
>bash#</TT
> ./checksetup.pl
</PRE
></FONT
></TD
></TR
></TABLE
><P
>&#13; The first time you run it with all the correct modules installed,
it will create a file called
<TT
CLASS="filename"
>localconfig</TT
>.</P
><P
>This file contains a variety of settings you may need to tweak
including how Bugzilla should connect to the MySQL database.</P
><P
>The connection settings include:
<P
></P
><OL
TYPE="1"
><LI
><P
>server's host: just use
<SPAN
CLASS="QUOTE"
>"localhost"</SPAN
>
if the MySQL server is local</P
></LI
><LI
><P
>database name:
<SPAN
CLASS="QUOTE"
>"bugs_db"</SPAN
>
if you're following these directions</P
></LI
><LI
><P
>MySQL username:
<SPAN
CLASS="QUOTE"
>"bugs_user"</SPAN
>
if you're following these directions</P
></LI
><LI
><P
>Password for the
<SPAN
CLASS="QUOTE"
>"bugs_user"</SPAN
>
MySQL account; (<SPAN
CLASS="QUOTE"
>"bugs_password"</SPAN
> above)</P
></LI
></OL
>
</P
><P
>Edit the file to change these. Once you are happy with the
settings, <TT
CLASS="filename"
>su</TT
> to the user
your web server runs as, and re-run
<TT
CLASS="filename"
>checksetup.pl</TT
>. (Note: on some security-conscious
systems, you may need to change the login shell for the webserver
account before you can do this.)
On this second run, it will create the database and an administrator
account for which you will be prompted to provide information.</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The checksetup.pl script is designed so that you can run it at
any time without causing harm. You should run it after any upgrade to
Bugzilla.</P
></TD
></TR
></TABLE
></DIV
></DIV ></DIV
><DIV ><DIV
CLASS="section" CLASS="section"
...@@ -2773,7 +2938,15 @@ CLASS="section" ...@@ -2773,7 +2938,15 @@ CLASS="section"
><A ><A
NAME="install-perlmodules" NAME="install-perlmodules"
></A ></A
>4.1.5. Perl Modules</H2 >4.1.6. Perl Modules</H2
><P
>Don't be intimidated by this long list of modules. See
<A
HREF="#install-modules-bundle-bugzilla"
>Section 4.1.6.1</A
> for a way of
installing all the ones you need with a single command.
</P
><P ><P
>Perl modules can be found using >Perl modules can be found using
<A <A
...@@ -2789,8 +2962,7 @@ HREF="#gloss-ppm" ...@@ -2789,8 +2962,7 @@ HREF="#gloss-ppm"
CLASS="glossterm" CLASS="glossterm"
>PPM</I >PPM</I
></A ></A
> on Win32. The root servers > on Win32.
have a real tendency to bog down, so please use mirrors.
</P </P
><P ><P
>Good instuctions can be found for using each of these services on >Good instuctions can be found for using each of these services on
...@@ -3010,15 +3182,6 @@ HREF="#install-modules-bundle-bugzilla" ...@@ -3010,15 +3182,6 @@ HREF="#install-modules-bundle-bugzilla"
><LI ><LI
><P ><P
>&#13; <A >&#13; <A
HREF="#install-modules-appconfig"
>AppConfig</A
>
(1.52)
</P
></LI
><LI
><P
>&#13; <A
HREF="#install-modules-cgi" HREF="#install-modules-cgi"
>CGI</A >CGI</A
> >
...@@ -3028,15 +3191,6 @@ HREF="#install-modules-cgi" ...@@ -3028,15 +3191,6 @@ HREF="#install-modules-cgi"
><LI ><LI
><P ><P
>&#13; <A >&#13; <A
HREF="#install-modules-data-dumper"
>Data::Dumper</A
>
(any)
</P
></LI
><LI
><P
>&#13; <A
HREF="#install-modules-date-format" HREF="#install-modules-date-format"
>Date::Format</A >Date::Format</A
> >
...@@ -3178,7 +3332,7 @@ CLASS="section" ...@@ -3178,7 +3332,7 @@ CLASS="section"
><A ><A
NAME="install-modules-bundle-bugzilla" NAME="install-modules-bundle-bugzilla"
></A ></A
>4.1.5.1. Bundle::Bugzilla</H3 >4.1.6.1. Bundle::Bugzilla</H3
><P ><P
>If you are running at least perl 5.6.1, you can save yourself a lot >If you are running at least perl 5.6.1, you can save yourself a lot
of time by using Bundle::Bugzilla. This bundle contains every module of time by using Bundle::Bugzilla. This bundle contains every module
...@@ -3255,22 +3409,9 @@ CLASS="section" ...@@ -3255,22 +3409,9 @@ CLASS="section"
><HR><H3 ><HR><H3
CLASS="section" CLASS="section"
><A ><A
NAME="install-modules-appconfig"
></A
>4.1.5.2. AppConfig (1.52)</H3
><P
>Dependency for Template Toolkit. We probably don't need to
specifically check for it anymore.
</P
></DIV
><DIV
CLASS="section"
><HR><H3
CLASS="section"
><A
NAME="install-modules-cgi" NAME="install-modules-cgi"
></A ></A
>4.1.5.3. CGI (2.88)</H3 >4.1.6.2. CGI (2.88)</H3
><P ><P
>The CGI module parses form elements and cookies and does many >The CGI module parses form elements and cookies and does many
other usefule things. It come as a part of recent perl distributions, but other usefule things. It come as a part of recent perl distributions, but
...@@ -3301,43 +3442,9 @@ CLASS="section" ...@@ -3301,43 +3442,9 @@ CLASS="section"
><HR><H3 ><HR><H3
CLASS="section" CLASS="section"
><A ><A
NAME="install-modules-data-dumper"
></A
>4.1.5.4. Data::Dumper (any)</H3
><P
>The Data::Dumper module provides data structure persistence for
Perl (similar to Java's serialization). It comes with later
sub-releases of Perl 5.004, but a re-installation just to be sure it's
available won't hurt anything.
</P
><P
CLASS="literallayout"
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CPAN&nbsp;Download&nbsp;Page:&nbsp;<A
HREF="http://search.cpan.org/dist/Data-Dumper/"
TARGET="_top"
>http://search.cpan.org/dist/Data-Dumper/</A
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PPM&nbsp;Download&nbsp;Link:&nbsp;<A
HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Data-Dumper.zip"
TARGET="_top"
>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Data-Dumper.zip</A
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Documentation:&nbsp;<A
HREF="http://www.perldoc.com/perl5.8.0/lib/Data/Dumper.html"
TARGET="_top"
>http://www.perldoc.com/perl5.8.0/lib/Data/Dumper.html</A
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</P
></DIV
><DIV
CLASS="section"
><HR><H3
CLASS="section"
><A
NAME="install-modules-date-format" NAME="install-modules-date-format"
></A ></A
>4.1.5.5. TimeDate modules (2.21)</H3 >4.1.6.3. TimeDate modules (2.21)</H3
><P ><P
>Many of the more common date/time/calendar related Perl modules >Many of the more common date/time/calendar related Perl modules
have been grouped into a bundle similar to the MySQL modules bundle. have been grouped into a bundle similar to the MySQL modules bundle.
...@@ -3372,7 +3479,7 @@ CLASS="section" ...@@ -3372,7 +3479,7 @@ CLASS="section"
><A ><A
NAME="install-modules-dbi" NAME="install-modules-dbi"
></A ></A
>4.1.5.6. DBI (1.32)</H3 >4.1.6.4. DBI (1.32)</H3
><P ><P
>The DBI module is a generic Perl module used the >The DBI module is a generic Perl module used the
MySQL-related modules. As long as your Perl installation was done MySQL-related modules. As long as your Perl installation was done
...@@ -3406,7 +3513,7 @@ CLASS="section" ...@@ -3406,7 +3513,7 @@ CLASS="section"
><A ><A
NAME="install-modules-dbd-mysql" NAME="install-modules-dbd-mysql"
></A ></A
>4.1.5.7. MySQL-related modules</H3 >4.1.6.5. MySQL-related modules</H3
><P ><P
>The Perl/MySQL interface requires a few mutually-dependent Perl >The Perl/MySQL interface requires a few mutually-dependent Perl
modules. These modules are grouped together into the the modules. These modules are grouped together into the the
...@@ -3451,7 +3558,7 @@ CLASS="section" ...@@ -3451,7 +3558,7 @@ CLASS="section"
><A ><A
NAME="install-file-spec" NAME="install-file-spec"
></A ></A
>4.1.5.8. File::Spec (0.82)</H3 >4.1.6.6. File::Spec (0.82)</H3
><P ><P
>File::Spec is a perl module that allows file operations, such as >File::Spec is a perl module that allows file operations, such as
generating full path names, to work cross platform. generating full path names, to work cross platform.
...@@ -3483,7 +3590,7 @@ CLASS="section" ...@@ -3483,7 +3590,7 @@ CLASS="section"
><A ><A
NAME="install-modules-file-temp" NAME="install-modules-file-temp"
></A ></A
>4.1.5.9. File::Temp (any)</H3 >4.1.6.7. File::Temp (any)</H3
><P ><P
>File::Temp is used to generate a temporary filename that is >File::Temp is used to generate a temporary filename that is
guaranteed to be unique. It comes as a standard part of perl guaranteed to be unique. It comes as a standard part of perl
...@@ -3515,7 +3622,7 @@ CLASS="section" ...@@ -3515,7 +3622,7 @@ CLASS="section"
><A ><A
NAME="install-modules-template" NAME="install-modules-template"
></A ></A
>4.1.5.10. Template Toolkit (2.08)</H3 >4.1.6.8. Template Toolkit (2.08)</H3
><P ><P
>When you install Template Toolkit, you'll get asked various >When you install Template Toolkit, you'll get asked various
questions about features to enable. The defaults are fine, except questions about features to enable. The defaults are fine, except
...@@ -3549,7 +3656,7 @@ CLASS="section" ...@@ -3549,7 +3656,7 @@ CLASS="section"
><A ><A
NAME="install-modules-text-wrap" NAME="install-modules-text-wrap"
></A ></A
>4.1.5.11. Text::Wrap (2001.0131)</H3 >4.1.6.9. Text::Wrap (2001.0131)</H3
><P ><P
>Text::Wrap is designed to proved intelligent text wrapping. >Text::Wrap is designed to proved intelligent text wrapping.
</P </P
...@@ -3575,14 +3682,10 @@ CLASS="section" ...@@ -3575,14 +3682,10 @@ CLASS="section"
><A ><A
NAME="install-modules-gd" NAME="install-modules-gd"
></A ></A
>4.1.5.12. GD (1.20) [optional]</H3 >4.1.6.10. GD (1.20) [optional]</H3
><P ><P
>The GD library was written by Thomas Boutell a long while ago to >You need the GD library if you want any of the graphing to work.
programmatically generate images in C. Since then it's become the </P
defacto standard for programmatic image construction. The Perl bindings
to it found in the GD library are used on millions of web pages to
generate graphs on the fly. That's what Bugzilla will be using it for
so you must install it if you want any of the graphing to work.</P
><DIV ><DIV
CLASS="note" CLASS="note"
><P ><P
...@@ -3685,7 +3788,7 @@ CLASS="section" ...@@ -3685,7 +3788,7 @@ CLASS="section"
><A ><A
NAME="install-modules-chart-base" NAME="install-modules-chart-base"
></A ></A
>4.1.5.13. Chart::Base (0.99c) [optional]</H3 >4.1.6.11. Chart::Base (0.99c) [optional]</H3
><P ><P
>The Chart module provides Bugzilla with on-the-fly charting >The Chart module provides Bugzilla with on-the-fly charting
abilities. It can be installed in the usual fashion after it has been abilities. It can be installed in the usual fashion after it has been
...@@ -3714,7 +3817,7 @@ CLASS="section" ...@@ -3714,7 +3817,7 @@ CLASS="section"
><A ><A
NAME="install-modules-xml-parser" NAME="install-modules-xml-parser"
></A ></A
>4.1.5.14. XML::Parser (any) [Optional]</H3 >4.1.6.12. XML::Parser (any) [optional]</H3
><P ><P
>XML::Parser is used by the <TT >XML::Parser is used by the <TT
CLASS="filename" CLASS="filename"
...@@ -3749,7 +3852,7 @@ CLASS="section" ...@@ -3749,7 +3852,7 @@ CLASS="section"
><A ><A
NAME="install-modules-gd-graph" NAME="install-modules-gd-graph"
></A ></A
>4.1.5.15. GD::Graph (any) [Optional]</H3 >4.1.6.13. GD::Graph (any) [optional]</H3
><P ><P
>In addition to GD listed above, the reporting interface of Bugzilla >In addition to GD listed above, the reporting interface of Bugzilla
needs to have the GD::Graph module installed. needs to have the GD::Graph module installed.
...@@ -3781,7 +3884,7 @@ CLASS="section" ...@@ -3781,7 +3884,7 @@ CLASS="section"
><A ><A
NAME="install-modules-gd-text-align" NAME="install-modules-gd-text-align"
></A ></A
>4.1.5.16. GD::Text::Align (any) [Optional]</H3 >4.1.6.14. GD::Text::Align (any) [optional]</H3
><P ><P
>GD::Text::Align, as the name implies, is used to draw aligned >GD::Text::Align, as the name implies, is used to draw aligned
strings of text. It is needed by the reporting interface. strings of text. It is needed by the reporting interface.
...@@ -3813,7 +3916,7 @@ CLASS="section" ...@@ -3813,7 +3916,7 @@ CLASS="section"
><A ><A
NAME="install-modules-mime-parser" NAME="install-modules-mime-parser"
></A ></A
>4.1.5.17. MIME::Parser (any) [Optional]</H3 >4.1.6.15. MIME::Parser (any) [optional]</H3
><P ><P
>MIME::Parser is only needed if you want to use the e-mail interface >MIME::Parser is only needed if you want to use the e-mail interface
located in the <TT located in the <TT
...@@ -3848,7 +3951,7 @@ CLASS="section" ...@@ -3848,7 +3951,7 @@ CLASS="section"
><A ><A
NAME="install-modules-patchreader" NAME="install-modules-patchreader"
></A ></A
>4.1.5.18. PatchReader (0.9.1) [Optional]</H3 >4.1.6.16. PatchReader (0.9.1) [optional]</H3
><P ><P
>PatchReader is only needed if you want to use Patch Viewer, a >PatchReader is only needed if you want to use Patch Viewer, a
Bugzilla feature to format patches in a pretty HTML fashion. There are a Bugzilla feature to format patches in a pretty HTML fashion. There are a
...@@ -3884,154 +3987,15 @@ CLASS="section" ...@@ -3884,154 +3987,15 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN748" NAME="AEN768"
></A ></A
>4.1.6. <TT >4.1.7. Configuring Bugzilla</H2
CLASS="filename"
>checksetup.pl</TT
></H2
><P
>Next, run the magic checksetup.pl script.
This is designed to make sure your perl modules are the correct
version and your MySQL database and other
configuration options are consistent with the Bugzilla CGI files.
It will make sure Bugzilla files and directories have reasonable
permissions, set up the
<TT
CLASS="filename"
>data</TT
>
directory, and create all the MySQL tables.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="screen"
>&#13;<TT
CLASS="prompt"
>bash#</TT
> ./checksetup.pl
</PRE
></FONT
></TD
></TR
></TABLE
><P
>&#13; The first time you run it, it will create a file called
<TT
CLASS="filename"
>localconfig</TT
>.</P
><P
>This file contains a variety of settings you may need to tweak
including how Bugzilla should connect to the MySQL database.</P
><P
>The connection settings include:
<P
></P
><OL
TYPE="1"
><LI
><P
>server's host: just use
<SPAN
CLASS="QUOTE"
>"localhost"</SPAN
>
if the MySQL server is local</P
></LI
><LI
><P
>database name:
<SPAN
CLASS="QUOTE"
>"bugs_db"</SPAN
>
if you're following these directions</P
></LI
><LI
><P
>MySQL username:
<SPAN
CLASS="QUOTE"
>"bugs_user"</SPAN
>
if you're following these directions</P
></LI
><LI
><P ><P
>Password for the >&#13; Once checksetup.pl has run successfully, Bugzilla should start up.
<SPAN Proceed to the correct URL and log in with the administrator account
CLASS="QUOTE" you defined in the last checksetup.pl run.
>"bugs_user"</SPAN
>
MySQL account; (<SPAN
CLASS="QUOTE"
>"bugs_password"</SPAN
> above)</P
></LI
></OL
>
</P </P
><P ><P
>Once you are happy with the settings,
<TT
CLASS="filename"
>su</TT
> to the user
your web server runs as, and re-run
<TT
CLASS="filename"
>checksetup.pl</TT
>. (Note: on some security-conscious
systems, you may need to change the login shell for the webserver
account before you can do this.)
On this second run, it will create the database and an administrator
account for which you will be prompted to provide information.</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The checksetup.pl script is designed so that you can run it at
any time without causing harm. You should run it after any upgrade to
Bugzilla.</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><HR><H2
CLASS="section"
><A
NAME="AEN778"
></A
>4.1.7. Configuring Bugzilla</H2
><P
>&#13; You should run through the parameters on the Edit Parameters page >&#13; You should run through the parameters on the Edit Parameters page
(link in the footer) and set them all to appropriate values. (link in the footer) and set them all to appropriate values.
They key parameters are documented in <A They key parameters are documented in <A
...@@ -4452,7 +4416,7 @@ CLASS="section" ...@@ -4452,7 +4416,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN852" NAME="AEN843"
></A ></A
>4.3.1. Dependency Charts</H2 >4.3.1. Dependency Charts</H2
><P ><P
...@@ -4516,7 +4480,7 @@ CLASS="section" ...@@ -4516,7 +4480,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN867" NAME="AEN858"
></A ></A
>4.3.2. Bug Graphs</H2 >4.3.2. Bug Graphs</H2
><P ><P
...@@ -4575,7 +4539,7 @@ CLASS="section" ...@@ -4575,7 +4539,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN880" NAME="AEN871"
></A ></A
>4.3.3. The Whining Cron</H2 >4.3.3. The Whining Cron</H2
><P ><P
...@@ -5091,7 +5055,7 @@ NAME="win32-perlmodules" ...@@ -5091,7 +5055,7 @@ NAME="win32-perlmodules"
>Bugzilla on Windows requires the same perl modules found in >Bugzilla on Windows requires the same perl modules found in
<A <A
HREF="#install-perlmodules" HREF="#install-perlmodules"
>Section 4.1.5</A >Section 4.1.6</A
>. The main difference is that >. The main difference is that
windows uses <A windows uses <A
HREF="#gloss-ppm" HREF="#gloss-ppm"
...@@ -6290,7 +6254,7 @@ CLASS="section" ...@@ -6290,7 +6254,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1215" NAME="AEN1206"
></A ></A
>4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2 >4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2
><P ><P
...@@ -6315,7 +6279,7 @@ CLASS="section" ...@@ -6315,7 +6279,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1220" NAME="AEN1211"
></A ></A
>4.6.2. DBD::Sponge::db prepare failed</H2 >4.6.2. DBD::Sponge::db prepare failed</H2
><P ><P
...@@ -8247,7 +8211,7 @@ CLASS="section" ...@@ -8247,7 +8211,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1597" NAME="AEN1588"
></A ></A
>6.1.1. What to Edit</H2 >6.1.1. What to Edit</H2
><P ><P
...@@ -8399,7 +8363,7 @@ CLASS="section" ...@@ -8399,7 +8363,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1620" NAME="AEN1611"
></A ></A
>6.1.2. How To Edit Templates</H2 >6.1.2. How To Edit Templates</H2
><DIV ><DIV
...@@ -8479,7 +8443,7 @@ CLASS="section" ...@@ -8479,7 +8443,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1630" NAME="AEN1621"
></A ></A
>6.1.3. Template Formats</H2 >6.1.3. Template Formats</H2
><P ><P
...@@ -8541,7 +8505,7 @@ CLASS="section" ...@@ -8541,7 +8505,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1643" NAME="AEN1634"
></A ></A
>6.1.4. Particular Templates</H2 >6.1.4. Particular Templates</H2
><P ><P
...@@ -9039,7 +9003,7 @@ CLASS="section" ...@@ -9039,7 +9003,7 @@ CLASS="section"
><HR><H2 ><HR><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1719" NAME="AEN1710"
></A ></A
>6.4.1. Bugzilla Database Basics</H2 >6.4.1. Bugzilla Database Basics</H2
><P ><P
...@@ -9153,7 +9117,7 @@ CLASS="section" ...@@ -9153,7 +9117,7 @@ CLASS="section"
><HR><H3 ><HR><H3
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1746" NAME="AEN1737"
></A ></A
>6.4.1.1. Bugzilla Database Tables</H3 >6.4.1.1. Bugzilla Database Tables</H3
><P ><P
...@@ -11428,7 +11392,7 @@ CLASS="answer" ...@@ -11428,7 +11392,7 @@ CLASS="answer"
><P ><P
>&#13; Microsoft has some advice on this matter, as well: >&#13; Microsoft has some advice on this matter, as well:
<A <A
NAME="AEN2062" NAME="AEN2053"
></A ></A
><BLOCKQUOTE ><BLOCKQUOTE
CLASS="BLOCKQUOTE" CLASS="BLOCKQUOTE"
...@@ -12049,7 +12013,7 @@ NAME="gfdl" ...@@ -12049,7 +12013,7 @@ NAME="gfdl"
><P ><P
>Version 1.1, March 2000</P >Version 1.1, March 2000</P
><A ><A
NAME="AEN2192" NAME="AEN2183"
></A ></A
><BLOCKQUOTE ><BLOCKQUOTE
CLASS="BLOCKQUOTE" CLASS="BLOCKQUOTE"
...@@ -12512,7 +12476,7 @@ NAME="gfdl-howto" ...@@ -12512,7 +12476,7 @@ NAME="gfdl-howto"
of the License in the document and put the following copyright and of the License in the document and put the following copyright and
license notices just after the title page:</P license notices just after the title page:</P
><A ><A
NAME="AEN2282" NAME="AEN2273"
></A ></A
><BLOCKQUOTE ><BLOCKQUOTE
CLASS="BLOCKQUOTE" CLASS="BLOCKQUOTE"
...@@ -12549,7 +12513,7 @@ CLASS="glossdiv" ...@@ -12549,7 +12513,7 @@ CLASS="glossdiv"
><H1 ><H1
CLASS="glossdiv" CLASS="glossdiv"
><A ><A
NAME="AEN2287" NAME="AEN2278"
></A ></A
>0-9, high ascii</H1 >0-9, high ascii</H1
><DL ><DL
...@@ -13413,7 +13377,7 @@ NAME="gloss-zarro" ...@@ -13413,7 +13377,7 @@ NAME="gloss-zarro"
Terry had the following to say: Terry had the following to say:
</P </P
><A ><A
NAME="AEN2522" NAME="AEN2513"
></A ></A
><TABLE ><TABLE
BORDER="0" BORDER="0"
......
docs/html/bug_page.html
View file @ 96a0037a
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="bug_page" NAME="bug_page"
></A ></A
>3.2. Anatomy of a Bug</H1 >3.3. Anatomy of a Bug</H1
><P ><P
>The core of Bugzilla is the screen which displays a particular >The core of Bugzilla is the screen which displays a particular
bug. It's a good place to explain some Bugzilla concepts. bug. It's a good place to explain some Bugzilla concepts.
......
docs/html/bugreports.html
View file @ 96a0037a
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="bugreports" NAME="bugreports"
></A ></A
>3.5. Filing Bugs</H1 >3.6. Filing Bugs</H1
><P ><P
>Years of bug writing experience has been distilled for your >Years of bug writing experience has been distilled for your
reading pleasure into the reading pleasure into the
...@@ -129,6 +129,22 @@ TARGET="_top" ...@@ -129,6 +129,22 @@ TARGET="_top"
>Select "Commit" and send in your bug report.</P >Select "Commit" and send in your bug report.</P
></LI ></LI
></OL ></OL
><P
>Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
ensure your original information is easily accessible.
</P
><P
>&#13; You do not need to put "any" or similar strings in the URL field.
If there is no specific URL associated with the bug, leave this
field blank.
</P
><P
>If you feel a bug you filed was incorrectly marked as a
DUPLICATE of another, please question it in your bug, not
the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed.
</P
></DIV ></DIV
><DIV ><DIV
CLASS="NAVFOOTER" CLASS="NAVFOOTER"
......
docs/html/conventions.html
View file @ 96a0037a
...@@ -83,7 +83,7 @@ NAME="conventions" ...@@ -83,7 +83,7 @@ NAME="conventions"
><DIV ><DIV
CLASS="informaltable" CLASS="informaltable"
><A ><A
NAME="AEN73" NAME="AEN72"
></A ></A
><P ><P
></P ></P
...@@ -107,7 +107,7 @@ VALIGN="MIDDLE" ...@@ -107,7 +107,7 @@ VALIGN="MIDDLE"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>Warnings</TD >Warning</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -181,7 +181,7 @@ VALIGN="TOP" ...@@ -181,7 +181,7 @@ VALIGN="TOP"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>Notes</TD >Note</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -255,7 +255,7 @@ VALIGN="TOP" ...@@ -255,7 +255,7 @@ VALIGN="TOP"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>File and directory names</TD >File or directory name</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -269,7 +269,7 @@ CLASS="filename" ...@@ -269,7 +269,7 @@ CLASS="filename"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>Commands to be typed</TD >Command to be typed</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -283,7 +283,7 @@ CLASS="command" ...@@ -283,7 +283,7 @@ CLASS="command"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>Applications names</TD >Application name</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -297,12 +297,7 @@ CLASS="application" ...@@ -297,12 +297,7 @@ CLASS="application"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>&#13; <I >&#13; Normal user's prompt under bash shell</TD
CLASS="foreignphrase"
>Prompt</I
>
of users command under bash shell</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -312,12 +307,7 @@ VALIGN="MIDDLE" ...@@ -312,12 +307,7 @@ VALIGN="MIDDLE"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>&#13; <I >&#13; Root user's prompt under bash shell</TD
CLASS="foreignphrase"
>Prompt</I
>
of root users command under bash shell</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
...@@ -327,12 +317,7 @@ VALIGN="MIDDLE" ...@@ -327,12 +317,7 @@ VALIGN="MIDDLE"
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
>&#13; <I >&#13; Normal user's prompt under tcsh shell</TD
CLASS="foreignphrase"
>Prompt</I
>
of user command under tcsh shell</TD
><TD ><TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="MIDDLE" VALIGN="MIDDLE"
......
docs/html/credits.html
View file @ 96a0037a
...@@ -90,7 +90,7 @@ NAME="credits" ...@@ -90,7 +90,7 @@ NAME="credits"
><P ><P
>&#13; Last but not least, all the members of the >&#13; Last but not least, all the members of the
<A <A
HREF="news://news.mozilla.org/netscape/public/mozilla/webtools" HREF="news://news.mozilla.org/netscape.public.mozilla.webtools"
TARGET="_top" TARGET="_top"
>&#13; netscape.public.mozilla.webtools</A >&#13; netscape.public.mozilla.webtools</A
> >
......
docs/html/cust-templates.html
View file @ 96a0037a
...@@ -97,7 +97,7 @@ CLASS="section" ...@@ -97,7 +97,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1597" NAME="AEN1588"
></A ></A
>6.1.1. What to Edit</H2 >6.1.1. What to Edit</H2
><P ><P
...@@ -249,7 +249,7 @@ CLASS="section" ...@@ -249,7 +249,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1620" NAME="AEN1611"
></A ></A
>6.1.2. How To Edit Templates</H2 >6.1.2. How To Edit Templates</H2
><DIV ><DIV
...@@ -329,7 +329,7 @@ CLASS="section" ...@@ -329,7 +329,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1630" NAME="AEN1621"
></A ></A
>6.1.3. Template Formats</H2 >6.1.3. Template Formats</H2
><P ><P
...@@ -391,7 +391,7 @@ CLASS="section" ...@@ -391,7 +391,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1643" NAME="AEN1634"
></A ></A
>6.1.4. Particular Templates</H2 >6.1.4. Particular Templates</H2
><P ><P
......
docs/html/customization.html
View file @ 96a0037a
...@@ -90,22 +90,22 @@ HREF="cust-templates.html" ...@@ -90,22 +90,22 @@ HREF="cust-templates.html"
><DL ><DL
><DT ><DT
>6.1.1. <A >6.1.1. <A
HREF="cust-templates.html#AEN1597" HREF="cust-templates.html#AEN1588"
>What to Edit</A >What to Edit</A
></DT ></DT
><DT ><DT
>6.1.2. <A >6.1.2. <A
HREF="cust-templates.html#AEN1620" HREF="cust-templates.html#AEN1611"
>How To Edit Templates</A >How To Edit Templates</A
></DT ></DT
><DT ><DT
>6.1.3. <A >6.1.3. <A
HREF="cust-templates.html#AEN1630" HREF="cust-templates.html#AEN1621"
>Template Formats</A >Template Formats</A
></DT ></DT
><DT ><DT
>6.1.4. <A >6.1.4. <A
HREF="cust-templates.html#AEN1643" HREF="cust-templates.html#AEN1634"
>Particular Templates</A >Particular Templates</A
></DT ></DT
><DT ><DT
......
docs/html/dbdoc.html
View file @ 96a0037a
...@@ -137,7 +137,7 @@ CLASS="section" ...@@ -137,7 +137,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1719" NAME="AEN1710"
></A ></A
>6.4.1. Bugzilla Database Basics</H2 >6.4.1. Bugzilla Database Basics</H2
><P ><P
...@@ -251,7 +251,7 @@ CLASS="section" ...@@ -251,7 +251,7 @@ CLASS="section"
><H3 ><H3
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1746" NAME="AEN1737"
></A ></A
>6.4.1.1. Bugzilla Database Tables</H3 >6.4.1.1. Bugzilla Database Tables</H3
><P ><P
......
docs/html/extraconfig.html
View file @ 96a0037a
...@@ -83,7 +83,7 @@ CLASS="section" ...@@ -83,7 +83,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN852" NAME="AEN843"
></A ></A
>4.3.1. Dependency Charts</H2 >4.3.1. Dependency Charts</H2
><P ><P
...@@ -147,7 +147,7 @@ CLASS="section" ...@@ -147,7 +147,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN867" NAME="AEN858"
></A ></A
>4.3.2. Bug Graphs</H2 >4.3.2. Bug Graphs</H2
><P ><P
...@@ -206,7 +206,7 @@ CLASS="section" ...@@ -206,7 +206,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN880" NAME="AEN871"
></A ></A
>4.3.3. The Whining Cron</H2 >4.3.3. The Whining Cron</H2
><P ><P
......
docs/html/faq.html
View file @ 96a0037a
...@@ -1974,7 +1974,7 @@ CLASS="answer" ...@@ -1974,7 +1974,7 @@ CLASS="answer"
><P ><P
>&#13; Microsoft has some advice on this matter, as well: >&#13; Microsoft has some advice on this matter, as well:
<A <A
NAME="AEN2062" NAME="AEN2053"
></A ></A
><BLOCKQUOTE ><BLOCKQUOTE
CLASS="BLOCKQUOTE" CLASS="BLOCKQUOTE"
......
docs/html/gfdl-howto.html
View file @ 96a0037a
...@@ -83,7 +83,7 @@ NAME="gfdl-howto" ...@@ -83,7 +83,7 @@ NAME="gfdl-howto"
of the License in the document and put the following copyright and of the License in the document and put the following copyright and
license notices just after the title page:</P license notices just after the title page:</P
><A ><A
NAME="AEN2282" NAME="AEN2273"
></A ></A
><BLOCKQUOTE ><BLOCKQUOTE
CLASS="BLOCKQUOTE" CLASS="BLOCKQUOTE"
......
docs/html/gfdl.html
View file @ 96a0037a
...@@ -146,7 +146,7 @@ HREF="gfdl-howto.html" ...@@ -146,7 +146,7 @@ HREF="gfdl-howto.html"
><P ><P
>Version 1.1, March 2000</P >Version 1.1, March 2000</P
><A ><A
NAME="AEN2192" NAME="AEN2183"
></A ></A
><BLOCKQUOTE ><BLOCKQUOTE
CLASS="BLOCKQUOTE" CLASS="BLOCKQUOTE"
......
docs/html/glossary.html
View file @ 96a0037a
...@@ -72,7 +72,7 @@ CLASS="glossdiv" ...@@ -72,7 +72,7 @@ CLASS="glossdiv"
><H1 ><H1
CLASS="glossdiv" CLASS="glossdiv"
><A ><A
NAME="AEN2287" NAME="AEN2278"
></A ></A
>0-9, high ascii</H1 >0-9, high ascii</H1
><DL ><DL
...@@ -936,7 +936,7 @@ NAME="gloss-zarro" ...@@ -936,7 +936,7 @@ NAME="gloss-zarro"
Terry had the following to say: Terry had the following to say:
</P </P
><A ><A
NAME="AEN2522" NAME="AEN2513"
></A ></A
><TABLE ><TABLE
BORDER="0" BORDER="0"
......
docs/html/hintsandtips.html
View file @ 96a0037a
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="hintsandtips" NAME="hintsandtips"
></A ></A
>3.7. Hints and Tips</H1 >3.8. Hints and Tips</H1
><P ><P
>This section distills some Bugzilla tips and best practices >This section distills some Bugzilla tips and best practices
that have been developed.</P that have been developed.</P
...@@ -86,9 +86,9 @@ CLASS="section" ...@@ -86,9 +86,9 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN358" NAME="AEN363"
></A ></A
>3.7.1. Autolinkification</H2 >3.8.1. Autolinkification</H2
><P ><P
>Bugzilla comments are plain text - so typing &#60;U&#62; will >Bugzilla comments are plain text - so typing &#60;U&#62; will
produce less-than, U, greater-than rather than underlined text. produce less-than, U, greater-than rather than underlined text.
...@@ -157,7 +157,7 @@ CLASS="section" ...@@ -157,7 +157,7 @@ CLASS="section"
><A ><A
NAME="quicksearch" NAME="quicksearch"
></A ></A
>3.7.2. Quicksearch</H2 >3.8.2. Quicksearch</H2
><P ><P
>Quicksearch is a single-text-box query tool which uses >Quicksearch is a single-text-box query tool which uses
metacharacters to indicate what is to be searched. For example, typing metacharacters to indicate what is to be searched. For example, typing
...@@ -190,7 +190,7 @@ CLASS="section" ...@@ -190,7 +190,7 @@ CLASS="section"
><A ><A
NAME="commenting" NAME="commenting"
></A ></A
>3.7.3. Comments</H2 >3.8.3. Comments</H2
><P ><P
>If you are changing the fields on a bug, only comment if >If you are changing the fields on a bug, only comment if
either you have something pertinent to say, or Bugzilla requires it. either you have something pertinent to say, or Bugzilla requires it.
...@@ -214,7 +214,7 @@ CLASS="section" ...@@ -214,7 +214,7 @@ CLASS="section"
><A ><A
NAME="attachments" NAME="attachments"
></A ></A
>3.7.4. Attachments</H2 >3.8.4. Attachments</H2
><P ><P
>&#13; Use attachments, rather than comments, for large chunks of ASCII data, >&#13; Use attachments, rather than comments, for large chunks of ASCII data,
such as trace, debugging output files, or log files. That way, it doesn't such as trace, debugging output files, or log files. That way, it doesn't
...@@ -233,31 +233,6 @@ NAME="attachments" ...@@ -233,31 +233,6 @@ NAME="attachments"
out of the bug. out of the bug.
</P </P
></DIV ></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="AEN388"
></A
>3.7.5. Filing Bugs</H2
><P
>Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
ensure your original information is easily accessible.
</P
><P
>&#13; You do not need to put "any" or similar strings in the URL field.
If there is no specific URL associated with the bug, leave this
field blank.
</P
><P
>If you feel a bug you filed was incorrectly marked as a
DUPLICATE of another, please question it in your bug, not
the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed.
</P
></DIV
></DIV ></DIV
><DIV ><DIV
CLASS="NAVFOOTER" CLASS="NAVFOOTER"
......
docs/html/index.html
View file @ 96a0037a
...@@ -158,46 +158,51 @@ HREF="using.html" ...@@ -158,46 +158,51 @@ HREF="using.html"
><DL ><DL
><DT ><DT
>3.1. <A >3.1. <A
HREF="using-intro.html"
>Introduction</A
></DT
><DT
>3.2. <A
HREF="myaccount.html" HREF="myaccount.html"
>Create a Bugzilla Account</A >Create a Bugzilla Account</A
></DT ></DT
><DT ><DT
>3.2. <A >3.3. <A
HREF="bug_page.html" HREF="bug_page.html"
>Anatomy of a Bug</A >Anatomy of a Bug</A
></DT ></DT
><DT ><DT
>3.3. <A >3.4. <A
HREF="query.html" HREF="query.html"
>Searching for Bugs</A >Searching for Bugs</A
></DT ></DT
><DT ><DT
>3.4. <A >3.5. <A
HREF="list.html" HREF="list.html"
>Bug Lists</A >Bug Lists</A
></DT ></DT
><DT ><DT
>3.5. <A >3.6. <A
HREF="bugreports.html" HREF="bugreports.html"
>Filing Bugs</A >Filing Bugs</A
></DT ></DT
><DT ><DT
>3.6. <A >3.7. <A
HREF="patchviewer.html" HREF="patchviewer.html"
>Patch Viewer</A >Patch Viewer</A
></DT ></DT
><DT ><DT
>3.7. <A >3.8. <A
HREF="hintsandtips.html" HREF="hintsandtips.html"
>Hints and Tips</A >Hints and Tips</A
></DT ></DT
><DT ><DT
>3.8. <A >3.9. <A
HREF="userpreferences.html" HREF="userpreferences.html"
>User Preferences</A >User Preferences</A
></DT ></DT
><DT ><DT
>3.9. <A >3.10. <A
HREF="reporting.html" HREF="reporting.html"
>Reports</A >Reports</A
></DT ></DT
......
docs/html/installation.html
View file @ 96a0037a
...@@ -110,20 +110,20 @@ HREF="stepbystep.html#install-bzfiles" ...@@ -110,20 +110,20 @@ HREF="stepbystep.html#install-bzfiles"
></DT ></DT
><DT ><DT
>4.1.5. <A >4.1.5. <A
HREF="stepbystep.html#install-perlmodules" HREF="stepbystep.html#AEN522"
>Perl Modules</A
></DT
><DT
>4.1.6. <A
HREF="stepbystep.html#AEN748"
><TT ><TT
CLASS="filename" CLASS="filename"
>checksetup.pl</TT >checksetup.pl</TT
></A ></A
></DT ></DT
><DT ><DT
>4.1.6. <A
HREF="stepbystep.html#install-perlmodules"
>Perl Modules</A
></DT
><DT
>4.1.7. <A >4.1.7. <A
HREF="stepbystep.html#AEN778" HREF="stepbystep.html#AEN768"
>Configuring Bugzilla</A >Configuring Bugzilla</A
></DT ></DT
></DL ></DL
...@@ -167,17 +167,17 @@ HREF="extraconfig.html" ...@@ -167,17 +167,17 @@ HREF="extraconfig.html"
><DL ><DL
><DT ><DT
>4.3.1. <A >4.3.1. <A
HREF="extraconfig.html#AEN852" HREF="extraconfig.html#AEN843"
>Dependency Charts</A >Dependency Charts</A
></DT ></DT
><DT ><DT
>4.3.2. <A >4.3.2. <A
HREF="extraconfig.html#AEN867" HREF="extraconfig.html#AEN858"
>Bug Graphs</A >Bug Graphs</A
></DT ></DT
><DT ><DT
>4.3.3. <A >4.3.3. <A
HREF="extraconfig.html#AEN880" HREF="extraconfig.html#AEN871"
>The Whining Cron</A >The Whining Cron</A
></DT ></DT
><DT ><DT
...@@ -276,12 +276,12 @@ HREF="troubleshooting.html" ...@@ -276,12 +276,12 @@ HREF="troubleshooting.html"
><DL ><DL
><DT ><DT
>4.6.1. <A >4.6.1. <A
HREF="troubleshooting.html#AEN1215" HREF="troubleshooting.html#AEN1206"
>Bundle::Bugzilla makes me upgrade to Perl 5.6.1</A >Bundle::Bugzilla makes me upgrade to Perl 5.6.1</A
></DT ></DT
><DT ><DT
>4.6.2. <A >4.6.2. <A
HREF="troubleshooting.html#AEN1220" HREF="troubleshooting.html#AEN1211"
>DBD::Sponge::db prepare failed</A >DBD::Sponge::db prepare failed</A
></DT ></DT
><DT ><DT
......
docs/html/list.html
View file @ 96a0037a
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="list" NAME="list"
></A ></A
>3.4. Bug Lists</H1 >3.5. Bug Lists</H1
><P ><P
>If you run a search, a list of matching bugs will be returned. >If you run a search, a list of matching bugs will be returned.
</P </P
...@@ -102,6 +102,15 @@ BORDER="0" ...@@ -102,6 +102,15 @@ BORDER="0"
><TR ><TR
><TD ><TD
>&#13; <EM >&#13; <EM
>CSV:</EM
>
get the buglist as comma-separated values, for import into e.g.
a spreadsheet.</TD
></TR
><TR
><TD
>&#13; <EM
>Change Columns:</EM >Change Columns:</EM
> >
...@@ -128,13 +137,23 @@ BORDER="0" ...@@ -128,13 +137,23 @@ BORDER="0"
><TR ><TR
><TD ><TD
>&#13; <EM >&#13; <EM
>Edit this query:</EM >Edit Search:</EM
> >
If you didn't get exactly the results you were looking for, you can 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 return to the Query page through this link and make small revisions
to the query you just made so you get more accurate results.</TD to the query you just made so you get more accurate results.</TD
></TR ></TR
><TR
><TD
>&#13; <EM
>Remember Search As:</EM
>
You can give a search a name and remember it; a link will appear
in your page footer giving you quick access to run it again later.
</TD
></TR
></TBODY ></TBODY
></TABLE ></TABLE
><P ><P
......
docs/html/myaccount.html
View file @ 96a0037a
...@@ -14,8 +14,8 @@ REL="UP" ...@@ -14,8 +14,8 @@ REL="UP"
TITLE="Using Bugzilla" TITLE="Using Bugzilla"
HREF="using.html"><LINK HREF="using.html"><LINK
REL="PREVIOUS" REL="PREVIOUS"
TITLE="Using Bugzilla" TITLE="Introduction"
HREF="using.html"><LINK HREF="using-intro.html"><LINK
REL="NEXT" REL="NEXT"
TITLE="Anatomy of a Bug" TITLE="Anatomy of a Bug"
HREF="bug_page.html"></HEAD HREF="bug_page.html"></HEAD
...@@ -47,7 +47,7 @@ WIDTH="10%" ...@@ -47,7 +47,7 @@ WIDTH="10%"
ALIGN="left" ALIGN="left"
VALIGN="bottom" VALIGN="bottom"
><A ><A
HREF="using.html" HREF="using-intro.html"
ACCESSKEY="P" ACCESSKEY="P"
>Prev</A >Prev</A
></TD ></TD
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="myaccount" NAME="myaccount"
></A ></A
>3.1. Create a Bugzilla Account</H1 >3.2. Create a Bugzilla Account</H1
><P ><P
>If you want to use Bugzilla, first you need to create an account. >If you want to use Bugzilla, first you need to create an account.
Consult with the administrator responsible for your installation of Consult with the administrator responsible for your installation of
...@@ -156,7 +156,7 @@ WIDTH="33%" ...@@ -156,7 +156,7 @@ WIDTH="33%"
ALIGN="left" ALIGN="left"
VALIGN="top" VALIGN="top"
><A ><A
HREF="using.html" HREF="using-intro.html"
ACCESSKEY="P" ACCESSKEY="P"
>Prev</A >Prev</A
></TD ></TD
...@@ -184,7 +184,7 @@ ACCESSKEY="N" ...@@ -184,7 +184,7 @@ ACCESSKEY="N"
WIDTH="33%" WIDTH="33%"
ALIGN="left" ALIGN="left"
VALIGN="top" VALIGN="top"
>Using Bugzilla</TD >Introduction</TD
><TD ><TD
WIDTH="34%" WIDTH="34%"
ALIGN="center" ALIGN="center"
......
docs/html/newversions.html
View file @ 96a0037a
...@@ -87,25 +87,23 @@ NAME="newversions" ...@@ -87,25 +87,23 @@ NAME="newversions"
</P </P
><P ><P
>&#13; The newest version of this guide can always be found at <A >&#13; The latest version of this guide can always be found at <A
HREF="http://www.bugzilla.org" HREF="http://www.bugzilla.org"
TARGET="_top" TARGET="_top"
>http://www.bugzilla.org</A >http://www.bugzilla.org</A
>; however, you should read the version >, or checked out via CVS.
which came with the Bugzilla release you are using. (Please follow the <A
</P
><P
>&#13; The latest version of this document can always be checked out via CVS.
Please follow the <A
HREF="http://www.mozilla.org/cvs.html" HREF="http://www.mozilla.org/cvs.html"
TARGET="_top" TARGET="_top"
>Mozilla CVS</A >Mozilla
> CVS</A
instructions and check out the <TT > instructions and check out the
<TT
CLASS="filename" CLASS="filename"
>mozilla/webtools/bugzilla/docs/</TT >mozilla/webtools/bugzilla/docs/</TT
> >
subtree. subtree.) However, you should read the version
which came with the Bugzilla release you are using.
</P </P
><P ><P
>&#13; The Bugzilla Guide is currently only available in English. >&#13; The Bugzilla Guide is currently only available in English.
......
docs/html/os-specific.html
View file @ 96a0037a
...@@ -152,7 +152,7 @@ NAME="win32-perlmodules" ...@@ -152,7 +152,7 @@ NAME="win32-perlmodules"
>Bugzilla on Windows requires the same perl modules found in >Bugzilla on Windows requires the same perl modules found in
<A <A
HREF="stepbystep.html#install-perlmodules" HREF="stepbystep.html#install-perlmodules"
>Section 4.1.5</A >Section 4.1.6</A
>. The main difference is that >. The main difference is that
windows uses <A windows uses <A
HREF="glossary.html#gloss-ppm" HREF="glossary.html#gloss-ppm"
......
docs/html/patchviewer.html
View file @ 96a0037a
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="patchviewer" NAME="patchviewer"
></A ></A
>3.6. Patch Viewer</H1 >3.7. Patch Viewer</H1
><P ><P
>Viewing and reviewing patches in Bugzilla is often difficult due to >Viewing and reviewing patches in Bugzilla is often difficult due to
lack of context, improper format and the inherent readability issues that lack of context, improper format and the inherent readability issues that
...@@ -135,7 +135,7 @@ CLASS="section" ...@@ -135,7 +135,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_view" NAME="patchviewer_view"
></A ></A
>3.6.1. Viewing Patches in Patch Viewer</H2 >3.7.1. Viewing Patches in Patch Viewer</H2
><P ><P
>The main way to view a patch in patch viewer is to click on the >The main way to view a patch in patch viewer is to click on the
"Diff" link next to a patch in the Attachments list on a bug. You may "Diff" link next to a patch in the Attachments list on a bug. You may
...@@ -149,7 +149,7 @@ CLASS="section" ...@@ -149,7 +149,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_diff" NAME="patchviewer_diff"
></A ></A
>3.6.2. Seeing the Difference Between Two Patches</H2 >3.7.2. Seeing the Difference Between Two Patches</H2
><P ><P
>To see the difference between two patches, you must first view the >To see the difference between two patches, you must first view the
newer patch in Patch Viewer. Then select the older patch from the newer patch in Patch Viewer. Then select the older patch from the
...@@ -164,7 +164,7 @@ CLASS="section" ...@@ -164,7 +164,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_context" NAME="patchviewer_context"
></A ></A
>3.6.3. Getting More Context in a Patch</H2 >3.7.3. Getting More Context in a Patch</H2
><P ><P
>To get more context in a patch, you put a number in the textbox at >To get more context in a patch, you put a number in the textbox at
the top of Patch Viewer ("Patch / File / [textbox]") and hit enter. the top of Patch Viewer ("Patch / File / [textbox]") and hit enter.
...@@ -180,7 +180,7 @@ CLASS="section" ...@@ -180,7 +180,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_collapse" NAME="patchviewer_collapse"
></A ></A
>3.6.4. Collapsing and Expanding Sections of a Patch</H2 >3.7.4. Collapsing and Expanding Sections of a Patch</H2
><P ><P
>To view only a certain set of files in a patch (for example, if a >To view only a certain set of files in a patch (for example, if a
patch is absolutely huge and you want to only review part of it at a patch is absolutely huge and you want to only review part of it at a
...@@ -196,7 +196,7 @@ CLASS="section" ...@@ -196,7 +196,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_link" NAME="patchviewer_link"
></A ></A
>3.6.5. Linking to a Section of a Patch</H2 >3.7.5. Linking to a Section of a Patch</H2
><P ><P
>To link to a section of a patch (for example, if you want to be >To link to a section of a patch (for example, if you want to be
able to give someone a URL to show them which part you are talking able to give someone a URL to show them which part you are talking
...@@ -211,7 +211,7 @@ CLASS="section" ...@@ -211,7 +211,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_bonsai_lxr" NAME="patchviewer_bonsai_lxr"
></A ></A
>3.6.6. Going to Bonsai and LXR</H2 >3.7.6. Going to Bonsai and LXR</H2
><P ><P
>To go to Bonsai to get blame for the lines you are interested in, >To go to Bonsai to get blame for the lines you are interested in,
you can click the "Lines XX-YY" link on the section header you are you can click the "Lines XX-YY" link on the section header you are
...@@ -229,7 +229,7 @@ CLASS="section" ...@@ -229,7 +229,7 @@ CLASS="section"
><A ><A
NAME="patchviewer_unified_diff" NAME="patchviewer_unified_diff"
></A ></A
>3.6.7. Creating a Unified Diff</H2 >3.7.7. Creating a Unified Diff</H2
><P ><P
>If the patch is not in a format that you like, you can turn it >If the patch is not in a format that you like, you can turn it
into a unified diff format by clicking the "Raw Unified" link at the top into a unified diff format by clicking the "Raw Unified" link at the top
......
docs/html/query.html
View file @ 96a0037a
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="query" NAME="query"
></A ></A
>3.3. Searching for Bugs</H1 >3.4. Searching for Bugs</H1
><P ><P
>The Bugzilla Search page is is the interface where you can find >The Bugzilla Search page is is the interface where you can find
any bug report, comment, or patch currently in the Bugzilla system. You any bug report, comment, or patch currently in the Bugzilla system. You
......
docs/html/reporting.html
View file @ 96a0037a
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="reporting" NAME="reporting"
></A ></A
>3.9. Reports</H1 >3.10. Reports</H1
><P ><P
><EM ><EM
>To be written</EM >To be written</EM
......
docs/html/stepbystep.html
View file @ 96a0037a
...@@ -90,7 +90,8 @@ CLASS="productname" ...@@ -90,7 +90,8 @@ CLASS="productname"
<A <A
HREF="os-specific.html" HREF="os-specific.html"
>Section 4.4</A >Section 4.4</A
>, so be sure to check out that section before >, so unless you are on Linux,
be sure to check out that section before
you start your installation. you start your installation.
</P </P
><DIV ><DIV
...@@ -148,7 +149,8 @@ ALIGN="LEFT" ...@@ -148,7 +149,8 @@ ALIGN="LEFT"
VALIGN="TOP" VALIGN="TOP"
><P ><P
>While installing Bugzilla, it is a good idea to ensure that there >While installing Bugzilla, it is a good idea to ensure that there
is some kind of firewall between you and the rest of the Internet is some kind of configurable firewall between you and the rest of the
Internet
as your machine may be insecure for periods during the install. Many as your machine may be insecure for periods during the install. Many
installation steps require an active Internet connection to complete, installation steps require an active Internet connection to complete,
but you must take care to ensure that at no point is your machine but you must take care to ensure that at no point is your machine
...@@ -160,19 +162,18 @@ VALIGN="TOP" ...@@ -160,19 +162,18 @@ VALIGN="TOP"
><P ><P
>This guide assumes that you already have your operating system >This guide assumes that you already have your operating system
installed, network configured, and have administrative access to the installed, network configured, and have administrative access to the
shell on the machine you are installing Bugzilla onto. It is possible to machine onto which you are installing Bugzilla. It is possible to
install and run Bugzilla without administrative access, but you have to install and run Bugzilla itself without administrative access, but you
have to
either make sure all the required software is installed or get somebody either make sure all the required software is installed or get somebody
with administrative access to install it for you. with administrative access to install it for you.
</P </P
><P ><P
>&#13; You are strongly recommended to make a backup of your system >&#13; You are strongly recommended to make a backup of your system
before installing Bugzilla and at regular intervals thereafter. before installing Bugzilla (and at regular intervals thereafter :-).
</P </P
><P ><P
>The listing below is a basic step-by-step list. More information >Here's a basic step-by-step list:
can be found in the sections below. Minimum versions will be
included in parenthesis where appropriate.
</P </P
><DIV ><DIV
CLASS="procedure" CLASS="procedure"
...@@ -184,7 +185,7 @@ TYPE="1" ...@@ -184,7 +185,7 @@ TYPE="1"
HREF="stepbystep.html#install-perl" HREF="stepbystep.html#install-perl"
>Install Perl</A >Install Perl</A
> >
(5.6) (5.6.0 or above)
</P </P
></LI ></LI
><LI ><LI
...@@ -193,7 +194,7 @@ HREF="stepbystep.html#install-perl" ...@@ -193,7 +194,7 @@ HREF="stepbystep.html#install-perl"
HREF="stepbystep.html#install-mysql" HREF="stepbystep.html#install-mysql"
>Install MySQL</A >Install MySQL</A
> >
(3.23.41) (3.23.41 or above)
</P </P
></LI ></LI
><LI ><LI
...@@ -240,17 +241,18 @@ NAME="install-perl" ...@@ -240,17 +241,18 @@ NAME="install-perl"
>4.1.1. Perl</H2 >4.1.1. Perl</H2
><P ><P
>Any machine that doesn't have Perl on it is a sad machine indeed. >Any machine that doesn't have Perl on it is a sad machine indeed.
Perl can be got in source form from <A If your OS doesn't come with it, Perl can be got in source form
from <A
HREF="http://www.perl.com" HREF="http://www.perl.com"
TARGET="_top" TARGET="_top"
>http://www.perl.com</A >http://www.perl.com</A
>. >.
There are also binary versions available for many platforms, most of which There are also binary versions available for many platforms, most of which
are linked to from perl.com. are linked to from perl.com.
Although Bugzilla runs with perl 5.6, Although Bugzilla runs with perl 5.6.0,
it's a good idea to be up to the very latest version it's a good idea to be up to the very latest version
if you can when running Bugzilla. As of this writing, that is Perl if you can when running Bugzilla. As of this writing, that is Perl
version 5.8.</P version 5.8.2.</P
></DIV ></DIV
><DIV ><DIV
CLASS="section" CLASS="section"
...@@ -261,7 +263,8 @@ NAME="install-mysql" ...@@ -261,7 +263,8 @@ NAME="install-mysql"
></A ></A
>4.1.2. MySQL</H2 >4.1.2. MySQL</H2
><P ><P
>Visit the MySQL homepage at >If your OS doesn't come with it or provide official packages,
visit the MySQL homepage at
<A <A
HREF="http://www.mysql.com" HREF="http://www.mysql.com"
TARGET="_top" TARGET="_top"
...@@ -360,7 +363,7 @@ set-variable = max_allowed_packet=1M ...@@ -360,7 +363,7 @@ set-variable = max_allowed_packet=1M
>If you are running Bugzilla and MySQL on the same machine, you may >If you are running Bugzilla and MySQL on the same machine, you may
also wish to utilize the <TT also wish to utilize the <TT
CLASS="option" CLASS="option"
>skip-networking</TT >--skip-networking</TT
> option as > option as
mentioned in <A mentioned in <A
HREF="security.html#security-mysql" HREF="security.html#security-mysql"
...@@ -374,7 +377,7 @@ CLASS="section" ...@@ -374,7 +377,7 @@ CLASS="section"
><A ><A
NAME="install-setupdatabase" NAME="install-setupdatabase"
></A ></A
>4.1.2.1. Configuring MySQL</H3 >4.1.2.1. Adding a user to MySQL</H3
><P ><P
>This first thing you'll want to do is make sure you've given the >This first thing you'll want to do is make sure you've given the
<SPAN <SPAN
...@@ -384,7 +387,8 @@ CLASS="QUOTE" ...@@ -384,7 +387,8 @@ CLASS="QUOTE"
<A <A
HREF="security.html#security-mysql" HREF="security.html#security-mysql"
>Section 4.5.2</A >Section 4.5.2</A
>. For clarity, these instructions will >. Then, you need to add a user for
Bugzilla to use. For clarity, these instructions will
assume that your MySQL user for Bugzilla will be <SPAN assume that your MySQL user for Bugzilla will be <SPAN
CLASS="QUOTE" CLASS="QUOTE"
>"bugs_user"</SPAN >"bugs_user"</SPAN
...@@ -427,14 +431,14 @@ VALIGN="TOP" ...@@ -427,14 +431,14 @@ VALIGN="TOP"
CLASS="QUOTE" CLASS="QUOTE"
>"bugs"</SPAN >"bugs"</SPAN
> for both the user and > for both the user and
database name. database name. Don't use it for the password, though...
</P </P
></TD ></TD
></TR ></TR
></TABLE ></TABLE
></DIV ></DIV
><P ><P
>Next, we use an SQL <B >We use an SQL <B
CLASS="command" CLASS="command"
>GRANT</B >GRANT</B
> command to create a > command to create a
...@@ -442,8 +446,7 @@ CLASS="command" ...@@ -442,8 +446,7 @@ CLASS="command"
CLASS="QUOTE" CLASS="QUOTE"
>"bugs_user"</SPAN >"bugs_user"</SPAN
> >
user, and grant sufficient permissions for checksetup.pl, which we'll user. This also restricts the
use later, to work its magic. This also restricts the
<SPAN <SPAN
CLASS="QUOTE" CLASS="QUOTE"
>"bugs_user"</SPAN >"bugs_user"</SPAN
...@@ -513,7 +516,12 @@ CLASS="computeroutput" ...@@ -513,7 +516,12 @@ CLASS="computeroutput"
<TT <TT
CLASS="computeroutput" CLASS="computeroutput"
>CREATE TEMPORARY TABLES</TT >CREATE TEMPORARY TABLES</TT
> permissions. > permissions,
so add them to the list in the
<TT
CLASS="computeroutput"
>GRANT</TT
> command.
</P </P
></TD ></TD
></TR ></TR
...@@ -623,32 +631,30 @@ ALT="Tip"></TD ...@@ -623,32 +631,30 @@ ALT="Tip"></TD
ALIGN="LEFT" ALIGN="LEFT"
VALIGN="TOP" VALIGN="TOP"
><P ><P
>If you symlink the bugzilla directory into your Apache's HTML >If you symlink the bugzilla directory into your Apache's
<TT
CLASS="filename"
>html</TT
>
hierarchy, you may receive hierarchy, you may receive
<SPAN <SPAN
CLASS="errorname" CLASS="errorname"
>Forbidden</SPAN >Forbidden</SPAN
> >
errors unless you add the errors unless you add the
<SPAN <TT
CLASS="QUOTE" CLASS="filename"
>"FollowSymLinks"</SPAN >FollowSymLinks</TT
> >
directive to the &#60;Directory&#62; entry for the HTML root directive to the <TT
in httpd.conf.</P CLASS="filename"
>&#60;Directory&#62;</TT
> entry for
the HTML root directory in httpd.conf.</P
></TD ></TD
></TR ></TR
></TABLE ></TABLE
></DIV ></DIV
><P
>Once all the files are in a web accessible directory, make that
directory writable by your webserver's user. This is a temporary step
until you run the post-install
<TT
CLASS="filename"
>checksetup.pl</TT
>
script, which locks down your installation.</P
><DIV ><DIV
CLASS="caution" CLASS="caution"
><P ><P
...@@ -685,6 +691,166 @@ CLASS="option" ...@@ -685,6 +691,166 @@ CLASS="option"
></TR ></TR
></TABLE ></TABLE
></DIV ></DIV
><P
>Once all the files are in a web accessible directory, make that
directory writable by your webserver's user. This is a temporary step
until you run the post-install
<TT
CLASS="filename"
>checksetup.pl</TT
>
script, which locks down your installation.</P
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="AEN522"
></A
>4.1.5. <TT
CLASS="filename"
>checksetup.pl</TT
></H2
><P
>Next, run the magic checksetup.pl script.
This is designed to check whether you have all of the right
Perl modules in the correct
versions, and that Bugzilla is generally set up correctly.
</P
><P
>&#13; Eventually,
it will make sure Bugzilla files and directories have reasonable
permissions, set up the
<TT
CLASS="filename"
>data</TT
>
directory, and create all the MySQL tables. But the first time you
run it, it's highly likely to tell you that you are missing a few
Perl modules. Make a note of which ones they are, and then proceed to
the next section to install them.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="screen"
>&#13;<TT
CLASS="prompt"
>bash#</TT
> ./checksetup.pl
</PRE
></FONT
></TD
></TR
></TABLE
><P
>&#13; The first time you run it with all the correct modules installed,
it will create a file called
<TT
CLASS="filename"
>localconfig</TT
>.</P
><P
>This file contains a variety of settings you may need to tweak
including how Bugzilla should connect to the MySQL database.</P
><P
>The connection settings include:
<P
></P
><OL
TYPE="1"
><LI
><P
>server's host: just use
<SPAN
CLASS="QUOTE"
>"localhost"</SPAN
>
if the MySQL server is local</P
></LI
><LI
><P
>database name:
<SPAN
CLASS="QUOTE"
>"bugs_db"</SPAN
>
if you're following these directions</P
></LI
><LI
><P
>MySQL username:
<SPAN
CLASS="QUOTE"
>"bugs_user"</SPAN
>
if you're following these directions</P
></LI
><LI
><P
>Password for the
<SPAN
CLASS="QUOTE"
>"bugs_user"</SPAN
>
MySQL account; (<SPAN
CLASS="QUOTE"
>"bugs_password"</SPAN
> above)</P
></LI
></OL
>
</P
><P
>Edit the file to change these. Once you are happy with the
settings, <TT
CLASS="filename"
>su</TT
> to the user
your web server runs as, and re-run
<TT
CLASS="filename"
>checksetup.pl</TT
>. (Note: on some security-conscious
systems, you may need to change the login shell for the webserver
account before you can do this.)
On this second run, it will create the database and an administrator
account for which you will be prompted to provide information.</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The checksetup.pl script is designed so that you can run it at
any time without causing harm. You should run it after any upgrade to
Bugzilla.</P
></TD
></TR
></TABLE
></DIV
></DIV ></DIV
><DIV ><DIV
CLASS="section" CLASS="section"
...@@ -693,7 +859,15 @@ CLASS="section" ...@@ -693,7 +859,15 @@ CLASS="section"
><A ><A
NAME="install-perlmodules" NAME="install-perlmodules"
></A ></A
>4.1.5. Perl Modules</H2 >4.1.6. Perl Modules</H2
><P
>Don't be intimidated by this long list of modules. See
<A
HREF="stepbystep.html#install-modules-bundle-bugzilla"
>Section 4.1.6.1</A
> for a way of
installing all the ones you need with a single command.
</P
><P ><P
>Perl modules can be found using >Perl modules can be found using
<A <A
...@@ -709,8 +883,7 @@ HREF="glossary.html#gloss-ppm" ...@@ -709,8 +883,7 @@ HREF="glossary.html#gloss-ppm"
CLASS="glossterm" CLASS="glossterm"
>PPM</I >PPM</I
></A ></A
> on Win32. The root servers > on Win32.
have a real tendency to bog down, so please use mirrors.
</P </P
><P ><P
>Good instuctions can be found for using each of these services on >Good instuctions can be found for using each of these services on
...@@ -930,15 +1103,6 @@ HREF="stepbystep.html#install-modules-bundle-bugzilla" ...@@ -930,15 +1103,6 @@ HREF="stepbystep.html#install-modules-bundle-bugzilla"
><LI ><LI
><P ><P
>&#13; <A >&#13; <A
HREF="stepbystep.html#install-modules-appconfig"
>AppConfig</A
>
(1.52)
</P
></LI
><LI
><P
>&#13; <A
HREF="stepbystep.html#install-modules-cgi" HREF="stepbystep.html#install-modules-cgi"
>CGI</A >CGI</A
> >
...@@ -948,15 +1112,6 @@ HREF="stepbystep.html#install-modules-cgi" ...@@ -948,15 +1112,6 @@ HREF="stepbystep.html#install-modules-cgi"
><LI ><LI
><P ><P
>&#13; <A >&#13; <A
HREF="stepbystep.html#install-modules-data-dumper"
>Data::Dumper</A
>
(any)
</P
></LI
><LI
><P
>&#13; <A
HREF="stepbystep.html#install-modules-date-format" HREF="stepbystep.html#install-modules-date-format"
>Date::Format</A >Date::Format</A
> >
...@@ -1098,7 +1253,7 @@ CLASS="section" ...@@ -1098,7 +1253,7 @@ CLASS="section"
><A ><A
NAME="install-modules-bundle-bugzilla" NAME="install-modules-bundle-bugzilla"
></A ></A
>4.1.5.1. Bundle::Bugzilla</H3 >4.1.6.1. Bundle::Bugzilla</H3
><P ><P
>If you are running at least perl 5.6.1, you can save yourself a lot >If you are running at least perl 5.6.1, you can save yourself a lot
of time by using Bundle::Bugzilla. This bundle contains every module of time by using Bundle::Bugzilla. This bundle contains every module
...@@ -1175,22 +1330,9 @@ CLASS="section" ...@@ -1175,22 +1330,9 @@ CLASS="section"
><H3 ><H3
CLASS="section" CLASS="section"
><A ><A
NAME="install-modules-appconfig"
></A
>4.1.5.2. AppConfig (1.52)</H3
><P
>Dependency for Template Toolkit. We probably don't need to
specifically check for it anymore.
</P
></DIV
><DIV
CLASS="section"
><H3
CLASS="section"
><A
NAME="install-modules-cgi" NAME="install-modules-cgi"
></A ></A
>4.1.5.3. CGI (2.88)</H3 >4.1.6.2. CGI (2.88)</H3
><P ><P
>The CGI module parses form elements and cookies and does many >The CGI module parses form elements and cookies and does many
other usefule things. It come as a part of recent perl distributions, but other usefule things. It come as a part of recent perl distributions, but
...@@ -1221,43 +1363,9 @@ CLASS="section" ...@@ -1221,43 +1363,9 @@ CLASS="section"
><H3 ><H3
CLASS="section" CLASS="section"
><A ><A
NAME="install-modules-data-dumper"
></A
>4.1.5.4. Data::Dumper (any)</H3
><P
>The Data::Dumper module provides data structure persistence for
Perl (similar to Java's serialization). It comes with later
sub-releases of Perl 5.004, but a re-installation just to be sure it's
available won't hurt anything.
</P
><P
CLASS="literallayout"
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CPAN&nbsp;Download&nbsp;Page:&nbsp;<A
HREF="http://search.cpan.org/dist/Data-Dumper/"
TARGET="_top"
>http://search.cpan.org/dist/Data-Dumper/</A
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;PPM&nbsp;Download&nbsp;Link:&nbsp;<A
HREF="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Data-Dumper.zip"
TARGET="_top"
>http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Data-Dumper.zip</A
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Documentation:&nbsp;<A
HREF="http://www.perldoc.com/perl5.8.0/lib/Data/Dumper.html"
TARGET="_top"
>http://www.perldoc.com/perl5.8.0/lib/Data/Dumper.html</A
><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</P
></DIV
><DIV
CLASS="section"
><H3
CLASS="section"
><A
NAME="install-modules-date-format" NAME="install-modules-date-format"
></A ></A
>4.1.5.5. TimeDate modules (2.21)</H3 >4.1.6.3. TimeDate modules (2.21)</H3
><P ><P
>Many of the more common date/time/calendar related Perl modules >Many of the more common date/time/calendar related Perl modules
have been grouped into a bundle similar to the MySQL modules bundle. have been grouped into a bundle similar to the MySQL modules bundle.
...@@ -1292,7 +1400,7 @@ CLASS="section" ...@@ -1292,7 +1400,7 @@ CLASS="section"
><A ><A
NAME="install-modules-dbi" NAME="install-modules-dbi"
></A ></A
>4.1.5.6. DBI (1.32)</H3 >4.1.6.4. DBI (1.32)</H3
><P ><P
>The DBI module is a generic Perl module used the >The DBI module is a generic Perl module used the
MySQL-related modules. As long as your Perl installation was done MySQL-related modules. As long as your Perl installation was done
...@@ -1326,7 +1434,7 @@ CLASS="section" ...@@ -1326,7 +1434,7 @@ CLASS="section"
><A ><A
NAME="install-modules-dbd-mysql" NAME="install-modules-dbd-mysql"
></A ></A
>4.1.5.7. MySQL-related modules</H3 >4.1.6.5. MySQL-related modules</H3
><P ><P
>The Perl/MySQL interface requires a few mutually-dependent Perl >The Perl/MySQL interface requires a few mutually-dependent Perl
modules. These modules are grouped together into the the modules. These modules are grouped together into the the
...@@ -1371,7 +1479,7 @@ CLASS="section" ...@@ -1371,7 +1479,7 @@ CLASS="section"
><A ><A
NAME="install-file-spec" NAME="install-file-spec"
></A ></A
>4.1.5.8. File::Spec (0.82)</H3 >4.1.6.6. File::Spec (0.82)</H3
><P ><P
>File::Spec is a perl module that allows file operations, such as >File::Spec is a perl module that allows file operations, such as
generating full path names, to work cross platform. generating full path names, to work cross platform.
...@@ -1403,7 +1511,7 @@ CLASS="section" ...@@ -1403,7 +1511,7 @@ CLASS="section"
><A ><A
NAME="install-modules-file-temp" NAME="install-modules-file-temp"
></A ></A
>4.1.5.9. File::Temp (any)</H3 >4.1.6.7. File::Temp (any)</H3
><P ><P
>File::Temp is used to generate a temporary filename that is >File::Temp is used to generate a temporary filename that is
guaranteed to be unique. It comes as a standard part of perl guaranteed to be unique. It comes as a standard part of perl
...@@ -1435,7 +1543,7 @@ CLASS="section" ...@@ -1435,7 +1543,7 @@ CLASS="section"
><A ><A
NAME="install-modules-template" NAME="install-modules-template"
></A ></A
>4.1.5.10. Template Toolkit (2.08)</H3 >4.1.6.8. Template Toolkit (2.08)</H3
><P ><P
>When you install Template Toolkit, you'll get asked various >When you install Template Toolkit, you'll get asked various
questions about features to enable. The defaults are fine, except questions about features to enable. The defaults are fine, except
...@@ -1469,7 +1577,7 @@ CLASS="section" ...@@ -1469,7 +1577,7 @@ CLASS="section"
><A ><A
NAME="install-modules-text-wrap" NAME="install-modules-text-wrap"
></A ></A
>4.1.5.11. Text::Wrap (2001.0131)</H3 >4.1.6.9. Text::Wrap (2001.0131)</H3
><P ><P
>Text::Wrap is designed to proved intelligent text wrapping. >Text::Wrap is designed to proved intelligent text wrapping.
</P </P
...@@ -1495,14 +1603,10 @@ CLASS="section" ...@@ -1495,14 +1603,10 @@ CLASS="section"
><A ><A
NAME="install-modules-gd" NAME="install-modules-gd"
></A ></A
>4.1.5.12. GD (1.20) [optional]</H3 >4.1.6.10. GD (1.20) [optional]</H3
><P ><P
>The GD library was written by Thomas Boutell a long while ago to >You need the GD library if you want any of the graphing to work.
programmatically generate images in C. Since then it's become the </P
defacto standard for programmatic image construction. The Perl bindings
to it found in the GD library are used on millions of web pages to
generate graphs on the fly. That's what Bugzilla will be using it for
so you must install it if you want any of the graphing to work.</P
><DIV ><DIV
CLASS="note" CLASS="note"
><P ><P
...@@ -1605,7 +1709,7 @@ CLASS="section" ...@@ -1605,7 +1709,7 @@ CLASS="section"
><A ><A
NAME="install-modules-chart-base" NAME="install-modules-chart-base"
></A ></A
>4.1.5.13. Chart::Base (0.99c) [optional]</H3 >4.1.6.11. Chart::Base (0.99c) [optional]</H3
><P ><P
>The Chart module provides Bugzilla with on-the-fly charting >The Chart module provides Bugzilla with on-the-fly charting
abilities. It can be installed in the usual fashion after it has been abilities. It can be installed in the usual fashion after it has been
...@@ -1634,7 +1738,7 @@ CLASS="section" ...@@ -1634,7 +1738,7 @@ CLASS="section"
><A ><A
NAME="install-modules-xml-parser" NAME="install-modules-xml-parser"
></A ></A
>4.1.5.14. XML::Parser (any) [Optional]</H3 >4.1.6.12. XML::Parser (any) [optional]</H3
><P ><P
>XML::Parser is used by the <TT >XML::Parser is used by the <TT
CLASS="filename" CLASS="filename"
...@@ -1669,7 +1773,7 @@ CLASS="section" ...@@ -1669,7 +1773,7 @@ CLASS="section"
><A ><A
NAME="install-modules-gd-graph" NAME="install-modules-gd-graph"
></A ></A
>4.1.5.15. GD::Graph (any) [Optional]</H3 >4.1.6.13. GD::Graph (any) [optional]</H3
><P ><P
>In addition to GD listed above, the reporting interface of Bugzilla >In addition to GD listed above, the reporting interface of Bugzilla
needs to have the GD::Graph module installed. needs to have the GD::Graph module installed.
...@@ -1701,7 +1805,7 @@ CLASS="section" ...@@ -1701,7 +1805,7 @@ CLASS="section"
><A ><A
NAME="install-modules-gd-text-align" NAME="install-modules-gd-text-align"
></A ></A
>4.1.5.16. GD::Text::Align (any) [Optional]</H3 >4.1.6.14. GD::Text::Align (any) [optional]</H3
><P ><P
>GD::Text::Align, as the name implies, is used to draw aligned >GD::Text::Align, as the name implies, is used to draw aligned
strings of text. It is needed by the reporting interface. strings of text. It is needed by the reporting interface.
...@@ -1733,7 +1837,7 @@ CLASS="section" ...@@ -1733,7 +1837,7 @@ CLASS="section"
><A ><A
NAME="install-modules-mime-parser" NAME="install-modules-mime-parser"
></A ></A
>4.1.5.17. MIME::Parser (any) [Optional]</H3 >4.1.6.15. MIME::Parser (any) [optional]</H3
><P ><P
>MIME::Parser is only needed if you want to use the e-mail interface >MIME::Parser is only needed if you want to use the e-mail interface
located in the <TT located in the <TT
...@@ -1768,7 +1872,7 @@ CLASS="section" ...@@ -1768,7 +1872,7 @@ CLASS="section"
><A ><A
NAME="install-modules-patchreader" NAME="install-modules-patchreader"
></A ></A
>4.1.5.18. PatchReader (0.9.1) [Optional]</H3 >4.1.6.16. PatchReader (0.9.1) [optional]</H3
><P ><P
>PatchReader is only needed if you want to use Patch Viewer, a >PatchReader is only needed if you want to use Patch Viewer, a
Bugzilla feature to format patches in a pretty HTML fashion. There are a Bugzilla feature to format patches in a pretty HTML fashion. There are a
...@@ -1804,154 +1908,15 @@ CLASS="section" ...@@ -1804,154 +1908,15 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN748" NAME="AEN768"
></A ></A
>4.1.6. <TT >4.1.7. Configuring Bugzilla</H2
CLASS="filename"
>checksetup.pl</TT
></H2
><P
>Next, run the magic checksetup.pl script.
This is designed to make sure your perl modules are the correct
version and your MySQL database and other
configuration options are consistent with the Bugzilla CGI files.
It will make sure Bugzilla files and directories have reasonable
permissions, set up the
<TT
CLASS="filename"
>data</TT
>
directory, and create all the MySQL tables.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="screen"
>&#13;<TT
CLASS="prompt"
>bash#</TT
> ./checksetup.pl
</PRE
></FONT
></TD
></TR
></TABLE
><P
>&#13; The first time you run it, it will create a file called
<TT
CLASS="filename"
>localconfig</TT
>.</P
><P
>This file contains a variety of settings you may need to tweak
including how Bugzilla should connect to the MySQL database.</P
><P
>The connection settings include:
<P
></P
><OL
TYPE="1"
><LI
><P
>server's host: just use
<SPAN
CLASS="QUOTE"
>"localhost"</SPAN
>
if the MySQL server is local</P
></LI
><LI
><P
>database name:
<SPAN
CLASS="QUOTE"
>"bugs_db"</SPAN
>
if you're following these directions</P
></LI
><LI
><P
>MySQL username:
<SPAN
CLASS="QUOTE"
>"bugs_user"</SPAN
>
if you're following these directions</P
></LI
><LI
><P ><P
>Password for the >&#13; Once checksetup.pl has run successfully, Bugzilla should start up.
<SPAN Proceed to the correct URL and log in with the administrator account
CLASS="QUOTE" you defined in the last checksetup.pl run.
>"bugs_user"</SPAN
>
MySQL account; (<SPAN
CLASS="QUOTE"
>"bugs_password"</SPAN
> above)</P
></LI
></OL
>
</P </P
><P ><P
>Once you are happy with the settings,
<TT
CLASS="filename"
>su</TT
> to the user
your web server runs as, and re-run
<TT
CLASS="filename"
>checksetup.pl</TT
>. (Note: on some security-conscious
systems, you may need to change the login shell for the webserver
account before you can do this.)
On this second run, it will create the database and an administrator
account for which you will be prompted to provide information.</P
><DIV
CLASS="note"
><P
></P
><TABLE
CLASS="note"
WIDTH="100%"
BORDER="0"
><TR
><TD
WIDTH="25"
ALIGN="CENTER"
VALIGN="TOP"
><IMG
SRC="../images/note.gif"
HSPACE="5"
ALT="Note"></TD
><TD
ALIGN="LEFT"
VALIGN="TOP"
><P
>The checksetup.pl script is designed so that you can run it at
any time without causing harm. You should run it after any upgrade to
Bugzilla.</P
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="section"
><H2
CLASS="section"
><A
NAME="AEN778"
></A
>4.1.7. Configuring Bugzilla</H2
><P
>&#13; You should run through the parameters on the Edit Parameters page >&#13; You should run through the parameters on the Edit Parameters page
(link in the footer) and set them all to appropriate values. (link in the footer) and set them all to appropriate values.
They key parameters are documented in <A They key parameters are documented in <A
......
docs/html/troubleshooting.html
View file @ 96a0037a
...@@ -87,7 +87,7 @@ CLASS="section" ...@@ -87,7 +87,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1215" NAME="AEN1206"
></A ></A
>4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2 >4.6.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1</H2
><P ><P
...@@ -112,7 +112,7 @@ CLASS="section" ...@@ -112,7 +112,7 @@ CLASS="section"
><H2 ><H2
CLASS="section" CLASS="section"
><A ><A
NAME="AEN1220" NAME="AEN1211"
></A ></A
>4.6.2. DBD::Sponge::db prepare failed</H2 >4.6.2. DBD::Sponge::db prepare failed</H2
><P ><P
......
docs/html/userpreferences.html
View file @ 96a0037a
...@@ -77,7 +77,7 @@ CLASS="section" ...@@ -77,7 +77,7 @@ CLASS="section"
><A ><A
NAME="userpreferences" NAME="userpreferences"
></A ></A
>3.8. User Preferences</H1 >3.9. User Preferences</H1
><P ><P
>Once you have logged in, you can customise various aspects of >Once you have logged in, you can customise various aspects of
Bugzilla via the "Edit prefs" link in the page footer. Bugzilla via the "Edit prefs" link in the page footer.
...@@ -89,7 +89,7 @@ CLASS="section" ...@@ -89,7 +89,7 @@ CLASS="section"
><A ><A
NAME="accountsettings" NAME="accountsettings"
></A ></A
>3.8.1. Account Settings</H2 >3.9.1. Account Settings</H2
><P ><P
>On this tab, you can change your basic account information, >On this tab, you can change your basic account information,
including your password, email address and real name. For security including your password, email address and real name. For security
...@@ -114,7 +114,7 @@ CLASS="section" ...@@ -114,7 +114,7 @@ CLASS="section"
><A ><A
NAME="emailsettings" NAME="emailsettings"
></A ></A
>3.8.2. Email Settings</H2 >3.9.2. Email Settings</H2
><P ><P
>On this tab you can reduce or increase the amount of email sent >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 you from Bugzilla, opting in our out depending on your relationship to
...@@ -169,7 +169,7 @@ CLASS="section" ...@@ -169,7 +169,7 @@ CLASS="section"
><A ><A
NAME="permissionsettings" NAME="permissionsettings"
></A ></A
>3.8.3. Permissions</H2 >3.9.3. Permissions</H2
><P ><P
>This is a purely informative page which outlines your current >This is a purely informative page which outlines your current
permissions on this installation of Bugzilla - what product groups you permissions on this installation of Bugzilla - what product groups you
......
docs/html/using.html
View file @ 96a0037a
...@@ -14,8 +14,8 @@ REL="PREVIOUS" ...@@ -14,8 +14,8 @@ REL="PREVIOUS"
TITLE="Why use Bugzilla?" TITLE="Why use Bugzilla?"
HREF="why-bugzilla.html"><LINK HREF="why-bugzilla.html"><LINK
REL="NEXT" REL="NEXT"
TITLE="Create a Bugzilla Account" TITLE="Introduction"
HREF="myaccount.html"></HEAD HREF="using-intro.html"></HEAD
><BODY ><BODY
CLASS="chapter" CLASS="chapter"
BGCOLOR="#FFFFFF" BGCOLOR="#FFFFFF"
...@@ -58,7 +58,7 @@ WIDTH="10%" ...@@ -58,7 +58,7 @@ WIDTH="10%"
ALIGN="right" ALIGN="right"
VALIGN="bottom" VALIGN="bottom"
><A ><A
HREF="myaccount.html" HREF="using-intro.html"
ACCESSKEY="N" ACCESSKEY="N"
>Next</A >Next</A
></TD ></TD
...@@ -83,150 +83,138 @@ CLASS="TOC" ...@@ -83,150 +83,138 @@ CLASS="TOC"
></DT ></DT
><DT ><DT
>3.1. <A >3.1. <A
HREF="using-intro.html"
>Introduction</A
></DT
><DT
>3.2. <A
HREF="myaccount.html" HREF="myaccount.html"
>Create a Bugzilla Account</A >Create a Bugzilla Account</A
></DT ></DT
><DT ><DT
>3.2. <A >3.3. <A
HREF="bug_page.html" HREF="bug_page.html"
>Anatomy of a Bug</A >Anatomy of a Bug</A
></DT ></DT
><DT ><DT
>3.3. <A >3.4. <A
HREF="query.html" HREF="query.html"
>Searching for Bugs</A >Searching for Bugs</A
></DT ></DT
><DT ><DT
>3.4. <A >3.5. <A
HREF="list.html" HREF="list.html"
>Bug Lists</A >Bug Lists</A
></DT ></DT
><DT ><DT
>3.5. <A >3.6. <A
HREF="bugreports.html" HREF="bugreports.html"
>Filing Bugs</A >Filing Bugs</A
></DT ></DT
><DT ><DT
>3.6. <A >3.7. <A
HREF="patchviewer.html" HREF="patchviewer.html"
>Patch Viewer</A >Patch Viewer</A
></DT ></DT
><DD ><DD
><DL ><DL
><DT ><DT
>3.6.1. <A >3.7.1. <A
HREF="patchviewer.html#patchviewer_view" HREF="patchviewer.html#patchviewer_view"
>Viewing Patches in Patch Viewer</A >Viewing Patches in Patch Viewer</A
></DT ></DT
><DT ><DT
>3.6.2. <A >3.7.2. <A
HREF="patchviewer.html#patchviewer_diff" HREF="patchviewer.html#patchviewer_diff"
>Seeing the Difference Between Two Patches</A >Seeing the Difference Between Two Patches</A
></DT ></DT
><DT ><DT
>3.6.3. <A >3.7.3. <A
HREF="patchviewer.html#patchviewer_context" HREF="patchviewer.html#patchviewer_context"
>Getting More Context in a Patch</A >Getting More Context in a Patch</A
></DT ></DT
><DT ><DT
>3.6.4. <A >3.7.4. <A
HREF="patchviewer.html#patchviewer_collapse" HREF="patchviewer.html#patchviewer_collapse"
>Collapsing and Expanding Sections of a Patch</A >Collapsing and Expanding Sections of a Patch</A
></DT ></DT
><DT ><DT
>3.6.5. <A >3.7.5. <A
HREF="patchviewer.html#patchviewer_link" HREF="patchviewer.html#patchviewer_link"
>Linking to a Section of a Patch</A >Linking to a Section of a Patch</A
></DT ></DT
><DT ><DT
>3.6.6. <A >3.7.6. <A
HREF="patchviewer.html#patchviewer_bonsai_lxr" HREF="patchviewer.html#patchviewer_bonsai_lxr"
>Going to Bonsai and LXR</A >Going to Bonsai and LXR</A
></DT ></DT
><DT ><DT
>3.6.7. <A >3.7.7. <A
HREF="patchviewer.html#patchviewer_unified_diff" HREF="patchviewer.html#patchviewer_unified_diff"
>Creating a Unified Diff</A >Creating a Unified Diff</A
></DT ></DT
></DL ></DL
></DD ></DD
><DT ><DT
>3.7. <A >3.8. <A
HREF="hintsandtips.html" HREF="hintsandtips.html"
>Hints and Tips</A >Hints and Tips</A
></DT ></DT
><DD ><DD
><DL ><DL
><DT ><DT
>3.7.1. <A >3.8.1. <A
HREF="hintsandtips.html#AEN358" HREF="hintsandtips.html#AEN363"
>Autolinkification</A >Autolinkification</A
></DT ></DT
><DT ><DT
>3.7.2. <A >3.8.2. <A
HREF="hintsandtips.html#quicksearch" HREF="hintsandtips.html#quicksearch"
>Quicksearch</A >Quicksearch</A
></DT ></DT
><DT ><DT
>3.7.3. <A >3.8.3. <A
HREF="hintsandtips.html#commenting" HREF="hintsandtips.html#commenting"
>Comments</A >Comments</A
></DT ></DT
><DT ><DT
>3.7.4. <A >3.8.4. <A
HREF="hintsandtips.html#attachments" HREF="hintsandtips.html#attachments"
>Attachments</A >Attachments</A
></DT ></DT
><DT
>3.7.5. <A
HREF="hintsandtips.html#AEN388"
>Filing Bugs</A
></DT
></DL ></DL
></DD ></DD
><DT ><DT
>3.8. <A >3.9. <A
HREF="userpreferences.html" HREF="userpreferences.html"
>User Preferences</A >User Preferences</A
></DT ></DT
><DD ><DD
><DL ><DL
><DT ><DT
>3.8.1. <A >3.9.1. <A
HREF="userpreferences.html#accountsettings" HREF="userpreferences.html#accountsettings"
>Account Settings</A >Account Settings</A
></DT ></DT
><DT ><DT
>3.8.2. <A >3.9.2. <A
HREF="userpreferences.html#emailsettings" HREF="userpreferences.html#emailsettings"
>Email Settings</A >Email Settings</A
></DT ></DT
><DT ><DT
>3.8.3. <A >3.9.3. <A
HREF="userpreferences.html#permissionsettings" HREF="userpreferences.html#permissionsettings"
>Permissions</A >Permissions</A
></DT ></DT
></DL ></DL
></DD ></DD
><DT ><DT
>3.9. <A >3.10. <A
HREF="reporting.html" HREF="reporting.html"
>Reports</A >Reports</A
></DT ></DT
></DL ></DL
></DIV ></DIV
><P
>This section contains information for end-users of Bugzilla.
There is a Bugzilla test installation, called
<A
HREF="http://landfill.bugzilla.org/bugzilla-tip/"
TARGET="_top"
>Landfill</A
>,
which you are welcome to play with (if it's up.)
However, it does not necessarily
have all Bugzilla features enabled, and runs an up-to-the-minute version,
so some things may not quite work as this document describes.</P
></DIV ></DIV
><DIV ><DIV
CLASS="NAVFOOTER" CLASS="NAVFOOTER"
...@@ -262,7 +250,7 @@ WIDTH="33%" ...@@ -262,7 +250,7 @@ WIDTH="33%"
ALIGN="right" ALIGN="right"
VALIGN="top" VALIGN="top"
><A ><A
HREF="myaccount.html" HREF="using-intro.html"
ACCESSKEY="N" ACCESSKEY="N"
>Next</A >Next</A
></TD ></TD
...@@ -282,7 +270,7 @@ VALIGN="top" ...@@ -282,7 +270,7 @@ VALIGN="top"
WIDTH="33%" WIDTH="33%"
ALIGN="right" ALIGN="right"
VALIGN="top" VALIGN="top"
>Create a Bugzilla Account</TD >Introduction</TD
></TR ></TR
></TABLE ></TABLE
></DIV ></DIV
......
docs/html/why-bugzilla.html
View file @ 96a0037a
...@@ -79,7 +79,8 @@ NAME="why-bugzilla" ...@@ -79,7 +79,8 @@ NAME="why-bugzilla"
></A ></A
>2.3. Why use Bugzilla?</H1 >2.3. Why use Bugzilla?</H1
><P ><P
>Bugzilla boasts many advanced features. These include: >Bugzilla is the leading open-source/free software bug tracking
system. It boasts many advanced features, including:
<P <P
></P ></P
><UL ><UL
...@@ -117,12 +118,12 @@ NAME="why-bugzilla" ...@@ -117,12 +118,12 @@ NAME="why-bugzilla"
></LI ></LI
><LI ><LI
><P ><P
>Web, XML, email and console interfaces</P >Completely customisable and/or localisable web user
interface</P
></LI ></LI
><LI ><LI
><P ><P
>Completely customisable and/or localisable web user >Additional XML, email and console interfaces</P
interface</P
></LI ></LI
><LI ><LI
><P ><P
...@@ -157,8 +158,7 @@ HREF="http://www.perforce.com" ...@@ -157,8 +158,7 @@ HREF="http://www.perforce.com"
TARGET="_top" TARGET="_top"
>Perforce SCM</A >Perforce SCM</A
>, Bugzilla >, Bugzilla
provides a powerful, easy-to-use solution to configuration management and provides a powerful, easy-to-use configuration management solution.</P
replication problems.</P
></DIV ></DIV
><DIV ><DIV
CLASS="NAVFOOTER" CLASS="NAVFOOTER"
......
docs/html/why-tracking.html
View file @ 96a0037a
...@@ -79,23 +79,15 @@ NAME="why-tracking" ...@@ -79,23 +79,15 @@ NAME="why-tracking"
></A ></A
>2.2. Why use a bug-tracking system?</H1 >2.2. Why use a bug-tracking system?</H1
><P ><P
>For many years, defect-tracking software was principally >Those who do not use a bug-tracking system tend to rely on
the domain of large software development houses. Most smaller shops shared lists, email, spreadsheets and/or Post-It notes to monitor the
simply relied on status of defects. This procedure
shared lists and email to monitor the status of defects. This procedure is usually error-prone and tends to cause those bugs judged least
was error-prone and tended to cause those bugs judged least significant by significant by developers to be dropped or ignored.</P
developers to be dropped or ignored.</P
><P ><P
>Integrated >Integrated defect-tracking systems make sure that nothing gets
defect-tracking systems reduce downtime, increase productivity, and raise swept under the carpet; they provide a method of creating, storing,
customer satisfaction with their systems. Along with full disclosure, an arranging and processing defect reports and enhancement requests.</P
open bug-tracker allows you to keep in touch with your 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 method for accounting for unusual system or software
issues.</P
></DIV ></DIV
><DIV ><DIV
CLASS="NAVFOOTER" CLASS="NAVFOOTER"
......
docs/pdf/Bugzilla-Guide.pdf
View file @ 96a0037a
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/txt/Bugzilla-Guide.txt
View file @ 96a0037a
...@@ -31,15 +31,16 @@ The Bugzilla Team ...@@ -31,15 +31,16 @@ The Bugzilla Team
3. Using Bugzilla 3. Using Bugzilla
3.1. Create a Bugzilla Account 3.1. Introduction
3.2. Anatomy of a Bug 3.2. Create a Bugzilla Account
3.3. Searching for Bugs 3.3. Anatomy of a Bug
3.4. Bug Lists 3.4. Searching for Bugs
3.5. Filing Bugs 3.5. Bug Lists
3.6. Patch Viewer 3.6. Filing Bugs
3.7. Hints and Tips 3.7. Patch Viewer
3.8. User Preferences 3.8. Hints and Tips
3.9. Reports 3.9. User Preferences
3.10. Reports
4. Installation 4. Installation
...@@ -153,13 +154,11 @@ Chapter 1. About This Guide ...@@ -153,13 +154,11 @@ Chapter 1. About This Guide
match the current version of Bugzilla. This version of the guide, like match the current version of Bugzilla. This version of the guide, like
its associated Bugzilla version, is a development version. its associated Bugzilla version, is a development version.
The newest version of this guide can always be found at The latest version of this guide can always be found at
http://www.bugzilla.org; however, you should read the version which http://www.bugzilla.org, or checked out via CVS. (Please follow the
came with the Bugzilla release you are using. Mozilla CVS instructions and check out the
mozilla/webtools/bugzilla/docs/ subtree.) However, you should read the
The latest version of this document can always be checked out via CVS. version which came with the Bugzilla release you are using.
Please follow the Mozilla CVS instructions and check out the
mozilla/webtools/bugzilla/docs/ subtree.
The Bugzilla Guide is currently only available in English. If you The Bugzilla Guide is currently only available in English. If you
would like to volunteer to translate it, please contact Dave Miller. would like to volunteer to translate it, please contact Dave Miller.
...@@ -187,7 +186,7 @@ Chapter 1. About This Guide ...@@ -187,7 +186,7 @@ Chapter 1. About This Guide
This document uses the following conventions: This document uses the following conventions:
Descriptions Appearance Descriptions Appearance
Warnings Warning
Caution Caution
...@@ -197,7 +196,7 @@ Chapter 1. About This Guide ...@@ -197,7 +196,7 @@ Chapter 1. About This Guide
Tip Tip
Would you like a breath mint? Would you like a breath mint?
Notes Note
Note Note
...@@ -207,12 +206,12 @@ Chapter 1. About This Guide ...@@ -207,12 +206,12 @@ Chapter 1. About This Guide
Warning Warning
Read this or the cat gets it. Read this or the cat gets it.
File and directory names filename File or directory name filename
Commands to be typed command Command to be typed command
Applications names application Application name application
Prompt of users command under bash shell bash$ Normal user's prompt under bash shell bash$
Prompt of root users command under bash shell bash# Root user's prompt under bash shell bash#
Prompt of user command under tcsh shell tcsh$ Normal user's prompt under tcsh shell tcsh$
Environment variables VARIABLE Environment variables VARIABLE
Term found in the glossary Bugzilla Term found in the glossary Bugzilla
Code example Code example
...@@ -238,26 +237,21 @@ Chapter 2. Introduction ...@@ -238,26 +237,21 @@ Chapter 2. Introduction
2.2. Why use a bug-tracking system? 2.2. Why use a bug-tracking system?
For many years, defect-tracking software was principally the domain of Those who do not use a bug-tracking system tend to rely on shared
large software development houses. Most smaller shops simply relied on lists, email, spreadsheets and/or Post-It notes to monitor the status
shared lists and email to monitor the status of defects. This of defects. This procedure is usually error-prone and tends to cause
procedure was error-prone and tended to cause those bugs judged least those bugs judged least significant by developers to be dropped or
significant by developers to be dropped or ignored. ignored.
Integrated defect-tracking systems reduce downtime, increase Integrated defect-tracking systems make sure that nothing gets swept
productivity, and raise customer satisfaction with their systems. under the carpet; they provide a method of creating, storing,
Along with full disclosure, an open bug-tracker allows you to keep in arranging and processing defect reports and enhancement requests.
touch with your 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 method for accounting for unusual
system or software issues.
_________________________________________________________________ _________________________________________________________________
2.3. Why use Bugzilla? 2.3. Why use Bugzilla?
Bugzilla boasts many advanced features. These include: Bugzilla is the leading open-source/free software bug tracking system.
It boasts many advanced features, including:
* Powerful searching * Powerful searching
* User-configurable email notifications of bug changes * User-configurable email notifications of bug changes
...@@ -267,8 +261,8 @@ Chapter 2. Introduction ...@@ -267,8 +261,8 @@ Chapter 2. Introduction
* Integrated, product-based, granular security schema * Integrated, product-based, granular security schema
* Fully security-audited, and runs under Perl's taint mode * Fully security-audited, and runs under Perl's taint mode
* A robust, stable RDBMS back-end * A robust, stable RDBMS back-end
* Web, XML, email and console interfaces
* Completely customisable and/or localisable web user interface * Completely customisable and/or localisable web user interface
* Additional XML, email and console interfaces
* Extensive configurability * Extensive configurability
* Smooth upgrade pathway between versions * Smooth upgrade pathway between versions
...@@ -278,12 +272,13 @@ Chapter 2. Introduction ...@@ -278,12 +272,13 @@ Chapter 2. Introduction
pre-and-post fabrication), and software and hardware bug tracking for pre-and-post fabrication), and software and hardware bug tracking for
luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems. luminaries such as Redhat, NASA, Linux-Mandrake, and VA Systems.
Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla Combined with systems such as CVS, Bonsai, or Perforce SCM, Bugzilla
provides a powerful, easy-to-use solution to configuration management provides a powerful, easy-to-use configuration management solution.
and replication problems.
_________________________________________________________________ _________________________________________________________________
Chapter 3. Using Bugzilla Chapter 3. Using Bugzilla
3.1. Introduction
This section contains information for end-users of Bugzilla. There is This section contains information for end-users of Bugzilla. There is
a Bugzilla test installation, called Landfill, which you are welcome a Bugzilla test installation, called Landfill, which you are welcome
to play with (if it's up.) However, it does not necessarily have all to play with (if it's up.) However, it does not necessarily have all
...@@ -291,7 +286,7 @@ Chapter 3. Using Bugzilla ...@@ -291,7 +286,7 @@ Chapter 3. Using Bugzilla
some things may not quite work as this document describes. some things may not quite work as this document describes.
_________________________________________________________________ _________________________________________________________________
3.1. Create a Bugzilla Account 3.2. Create a Bugzilla Account
If you want to use Bugzilla, first you need to create an account. If you want to use Bugzilla, first you need to create an account.
Consult with the administrator responsible for your installation of Consult with the administrator responsible for your installation of
...@@ -315,7 +310,7 @@ Chapter 3. Using Bugzilla ...@@ -315,7 +310,7 @@ Chapter 3. Using Bugzilla
changes, you should not have to log in again. changes, you should not have to log in again.
_________________________________________________________________ _________________________________________________________________
3.2. Anatomy of a Bug 3.3. Anatomy of a Bug
The core of Bugzilla is the screen which displays a particular bug. The core of Bugzilla is the screen which displays a particular bug.
It's a good place to explain some Bugzilla concepts. Bug 1 on Landfill It's a good place to explain some Bugzilla concepts. Bug 1 on Landfill
...@@ -391,7 +386,7 @@ Chapter 3. Using Bugzilla ...@@ -391,7 +386,7 @@ Chapter 3. Using Bugzilla
discussion here, if you have something worthwhile to say. discussion here, if you have something worthwhile to say.
_________________________________________________________________ _________________________________________________________________
3.3. Searching for Bugs 3.4. Searching for Bugs
The Bugzilla Search page is is the interface where you can find any The Bugzilla Search page is is the interface where you can find any
bug report, comment, or patch currently in the Bugzilla system. You bug report, comment, or patch currently in the Bugzilla system. You
...@@ -411,7 +406,7 @@ Chapter 3. Using Bugzilla ...@@ -411,7 +406,7 @@ Chapter 3. Using Bugzilla
Charts help link on the Search page for more information. Charts help link on the Search page for more information.
_________________________________________________________________ _________________________________________________________________
3.4. Bug Lists 3.5. Bug Lists
If you run a search, a list of matching bugs will be returned. If you run a search, a list of matching bugs will be returned.
...@@ -421,19 +416,23 @@ Chapter 3. Using Bugzilla ...@@ -421,19 +416,23 @@ Chapter 3. Using Bugzilla
Long Format: this gives you a large page with a non-editable summary Long Format: this gives you a large page with a non-editable summary
of the fields of each bug. of the fields of each bug.
CSV: get the buglist as comma-separated values, for import into e.g. a
spreadsheet.
Change Columns: change the bug attributes which appear in the list. Change Columns: change the bug attributes which appear in the list.
Change several bugs at once: If your account is sufficiently Change several bugs at once: If your account is sufficiently
empowered, you can make the same change to all the bugs in the list - empowered, you can make the same change to all the bugs in the list -
for example, changing their owner. for example, changing their owner.
Send mail to bug owners: Sends mail to the owners of all bugs on the Send mail to bug owners: Sends mail to the owners of all bugs on the
list. list.
Edit this query: If you didn't get exactly the results you were Edit Search: If you didn't get exactly the results you were looking
looking for, you can return to the Query page through this link and for, you can return to the Query page through this link and make small
make small revisions to the query you just made so you get more revisions to the query you just made so you get more accurate results.
accurate results. Remember Search As: You can give a search a name and remember it; a
link will appear in your page footer giving you quick access to run it
again later.
_________________________________________________________________ _________________________________________________________________
3.5. Filing Bugs 3.6. Filing Bugs
Years of bug writing experience has been distilled for your reading Years of bug writing experience has been distilled for your reading
pleasure into the Bug Writing Guidelines. While some of the advice is pleasure into the Bug Writing Guidelines. While some of the advice is
...@@ -452,9 +451,21 @@ Chapter 3. Using Bugzilla ...@@ -452,9 +451,21 @@ Chapter 3. Using Bugzilla
based upon your browser, for the "Platform" and "OS" drop-down based upon your browser, for the "Platform" and "OS" drop-down
boxes. If they are wrong, change them. boxes. If they are wrong, change them.
4. Select "Commit" and send in your bug report. 4. Select "Commit" and send in your bug report.
Try to make sure that everything said in the summary is also said in
the first comment. Summaries are often updated and this will ensure
your original information is easily accessible.
You do not need to put "any" or similar strings in the URL field. If
there is no specific URL associated with the bug, leave this field
blank.
If you feel a bug you filed was incorrectly marked as a DUPLICATE of
another, please question it in your bug, not the bug it was duped to.
Feel free to CC the person who duped it if they are not already CCed.
_________________________________________________________________ _________________________________________________________________
3.6. Patch Viewer 3.7. Patch Viewer
Viewing and reviewing patches in Bugzilla is often difficult due to Viewing and reviewing patches in Bugzilla is often difficult due to
lack of context, improper format and the inherent readability issues lack of context, improper format and the inherent readability issues
...@@ -476,7 +487,7 @@ Chapter 3. Using Bugzilla ...@@ -476,7 +487,7 @@ Chapter 3. Using Bugzilla
format it came from format it came from
_________________________________________________________________ _________________________________________________________________
3.6.1. Viewing Patches in Patch Viewer 3.7.1. Viewing Patches in Patch Viewer
The main way to view a patch in patch viewer is to click on the "Diff" The main way to view a patch in patch viewer is to click on the "Diff"
link next to a patch in the Attachments list on a bug. You may also do link next to a patch in the Attachments list on a bug. You may also do
...@@ -484,7 +495,7 @@ Chapter 3. Using Bugzilla ...@@ -484,7 +495,7 @@ Chapter 3. Using Bugzilla
button in the Edit Attachment screen. button in the Edit Attachment screen.
_________________________________________________________________ _________________________________________________________________
3.6.2. Seeing the Difference Between Two Patches 3.7.2. Seeing the Difference Between Two Patches
To see the difference between two patches, you must first view the To see the difference between two patches, you must first view the
newer patch in Patch Viewer. Then select the older patch from the newer patch in Patch Viewer. Then select the older patch from the
...@@ -493,7 +504,7 @@ Chapter 3. Using Bugzilla ...@@ -493,7 +504,7 @@ Chapter 3. Using Bugzilla
new or changed in the newer patch. new or changed in the newer patch.
_________________________________________________________________ _________________________________________________________________
3.6.3. Getting More Context in a Patch 3.7.3. Getting More Context in a Patch
To get more context in a patch, you put a number in the textbox at the To get more context in a patch, you put a number in the textbox at the
top of Patch Viewer ("Patch / File / [textbox]") and hit enter. This top of Patch Viewer ("Patch / File / [textbox]") and hit enter. This
...@@ -503,7 +514,7 @@ Chapter 3. Using Bugzilla ...@@ -503,7 +514,7 @@ Chapter 3. Using Bugzilla
against files that were diffed using "cvs diff". against files that were diffed using "cvs diff".
_________________________________________________________________ _________________________________________________________________
3.6.4. Collapsing and Expanding Sections of a Patch 3.7.4. Collapsing and Expanding Sections of a Patch
To view only a certain set of files in a patch (for example, if a To view only a certain set of files in a patch (for example, if a
patch is absolutely huge and you want to only review part of it at a patch is absolutely huge and you want to only review part of it at a
...@@ -513,7 +524,7 @@ Chapter 3. Using Bugzilla ...@@ -513,7 +524,7 @@ Chapter 3. Using Bugzilla
the top of the page. the top of the page.
_________________________________________________________________ _________________________________________________________________
3.6.5. Linking to a Section of a Patch 3.7.5. Linking to a Section of a Patch
To link to a section of a patch (for example, if you want to be able To link to a section of a patch (for example, if you want to be able
to give someone a URL to show them which part you are talking about) to give someone a URL to show them which part you are talking about)
...@@ -522,7 +533,7 @@ Chapter 3. Using Bugzilla ...@@ -522,7 +533,7 @@ Chapter 3. Using Bugzilla
Location in Mozilla works as well.) Location in Mozilla works as well.)
_________________________________________________________________ _________________________________________________________________
3.6.6. Going to Bonsai and LXR 3.7.6. Going to Bonsai and LXR
To go to Bonsai to get blame for the lines you are interested in, you To go to Bonsai to get blame for the lines you are interested in, you
can click the "Lines XX-YY" link on the section header you are can click the "Lines XX-YY" link on the section header you are
...@@ -534,20 +545,20 @@ Chapter 3. Using Bugzilla ...@@ -534,20 +545,20 @@ Chapter 3. Using Bugzilla
numbers are likely to rot). numbers are likely to rot).
_________________________________________________________________ _________________________________________________________________
3.6.7. Creating a Unified Diff 3.7.7. Creating a Unified Diff
If the patch is not in a format that you like, you can turn it into a If the patch is not in a format that you like, you can turn it into a
unified diff format by clicking the "Raw Unified" link at the top of unified diff format by clicking the "Raw Unified" link at the top of
the page. the page.
_________________________________________________________________ _________________________________________________________________
3.7. Hints and Tips 3.8. Hints and Tips
This section distills some Bugzilla tips and best practices that have This section distills some Bugzilla tips and best practices that have
been developed. been developed.
_________________________________________________________________ _________________________________________________________________
3.7.1. Autolinkification 3.8.1. Autolinkification
Bugzilla comments are plain text - so typing <U> will produce Bugzilla comments are plain text - so typing <U> will produce
less-than, U, greater-than rather than underlined text. However, less-than, U, greater-than rather than underlined text. However,
...@@ -570,7 +581,7 @@ Chapter 3. Using Bugzilla ...@@ -570,7 +581,7 @@ Chapter 3. Using Bugzilla
convenience of others. convenience of others.
_________________________________________________________________ _________________________________________________________________
3.7.2. Quicksearch 3.8.2. Quicksearch
Quicksearch is a single-text-box query tool which uses metacharacters Quicksearch is a single-text-box query tool which uses metacharacters
to indicate what is to be searched. For example, typing "foo|bar" into to indicate what is to be searched. For example, typing "foo|bar" into
...@@ -582,7 +593,7 @@ Chapter 3. Using Bugzilla ...@@ -582,7 +593,7 @@ Chapter 3. Using Bugzilla
Help link which details how to use it. Help link which details how to use it.
_________________________________________________________________ _________________________________________________________________
3.7.3. Comments 3.8.3. Comments
If you are changing the fields on a bug, only comment if either you If you are changing the fields on a bug, only comment if either you
have something pertinent to say, or Bugzilla requires it. Otherwise, have something pertinent to say, or Bugzilla requires it. Otherwise,
...@@ -598,7 +609,7 @@ Chapter 3. Using Bugzilla ...@@ -598,7 +609,7 @@ Chapter 3. Using Bugzilla
art creations are not. art creations are not.
_________________________________________________________________ _________________________________________________________________
3.7.4. Attachments 3.8.4. Attachments
Use attachments, rather than comments, for large chunks of ASCII data, Use attachments, rather than comments, for large chunks of ASCII data,
such as trace, debugging output files, or log files. That way, it such as trace, debugging output files, or log files. That way, it
...@@ -614,29 +625,14 @@ Chapter 3. Using Bugzilla ...@@ -614,29 +625,14 @@ Chapter 3. Using Bugzilla
way, the test case works immediately out of the bug. way, the test case works immediately out of the bug.
_________________________________________________________________ _________________________________________________________________
3.7.5. Filing Bugs 3.9. User Preferences
Try to make sure that everything said in the summary is also said in
the first comment. Summaries are often updated and this will ensure
your original information is easily accessible.
You do not need to put "any" or similar strings in the URL field. If
there is no specific URL associated with the bug, leave this field
blank.
If you feel a bug you filed was incorrectly marked as a DUPLICATE of
another, please question it in your bug, not the bug it was duped to.
Feel free to CC the person who duped it if they are not already CCed.
_________________________________________________________________
3.8. User Preferences
Once you have logged in, you can customise various aspects of Bugzilla Once you have logged in, you can customise various aspects of Bugzilla
via the "Edit prefs" link in the page footer. The preferences are via the "Edit prefs" link in the page footer. The preferences are
split into three tabs: split into three tabs:
_________________________________________________________________ _________________________________________________________________
3.8.1. Account Settings 3.9.1. Account Settings
On this tab, you can change your basic account information, including On this tab, you can change your basic account information, including
your password, email address and real name. For security reasons, in your password, email address and real name. For security reasons, in
...@@ -647,7 +643,7 @@ Chapter 3. Using Bugzilla ...@@ -647,7 +643,7 @@ Chapter 3. Using Bugzilla
change. This helps to prevent account hijacking. change. This helps to prevent account hijacking.
_________________________________________________________________ _________________________________________________________________
3.8.2. Email Settings 3.9.2. Email Settings
On this tab you can reduce or increase the amount of email sent you 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 from Bugzilla, opting in our out depending on your relationship to the
...@@ -671,7 +667,7 @@ Chapter 3. Using Bugzilla ...@@ -671,7 +667,7 @@ Chapter 3. Using Bugzilla
installations. If you can't see it, ask your administrator. installations. If you can't see it, ask your administrator.
_________________________________________________________________ _________________________________________________________________
3.8.3. Permissions 3.9.3. Permissions
This is a purely informative page which outlines your current This is a purely informative page which outlines your current
permissions on this installation of Bugzilla - what product groups you permissions on this installation of Bugzilla - what product groups you
...@@ -679,7 +675,7 @@ Chapter 3. Using Bugzilla ...@@ -679,7 +675,7 @@ Chapter 3. Using Bugzilla
administration functions. administration functions.
_________________________________________________________________ _________________________________________________________________
3.9. Reports 3.10. Reports
To be written To be written
_________________________________________________________________ _________________________________________________________________
...@@ -692,8 +688,8 @@ Chapter 4. Installation ...@@ -692,8 +688,8 @@ Chapter 4. Installation
operating systems including almost all Unix clones and Microsoft operating systems including almost all Unix clones and Microsoft
Windows. Many operating systems have utilities that make installation Windows. Many operating systems have utilities that make installation
easier or quirks that make it harder. We have tried to collect that easier or quirks that make it harder. We have tried to collect that
information in Section 4.4, so be sure to check out that section information in Section 4.4, so unless you are on Linux, be sure to
before you start your installation. check out that section before you start your installation.
Note Note
...@@ -704,27 +700,25 @@ Chapter 4. Installation ...@@ -704,27 +700,25 @@ Chapter 4. Installation
Warning Warning
While installing Bugzilla, it is a good idea to ensure that there is While installing Bugzilla, it is a good idea to ensure that there is
some kind of firewall between you and the rest of the Internet as your some kind of configurable firewall between you and the rest of the
machine may be insecure for periods during the install. Many Internet as your machine may be insecure for periods during the
installation steps require an active Internet connection to complete, install. Many installation steps require an active Internet connection
but you must take care to ensure that at no point is your machine to complete, but you must take care to ensure that at no point is your
vulnerable to an attack. machine vulnerable to an attack.
This guide assumes that you already have your operating system This guide assumes that you already have your operating system
installed, network configured, and have administrative access to the installed, network configured, and have administrative access to the
shell on the machine you are installing Bugzilla onto. It is possible machine onto which you are installing Bugzilla. It is possible to
to install and run Bugzilla without administrative access, but you install and run Bugzilla itself without administrative access, but you
have to either make sure all the required software is installed or get have to either make sure all the required software is installed or get
somebody with administrative access to install it for you. somebody with administrative access to install it for you.
You are strongly recommended to make a backup of your system before You are strongly recommended to make a backup of your system before
installing Bugzilla and at regular intervals thereafter. installing Bugzilla (and at regular intervals thereafter :-).
The listing below is a basic step-by-step list. More information can Here's a basic step-by-step list:
be found in the sections below. Minimum versions will be included in 1. Install Perl (5.6.0 or above)
parenthesis where appropriate. 2. Install MySQL (3.23.41 or above)
1. Install Perl (5.6)
2. Install MySQL (3.23.41)
3. Install a Webserver 3. Install a Webserver
4. Put Bugzilla in the Webspace 4. Put Bugzilla in the Webspace
5. Install Perl Modules 5. Install Perl Modules
...@@ -733,18 +727,20 @@ Chapter 4. Installation ...@@ -733,18 +727,20 @@ Chapter 4. Installation
4.1.1. Perl 4.1.1. Perl
Any machine that doesn't have Perl on it is a sad machine indeed. Perl Any machine that doesn't have Perl on it is a sad machine indeed. If
can be got in source form from http://www.perl.com. There are also your OS doesn't come with it, Perl can be got in source form from
binary versions available for many platforms, most of which are linked http://www.perl.com. There are also binary versions available for many
to from perl.com. Although Bugzilla runs with perl 5.6, it's a good platforms, most of which are linked to from perl.com. Although
idea to be up to the very latest version if you can when running Bugzilla runs with perl 5.6.0, it's a good idea to be up to the very
Bugzilla. As of this writing, that is Perl version 5.8. latest version if you can when running Bugzilla. As of this writing,
that is Perl version 5.8.2.
_________________________________________________________________ _________________________________________________________________
4.1.2. MySQL 4.1.2. MySQL
Visit the MySQL homepage at http://www.mysql.com to grab and install If your OS doesn't come with it or provide official packages, visit
the latest stable release of the server. the MySQL homepage at http://www.mysql.com to grab and install the
latest stable release of the server.
Note Note
...@@ -771,29 +767,30 @@ Chapter 4. Installation ...@@ -771,29 +767,30 @@ Chapter 4. Installation
set-variable = max_allowed_packet=1M set-variable = max_allowed_packet=1M
If you are running Bugzilla and MySQL on the same machine, you may If you are running Bugzilla and MySQL on the same machine, you may
also wish to utilize the skip-networking option as mentioned in also wish to utilize the --skip-networking option as mentioned in
Section 4.5.2 for the added security. Section 4.5.2 for the added security.
_________________________________________________________________ _________________________________________________________________
4.1.2.1. Configuring MySQL 4.1.2.1. Adding a user to MySQL
This first thing you'll want to do is make sure you've given the This first thing you'll want to do is make sure you've given the
"root" user a password as suggested in Section 4.5.2. For clarity, "root" user a password as suggested in Section 4.5.2. Then, you need
these instructions will assume that your MySQL user for Bugzilla will to add a user for Bugzilla to use. For clarity, these instructions
be "bugs_user", the database will be called "bugs_db" and the password will assume that your MySQL user for Bugzilla will be "bugs_user", the
for the "bugs_user" user is "bugs_password". You should, of course, database will be called "bugs_db" and the password for the "bugs_user"
substitute the values you intend to use for your site. user is "bugs_password". You should, of course, substitute the values
you intend to use for your site.
Note Note
Most people use "bugs" for both the user and database name. Most people use "bugs" for both the user and database name. Don't use
it for the password, though...
Next, we use an SQL GRANT command to create a "bugs_user" user, and We use an SQL GRANT command to create a "bugs_user" user. This also
grant sufficient permissions for checksetup.pl, which we'll use later, restricts the "bugs_user" user to operations within a database called
to work its magic. This also restricts the "bugs_user" user to "bugs_db", and only allows the account to connect from "localhost".
operations within a database called "bugs_db", and only allows the Modify it to reflect your setup if you will be connecting from another
account to connect from "localhost". Modify it to reflect your setup machine or as a different user.
if you will be connecting from another machine or as a different user.
mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE, mysql> GRANT SELECT,INSERT,UPDATE,DELETE,INDEX,ALTER,CREATE,
DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost DROP,REFERENCES ON bugs_db.* TO bugs_user@localhost
IDENTIFIED BY 'bugs_password'; IDENTIFIED BY 'bugs_password';
...@@ -802,7 +799,8 @@ set-variable = max_allowed_packet=1M ...@@ -802,7 +799,8 @@ set-variable = max_allowed_packet=1M
Note Note
If you are using MySQL 4, the bugs user also needs to be granted the If you are using MySQL 4, the bugs user also needs to be granted the
LOCK TABLES and CREATE TEMPORARY TABLES permissions. LOCK TABLES and CREATE TEMPORARY TABLES permissions, so add them to
the list in the GRANT command.
_________________________________________________________________ _________________________________________________________________
4.1.3. HTTP Server 4.1.3. HTTP Server
...@@ -830,28 +828,71 @@ set-variable = max_allowed_packet=1M ...@@ -830,28 +828,71 @@ set-variable = max_allowed_packet=1M
Tip Tip
If you symlink the bugzilla directory into your Apache's HTML If you symlink the bugzilla directory into your Apache's html
hierarchy, you may receive Forbidden errors unless you add the hierarchy, you may receive Forbidden errors unless you add the
"FollowSymLinks" directive to the <Directory> entry for the HTML root FollowSymLinks directive to the <Directory> entry for the HTML root
in httpd.conf. directory in httpd.conf.
Caution
The default Bugzilla distribution is not designed to be placed in a
cgi-bin directory (this includes any directory which is configured
using the ScriptAlias directive of Apache).
Once all the files are in a web accessible directory, make that Once all the files are in a web accessible directory, make that
directory writable by your webserver's user. This is a temporary step directory writable by your webserver's user. This is a temporary step
until you run the post-install checksetup.pl script, which locks down until you run the post-install checksetup.pl script, which locks down
your installation. your installation.
_________________________________________________________________
Caution 4.1.5. checksetup.pl
The default Bugzilla distribution is not designed to be placed in a Next, run the magic checksetup.pl script. This is designed to check
cgi-bin directory (this includes any directory which is configured whether you have all of the right Perl modules in the correct
using the ScriptAlias directive of Apache). versions, and that Bugzilla is generally set up correctly.
Eventually, it will make sure Bugzilla files and directories have
reasonable permissions, set up the data directory, and create all the
MySQL tables. But the first time you run it, it's highly likely to
tell you that you are missing a few Perl modules. Make a note of which
ones they are, and then proceed to the next section to install them.
bash# ./checksetup.pl
The first time you run it with all the correct modules installed, it
will create a file called localconfig.
This file contains a variety of settings you may need to tweak
including how Bugzilla should connect to the MySQL database.
The connection settings include:
1. server's host: just use "localhost" if the MySQL server is local
2. database name: "bugs_db" if you're following these directions
3. MySQL username: "bugs_user" if you're following these directions
4. Password for the "bugs_user" MySQL account; ("bugs_password"
above)
Edit the file to change these. Once you are happy with the settings,
su to the user your web server runs as, and re-run checksetup.pl.
(Note: on some security-conscious systems, you may need to change the
login shell for the webserver account before you can do this.) On this
second run, it will create the database and an administrator account
for which you will be prompted to provide information.
Note
The checksetup.pl script is designed so that you can run it at any
time without causing harm. You should run it after any upgrade to
Bugzilla.
_________________________________________________________________ _________________________________________________________________
4.1.5. Perl Modules 4.1.6. Perl Modules
Don't be intimidated by this long list of modules. See Section 4.1.6.1
for a way of installing all the ones you need with a single command.
Perl modules can be found using CPAN on Unix based systems or PPM on Perl modules can be found using CPAN on Unix based systems or PPM on
Win32. The root servers have a real tendency to bog down, so please Win32.
use mirrors.
Good instuctions can be found for using each of these services on Good instuctions can be found for using each of these services on
their respective websites. The basics can be found in Example 4-1 for their respective websites. The basics can be found in Example 4-1 for
...@@ -892,16 +933,14 @@ bash# make install ...@@ -892,16 +933,14 @@ bash# make install
Perl Modules (minimum version): Perl Modules (minimum version):
1. Bundle::Bugzilla (Will allow you to skip the rest) 1. Bundle::Bugzilla (Will allow you to skip the rest)
2. AppConfig (1.52) 2. CGI (2.88)
3. CGI (2.88) 3. Date::Format (2.21)
4. Data::Dumper (any) 4. DBI (1.32)
5. Date::Format (2.21) 5. DBD::mysql (2.1010)
6. DBI (1.32) 6. File::Spec (0.82)
7. DBD::mysql (2.1010) 7. File::Temp (any)
8. File::Spec (0.82) 8. Template Toolkit (2.08)
9. File::Temp (any) 9. Text::Wrap (2001.0131)
10. Template Toolkit (2.08)
11. Text::Wrap (2001.0131)
and, optionally: and, optionally:
...@@ -914,7 +953,7 @@ bash# make install ...@@ -914,7 +953,7 @@ bash# make install
7. PatchReader (0.9.1) for pretty HTML view of patches 7. PatchReader (0.9.1) for pretty HTML view of patches
_________________________________________________________________ _________________________________________________________________
4.1.5.1. Bundle::Bugzilla 4.1.6.1. Bundle::Bugzilla
If you are running at least perl 5.6.1, you can save yourself a lot of If you are running at least perl 5.6.1, you can save yourself a lot of
time by using Bundle::Bugzilla. This bundle contains every module time by using Bundle::Bugzilla. This bundle contains every module
...@@ -937,13 +976,7 @@ cpan> ...@@ -937,13 +976,7 @@ cpan>
you'll have to go through a series of configuration steps. you'll have to go through a series of configuration steps.
_________________________________________________________________ _________________________________________________________________
4.1.5.2. AppConfig (1.52) 4.1.6.2. CGI (2.88)
Dependency for Template Toolkit. We probably don't need to
specifically check for it anymore.
_________________________________________________________________
4.1.5.3. CGI (2.88)
The CGI module parses form elements and cookies and does many other The CGI module parses form elements and cookies and does many other
usefule things. It come as a part of recent perl distributions, but usefule things. It come as a part of recent perl distributions, but
...@@ -955,21 +988,7 @@ cpan> ...@@ -955,21 +988,7 @@ cpan>
Documentation: http://www.perldoc.com/perl5.8.0/lib/CGI.html Documentation: http://www.perldoc.com/perl5.8.0/lib/CGI.html
_________________________________________________________________ _________________________________________________________________
4.1.5.4. Data::Dumper (any) 4.1.6.3. TimeDate modules (2.21)
The Data::Dumper module provides data structure persistence for Perl
(similar to Java's serialization). It comes with later sub-releases of
Perl 5.004, but a re-installation just to be sure it's available won't
hurt anything.
CPAN Download Page: http://search.cpan.org/dist/Data-Dumper/
PPM Download Link: http://ppm.activestate.com/PPMPackages/zips
/6xx-builds-only/Data-Dumper.zip
Documentation: http://www.perldoc.com/perl5.8.0/lib/Data/Dumpe
r.html
_________________________________________________________________
4.1.5.5. TimeDate modules (2.21)
Many of the more common date/time/calendar related Perl modules have Many of the more common date/time/calendar related Perl modules have
been grouped into a bundle similar to the MySQL modules bundle. This been grouped into a bundle similar to the MySQL modules bundle. This
...@@ -984,7 +1003,7 @@ cpan> ...@@ -984,7 +1003,7 @@ cpan>
ormat.pm ormat.pm
_________________________________________________________________ _________________________________________________________________
4.1.5.6. DBI (1.32) 4.1.6.4. DBI (1.32)
The DBI module is a generic Perl module used the MySQL-related The DBI module is a generic Perl module used the MySQL-related
modules. As long as your Perl installation was done correctly the DBI modules. As long as your Perl installation was done correctly the DBI
...@@ -997,7 +1016,7 @@ cpan> ...@@ -997,7 +1016,7 @@ cpan>
Documentation: http://dbi.perl.org/doc/ Documentation: http://dbi.perl.org/doc/
_________________________________________________________________ _________________________________________________________________
4.1.5.7. MySQL-related modules 4.1.6.5. MySQL-related modules
The Perl/MySQL interface requires a few mutually-dependent Perl The Perl/MySQL interface requires a few mutually-dependent Perl
modules. These modules are grouped together into the the modules. These modules are grouped together into the the
...@@ -1022,7 +1041,7 @@ cpan> ...@@ -1022,7 +1041,7 @@ cpan>
ysql.pod ysql.pod
_________________________________________________________________ _________________________________________________________________
4.1.5.8. File::Spec (0.82) 4.1.6.6. File::Spec (0.82)
File::Spec is a perl module that allows file operations, such as File::Spec is a perl module that allows file operations, such as
generating full path names, to work cross platform. generating full path names, to work cross platform.
...@@ -1034,7 +1053,7 @@ cpan> ...@@ -1034,7 +1053,7 @@ cpan>
html html
_________________________________________________________________ _________________________________________________________________
4.1.5.9. File::Temp (any) 4.1.6.7. File::Temp (any)
File::Temp is used to generate a temporary filename that is guaranteed File::Temp is used to generate a temporary filename that is guaranteed
to be unique. It comes as a standard part of perl to be unique. It comes as a standard part of perl
...@@ -1046,7 +1065,7 @@ cpan> ...@@ -1046,7 +1065,7 @@ cpan>
html html
_________________________________________________________________ _________________________________________________________________
4.1.5.10. Template Toolkit (2.08) 4.1.6.8. Template Toolkit (2.08)
When you install Template Toolkit, you'll get asked various questions When you install Template Toolkit, you'll get asked various questions
about features to enable. The defaults are fine, except that it is about features to enable. The defaults are fine, except that it is
...@@ -1060,7 +1079,7 @@ cpan> ...@@ -1060,7 +1079,7 @@ cpan>
Documentation: http://www.template-toolkit.org/docs.html Documentation: http://www.template-toolkit.org/docs.html
_________________________________________________________________ _________________________________________________________________
4.1.5.11. Text::Wrap (2001.0131) 4.1.6.9. Text::Wrap (2001.0131)
Text::Wrap is designed to proved intelligent text wrapping. Text::Wrap is designed to proved intelligent text wrapping.
...@@ -1070,15 +1089,9 @@ cpan> ...@@ -1070,15 +1089,9 @@ cpan>
html html
_________________________________________________________________ _________________________________________________________________
4.1.5.12. GD (1.20) [optional] 4.1.6.10. GD (1.20) [optional]
The GD library was written by Thomas Boutell a long while ago to You need the GD library if you want any of the graphing to work.
programmatically generate images in C. Since then it's become the
defacto standard for programmatic image construction. The Perl
bindings to it found in the GD library are used on millions of web
pages to generate graphs on the fly. That's what Bugzilla will be
using it for so you must install it if you want any of the graphing to
work.
Note Note
...@@ -1099,7 +1112,7 @@ cpan> ...@@ -1099,7 +1112,7 @@ cpan>
Documentation: http://stein.cshl.org/WWW/software/GD/ Documentation: http://stein.cshl.org/WWW/software/GD/
_________________________________________________________________ _________________________________________________________________
4.1.5.13. Chart::Base (0.99c) [optional] 4.1.6.11. Chart::Base (0.99c) [optional]
The Chart module provides Bugzilla with on-the-fly charting abilities. The Chart module provides Bugzilla with on-the-fly charting abilities.
It can be installed in the usual fashion after it has been fetched It can be installed in the usual fashion after it has been fetched
...@@ -1111,7 +1124,7 @@ cpan> ...@@ -1111,7 +1124,7 @@ cpan>
/6xx-builds-only/Chart.zip /6xx-builds-only/Chart.zip
_________________________________________________________________ _________________________________________________________________
4.1.5.14. XML::Parser (any) [Optional] 4.1.6.12. XML::Parser (any) [optional]
XML::Parser is used by the importxml.pl script. You only need it if XML::Parser is used by the importxml.pl script. You only need it if
you are going to be importing bugs (such as for bug moving). you are going to be importing bugs (such as for bug moving).
...@@ -1123,7 +1136,7 @@ cpan> ...@@ -1123,7 +1136,7 @@ cpan>
.html .html
_________________________________________________________________ _________________________________________________________________
4.1.5.15. GD::Graph (any) [Optional] 4.1.6.13. GD::Graph (any) [optional]
In addition to GD listed above, the reporting interface of Bugzilla In addition to GD listed above, the reporting interface of Bugzilla
needs to have the GD::Graph module installed. needs to have the GD::Graph module installed.
...@@ -1134,7 +1147,7 @@ cpan> ...@@ -1134,7 +1147,7 @@ cpan>
Documentation: http://search.cpan.org/dist/GDGraph/Graph.pm Documentation: http://search.cpan.org/dist/GDGraph/Graph.pm
_________________________________________________________________ _________________________________________________________________
4.1.5.16. GD::Text::Align (any) [Optional] 4.1.6.14. GD::Text::Align (any) [optional]
GD::Text::Align, as the name implies, is used to draw aligned strings GD::Text::Align, as the name implies, is used to draw aligned strings
of text. It is needed by the reporting interface. of text. It is needed by the reporting interface.
...@@ -1146,7 +1159,7 @@ cpan> ...@@ -1146,7 +1159,7 @@ cpan>
gn.pm gn.pm
_________________________________________________________________ _________________________________________________________________
4.1.5.17. MIME::Parser (any) [Optional] 4.1.6.15. MIME::Parser (any) [optional]
MIME::Parser is only needed if you want to use the e-mail interface MIME::Parser is only needed if you want to use the e-mail interface
located in the contrib directory. located in the contrib directory.
...@@ -1158,7 +1171,7 @@ cpan> ...@@ -1158,7 +1171,7 @@ cpan>
/Parser.pm /Parser.pm
_________________________________________________________________ _________________________________________________________________
4.1.5.18. PatchReader (0.9.1) [Optional] 4.1.6.16. PatchReader (0.9.1) [optional]
PatchReader is only needed if you want to use Patch Viewer, a Bugzilla PatchReader is only needed if you want to use Patch Viewer, a Bugzilla
feature to format patches in a pretty HTML fashion. There are a number feature to format patches in a pretty HTML fashion. There are a number
...@@ -1176,45 +1189,12 @@ cpan> ...@@ -1176,45 +1189,12 @@ cpan>
html html
_________________________________________________________________ _________________________________________________________________
4.1.6. checksetup.pl
Next, run the magic checksetup.pl script. This is designed to make
sure your perl modules are the correct version and your MySQL database
and other configuration options are consistent with the Bugzilla CGI
files. It will make sure Bugzilla files and directories have
reasonable permissions, set up the data directory, and create all the
MySQL tables.
bash# ./checksetup.pl
The first time you run it, it will create a file called localconfig.
This file contains a variety of settings you may need to tweak
including how Bugzilla should connect to the MySQL database.
The connection settings include:
1. server's host: just use "localhost" if the MySQL server is local
2. database name: "bugs_db" if you're following these directions
3. MySQL username: "bugs_user" if you're following these directions
4. Password for the "bugs_user" MySQL account; ("bugs_password"
above)
Once you are happy with the settings, su to the user your web server
runs as, and re-run checksetup.pl. (Note: on some security-conscious
systems, you may need to change the login shell for the webserver
account before you can do this.) On this second run, it will create
the database and an administrator account for which you will be
prompted to provide information.
Note
The checksetup.pl script is designed so that you can run it at any
time without causing harm. You should run it after any upgrade to
Bugzilla.
_________________________________________________________________
4.1.7. Configuring Bugzilla 4.1.7. Configuring Bugzilla
Once checksetup.pl has run successfully, Bugzilla should start up.
Proceed to the correct URL and log in with the administrator account
you defined in the last checksetup.pl run.
You should run through the parameters on the Edit Parameters page You should run through the parameters on the Edit Parameters page
(link in the footer) and set them all to appropriate values. They key (link in the footer) and set them all to appropriate values. They key
parameters are documented in Section 5.1. parameters are documented in Section 5.1.
...@@ -1536,7 +1516,7 @@ Javascript code ...@@ -1536,7 +1516,7 @@ Javascript code
4.4.1.2. Perl Modules on Win32 4.4.1.2. Perl Modules on Win32
Bugzilla on Windows requires the same perl modules found in Section Bugzilla on Windows requires the same perl modules found in Section
4.1.5. The main difference is that windows uses PPM instead of CPAN. 4.1.6. The main difference is that windows uses PPM instead of CPAN.
C:\perl> ppm <module name> C:\perl> ppm <module name>
Note Note
......
docs/xml/Bugzilla-Guide.xml
View file @ 96a0037a
...@@ -40,11 +40,11 @@ ...@@ -40,11 +40,11 @@
<!ENTITY bz "http://www.bugzilla.org/"> <!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>"> <!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>">
<!ENTITY mysql "http://www.mysql.com/"> <!ENTITY mysql "http://www.mysql.com/">
<!ENTITY newest-perl-ver "5.8"> <!ENTITY newest-perl-ver "5.8.2">
<!-- For minimum versions --> <!-- For minimum versions -->
<!ENTITY min-mysql-ver "3.23.41"> <!ENTITY min-mysql-ver "3.23.41">
<!ENTITY min-perl-ver "5.6"> <!ENTITY min-perl-ver "5.6.0">
<!ENTITY min-template-ver "2.08"> <!ENTITY min-template-ver "2.08">
<!ENTITY min-file-temp-ver "any"> <!ENTITY min-file-temp-ver "any">
<!ENTITY min-appconfig-ver "1.52"> <!ENTITY min-appconfig-ver "1.52">
......
docs/xml/about.xml
View file @ 96a0037a
...@@ -67,17 +67,15 @@ ...@@ -67,17 +67,15 @@
]]> ]]>
</para> </para>
<para> <para>
The newest version of this guide can always be found at <ulink The latest version of this guide can always be found at <ulink
url="http://www.bugzilla.org"/>; however, you should read the version url="http://www.bugzilla.org"/>, or checked out via CVS.
(Please follow the <ulink url="http://www.mozilla.org/cvs.html">Mozilla
CVS</ulink> instructions and check out the
<filename>mozilla/webtools/bugzilla/docs/</filename>
subtree.) However, you should read the version
which came with the Bugzilla release you are using. which came with the Bugzilla release you are using.
</para> </para>
<para> <para>
The latest version of this document can always be checked out via CVS.
Please follow the <ulink url="http://www.mozilla.org/cvs.html">Mozilla CVS</ulink>
instructions and check out the <filename>mozilla/webtools/bugzilla/docs/</filename>
subtree.
</para>
<para>
The Bugzilla Guide is currently only available in English. The Bugzilla Guide is currently only available in English.
If you would like to volunteer to translate it, please contact If you would like to volunteer to translate it, please contact
<ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>. <ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>.
...@@ -116,7 +114,7 @@ ...@@ -116,7 +114,7 @@
<para> <para>
Last but not least, all the members of the Last but not least, all the members of the
<ulink url="news://news.mozilla.org/netscape/public/mozilla/webtools"> <ulink url="news://news.mozilla.org/netscape.public.mozilla.webtools">
netscape.public.mozilla.webtools</ulink> netscape.public.mozilla.webtools</ulink>
newsgroup. Without your discussions, insight, suggestions, and patches, newsgroup. Without your discussions, insight, suggestions, and patches,
this could never have happened. this could never have happened.
......
docs/xml/conventions.xml
View file @ 96a0037a
...@@ -20,7 +20,7 @@ ...@@ -20,7 +20,7 @@
<tbody> <tbody>
<row> <row>
<entry>Warnings</entry> <entry>Warning</entry>
<entry> <entry>
<caution> <caution>
...@@ -40,7 +40,7 @@ ...@@ -40,7 +40,7 @@
</row> </row>
<row> <row>
<entry>Notes</entry> <entry>Note</entry>
<entry> <entry>
<note> <note>
...@@ -60,7 +60,7 @@ ...@@ -60,7 +60,7 @@
</row> </row>
<row> <row>
<entry>File and directory names</entry> <entry>File or directory name</entry>
<entry> <entry>
<filename>filename</filename> <filename>filename</filename>
...@@ -68,7 +68,7 @@ ...@@ -68,7 +68,7 @@
</row> </row>
<row> <row>
<entry>Commands to be typed</entry> <entry>Command to be typed</entry>
<entry> <entry>
<command>command</command> <command>command</command>
...@@ -76,7 +76,7 @@ ...@@ -76,7 +76,7 @@
</row> </row>
<row> <row>
<entry>Applications names</entry> <entry>Application name</entry>
<entry> <entry>
<application>application</application> <application>application</application>
...@@ -85,27 +85,21 @@ ...@@ -85,27 +85,21 @@
<row> <row>
<entry> <entry>
<foreignphrase>Prompt</foreignphrase> Normal user's prompt under bash shell</entry>
of users command under bash shell</entry>
<entry>bash$</entry> <entry>bash$</entry>
</row> </row>
<row> <row>
<entry> <entry>
<foreignphrase>Prompt</foreignphrase> Root user's prompt under bash shell</entry>
of root users command under bash shell</entry>
<entry>bash#</entry> <entry>bash#</entry>
</row> </row>
<row> <row>
<entry> <entry>
<foreignphrase>Prompt</foreignphrase> Normal user's prompt under tcsh shell</entry>
of user command under tcsh shell</entry>
<entry>tcsh$</entry> <entry>tcsh$</entry>
</row> </row>
......
docs/xml/installation.xml
View file @ 96a0037a
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> --> <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: installation.xml,v 1.56 2004/01/15 22:34:35 gerv%gerv.net Exp $ --> <!-- $Id: installation.xml,v 1.57 2004/01/15 23:54:39 gerv%gerv.net Exp $ -->
<chapter id="installation"> <chapter id="installation">
<title>Installation</title> <title>Installation</title>
...@@ -11,7 +11,8 @@ ...@@ -11,7 +11,8 @@
<productname class="registered">Microsoft Windows</productname>. Many <productname class="registered">Microsoft Windows</productname>. Many
operating systems have utilities that make installation easier or quirks operating systems have utilities that make installation easier or quirks
that make it harder. We have tried to collect that information in that make it harder. We have tried to collect that information in
<xref linkend="os-specific"/>, so be sure to check out that section before <xref linkend="os-specific"/>, so unless you are on Linux,
be sure to check out that section before
you start your installation. you start your installation.
</para> </para>
...@@ -25,7 +26,8 @@ ...@@ -25,7 +26,8 @@
<warning> <warning>
<para>While installing Bugzilla, it is a good idea to ensure that there <para>While installing Bugzilla, it is a good idea to ensure that there
is some kind of firewall between you and the rest of the Internet is some kind of configurable firewall between you and the rest of the
Internet
as your machine may be insecure for periods during the install. Many as your machine may be insecure for periods during the install. Many
installation steps require an active Internet connection to complete, installation steps require an active Internet connection to complete,
but you must take care to ensure that at no point is your machine but you must take care to ensure that at no point is your machine
...@@ -34,31 +36,30 @@ ...@@ -34,31 +36,30 @@
<para>This guide assumes that you already have your operating system <para>This guide assumes that you already have your operating system
installed, network configured, and have administrative access to the installed, network configured, and have administrative access to the
shell on the machine you are installing Bugzilla onto. It is possible to machine onto which you are installing Bugzilla. It is possible to
install and run Bugzilla without administrative access, but you have to install and run Bugzilla itself without administrative access, but you
have to
either make sure all the required software is installed or get somebody either make sure all the required software is installed or get somebody
with administrative access to install it for you. with administrative access to install it for you.
</para> </para>
<para> <para>
You are strongly recommended to make a backup of your system You are strongly recommended to make a backup of your system
before installing Bugzilla and at regular intervals thereafter. before installing Bugzilla (and at regular intervals thereafter :-).
</para> </para>
<para>The listing below is a basic step-by-step list. More information <para>Here's a basic step-by-step list:
can be found in the sections below. Minimum versions will be
included in parenthesis where appropriate.
</para> </para>
<procedure> <procedure>
<step> <step>
<para><link linkend="install-perl">Install Perl</link> <para><link linkend="install-perl">Install Perl</link>
(&min-perl-ver;) (&min-perl-ver; or above)
</para> </para>
</step> </step>
<step> <step>
<para><link linkend="install-mysql">Install MySQL</link> <para><link linkend="install-mysql">Install MySQL</link>
(&min-mysql-ver;) (&min-mysql-ver; or above)
</para> </para>
</step> </step>
<step> <step>
...@@ -83,7 +84,8 @@ ...@@ -83,7 +84,8 @@
<title>Perl</title> <title>Perl</title>
<para>Any machine that doesn't have Perl on it is a sad machine indeed. <para>Any machine that doesn't have Perl on it is a sad machine indeed.
Perl can be got in source form from <ulink url="http://www.perl.com"/>. If your OS doesn't come with it, Perl can be got in source form
from <ulink url="http://www.perl.com"/>.
There are also binary versions available for many platforms, most of which There are also binary versions available for many platforms, most of which
are linked to from perl.com. are linked to from perl.com.
Although Bugzilla runs with perl &min-perl-ver;, Although Bugzilla runs with perl &min-perl-ver;,
...@@ -95,7 +97,8 @@ ...@@ -95,7 +97,8 @@
<section id="install-mysql"> <section id="install-mysql">
<title>MySQL</title> <title>MySQL</title>
<para>Visit the MySQL homepage at <para>If your OS doesn't come with it or provide official packages,
visit the MySQL homepage at
<ulink url="http://www.mysql.com"/> <ulink url="http://www.mysql.com"/>
to grab and install the latest stable release of the server. to grab and install the latest stable release of the server.
</para> </para>
...@@ -136,16 +139,17 @@ set-variable = max_allowed_packet=1M ...@@ -136,16 +139,17 @@ set-variable = max_allowed_packet=1M
</figure> </figure>
<para>If you are running Bugzilla and MySQL on the same machine, you may <para>If you are running Bugzilla and MySQL on the same machine, you may
also wish to utilize the <option>skip-networking</option> option as also wish to utilize the <option>--skip-networking</option> option as
mentioned in <xref linkend="security-mysql"/> for the added security. mentioned in <xref linkend="security-mysql"/> for the added security.
</para> </para>
<section id="install-setupdatabase"> <section id="install-setupdatabase">
<title>Configuring MySQL</title> <title>Adding a user to MySQL</title>
<para>This first thing you'll want to do is make sure you've given the <para>This first thing you'll want to do is make sure you've given the
<quote>root</quote> user a password as suggested in <quote>root</quote> user a password as suggested in
<xref linkend="security-mysql"/>. For clarity, these instructions will <xref linkend="security-mysql"/>. Then, you need to add a user for
Bugzilla to use. For clarity, these instructions will
assume that your MySQL user for Bugzilla will be <quote>bugs_user</quote>, assume that your MySQL user for Bugzilla will be <quote>bugs_user</quote>,
the database will be called <quote>bugs_db</quote> and the password for the database will be called <quote>bugs_db</quote> and the password for
the <quote>bugs_user</quote> user is <quote>bugs_password</quote>. You the <quote>bugs_user</quote> user is <quote>bugs_password</quote>. You
...@@ -154,14 +158,13 @@ set-variable = max_allowed_packet=1M ...@@ -154,14 +158,13 @@ set-variable = max_allowed_packet=1M
<note> <note>
<para>Most people use <quote>bugs</quote> for both the user and <para>Most people use <quote>bugs</quote> for both the user and
database name. database name. Don't use it for the password, though...
</para> </para>
</note> </note>
<para>Next, we use an SQL <command>GRANT</command> command to create a <para>We use an SQL <command>GRANT</command> command to create a
<quote>bugs_user</quote> <quote>bugs_user</quote>
user, and grant sufficient permissions for checksetup.pl, which we'll user. This also restricts the
use later, to work its magic. This also restricts the
<quote>bugs_user</quote> <quote>bugs_user</quote>
user to operations within a database called user to operations within a database called
<quote>bugs_db</quote>, and only allows the account to connect from <quote>bugs_db</quote>, and only allows the account to connect from
...@@ -179,7 +182,9 @@ set-variable = max_allowed_packet=1M ...@@ -179,7 +182,9 @@ set-variable = max_allowed_packet=1M
<note> <note>
<para>If you are using MySQL 4, the bugs user also needs to be granted <para>If you are using MySQL 4, the bugs user also needs to be granted
the <computeroutput>LOCK TABLES</computeroutput> and the <computeroutput>LOCK TABLES</computeroutput> and
<computeroutput>CREATE TEMPORARY TABLES</computeroutput> permissions. <computeroutput>CREATE TEMPORARY TABLES</computeroutput> permissions,
so add them to the list in the
<computeroutput>GRANT</computeroutput> command.
</para> </para>
</note> </note>
</section> </section>
...@@ -217,21 +222,16 @@ set-variable = max_allowed_packet=1M ...@@ -217,21 +222,16 @@ set-variable = max_allowed_packet=1M
directory.</para> directory.</para>
<tip> <tip>
<para>If you symlink the bugzilla directory into your Apache's HTML <para>If you symlink the bugzilla directory into your Apache's
<filename>html</filename>
hierarchy, you may receive hierarchy, you may receive
<errorname>Forbidden</errorname> <errorname>Forbidden</errorname>
errors unless you add the errors unless you add the
<quote>FollowSymLinks</quote> <filename>FollowSymLinks</filename>
directive to the &lt;Directory&gt; entry for the HTML root directive to the <filename>&lt;Directory&gt;</filename> entry for
in httpd.conf.</para> the HTML root directory in httpd.conf.</para>
</tip> </tip>
<para>Once all the files are in a web accessible directory, make that
directory writable by your webserver's user. This is a temporary step
until you run the post-install
<filename>checksetup.pl</filename>
script, which locks down your installation.</para>
<caution> <caution>
<para>The default Bugzilla distribution is not designed to be placed <para>The default Bugzilla distribution is not designed to be placed
in a <filename class="directory">cgi-bin</filename> directory (this in a <filename class="directory">cgi-bin</filename> directory (this
...@@ -239,15 +239,104 @@ set-variable = max_allowed_packet=1M ...@@ -239,15 +239,104 @@ set-variable = max_allowed_packet=1M
<option>ScriptAlias</option> directive of Apache). <option>ScriptAlias</option> directive of Apache).
</para> </para>
</caution> </caution>
<para>Once all the files are in a web accessible directory, make that
directory writable by your webserver's user. This is a temporary step
until you run the post-install
<filename>checksetup.pl</filename>
script, which locks down your installation.</para>
</section>
<section>
<title>
<filename>checksetup.pl</filename>
</title>
<para>Next, run the magic checksetup.pl script.
This is designed to check whether you have all of the right
Perl modules in the correct
versions, and that Bugzilla is generally set up correctly.
</para>
<para>
Eventually,
it will make sure Bugzilla files and directories have reasonable
permissions, set up the
<filename>data</filename>
directory, and create all the MySQL tables. But the first time you
run it, it's highly likely to tell you that you are missing a few
Perl modules. Make a note of which ones they are, and then proceed to
the next section to install them.
</para>
<screen>
<prompt>bash#</prompt> ./checksetup.pl
</screen>
<para>
The first time you run it with all the correct modules installed,
it will create a file called
<filename>localconfig</filename>.</para>
<para>This file contains a variety of settings you may need to tweak
including how Bugzilla should connect to the MySQL database.</para>
<para>The connection settings include:
<orderedlist>
<listitem>
<para>server's host: just use
<quote>localhost</quote>
if the MySQL server is local</para>
</listitem>
<listitem>
<para>database name:
<quote>bugs_db</quote>
if you're following these directions</para>
</listitem>
<listitem>
<para>MySQL username:
<quote>bugs_user</quote>
if you're following these directions</para>
</listitem>
<listitem>
<para>Password for the
<quote>bugs_user</quote>
MySQL account; (<quote>bugs_password</quote> above)</para>
</listitem>
</orderedlist>
</para>
<para>Edit the file to change these. Once you are happy with the
settings, <filename>su</filename> to the user
your web server runs as, and re-run
<filename>checksetup.pl</filename>. (Note: on some security-conscious
systems, you may need to change the login shell for the webserver
account before you can do this.)
On this second run, it will create the database and an administrator
account for which you will be prompted to provide information.</para>
<note>
<para>The checksetup.pl script is designed so that you can run it at
any time without causing harm. You should run it after any upgrade to
Bugzilla.</para>
</note>
</section> </section>
<section id="install-perlmodules"> <section id="install-perlmodules">
<title>Perl Modules</title> <title>Perl Modules</title>
<para>Don't be intimidated by this long list of modules. See
<xref linkend="install-modules-bundle-bugzilla"/> for a way of
installing all the ones you need with a single command.
</para>
<para>Perl modules can be found using <para>Perl modules can be found using
<glossterm linkend="gloss-cpan">CPAN</glossterm> on Unix based systems or <glossterm linkend="gloss-cpan">CPAN</glossterm> on Unix based systems or
<glossterm linkend="gloss-ppm">PPM</glossterm> on Win32. The root servers <glossterm linkend="gloss-ppm">PPM</glossterm> on Win32.
have a real tendency to bog down, so please use mirrors.
</para> </para>
<para>Good instuctions can be found for using each of these services on <para>Good instuctions can be found for using each of these services on
...@@ -310,7 +399,6 @@ set-variable = max_allowed_packet=1M ...@@ -310,7 +399,6 @@ set-variable = max_allowed_packet=1M
<para>Perl Modules (minimum version): <para>Perl Modules (minimum version):
<orderedlist> <orderedlist>
<!-- TODO: Don't think we actually care about AppConfig anymore -->
<listitem> <listitem>
<para> <para>
<link linkend="install-modules-bundle-bugzilla">Bundle::Bugzilla</link> <link linkend="install-modules-bundle-bugzilla">Bundle::Bugzilla</link>
...@@ -320,13 +408,6 @@ set-variable = max_allowed_packet=1M ...@@ -320,13 +408,6 @@ set-variable = max_allowed_packet=1M
<listitem> <listitem>
<para> <para>
<link linkend="install-modules-appconfig">AppConfig</link>
(&min-appconfig-ver;)
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-cgi">CGI</link> <link linkend="install-modules-cgi">CGI</link>
(&min-cgi-ver;) (&min-cgi-ver;)
</para> </para>
...@@ -334,13 +415,6 @@ set-variable = max_allowed_packet=1M ...@@ -334,13 +415,6 @@ set-variable = max_allowed_packet=1M
<listitem> <listitem>
<para> <para>
<link linkend="install-modules-data-dumper">Data::Dumper</link>
(&min-data-dumper-ver;)
</para>
</listitem>
<listitem>
<para>
<link linkend="install-modules-date-format">Date::Format</link> <link linkend="install-modules-date-format">Date::Format</link>
(&min-date-format-ver;) (&min-date-format-ver;)
</para> </para>
...@@ -477,14 +551,6 @@ ReadLine support enabled ...@@ -477,14 +551,6 @@ ReadLine support enabled
</calloutlist> </calloutlist>
</section> </section>
<section id="install-modules-appconfig">
<title>AppConfig (&min-appconfig-ver;)</title>
<para>Dependency for Template Toolkit. We probably don't need to
specifically check for it anymore.
</para>
</section>
<section id="install-modules-cgi"> <section id="install-modules-cgi">
<title>CGI (&min-cgi-ver;)</title> <title>CGI (&min-cgi-ver;)</title>
...@@ -500,22 +566,6 @@ ReadLine support enabled ...@@ -500,22 +566,6 @@ ReadLine support enabled
</literallayout> </literallayout>
</section> </section>
<section id="install-modules-data-dumper">
<title>Data::Dumper (&min-data-dumper-ver;)</title>
<para>The Data::Dumper module provides data structure persistence for
Perl (similar to Java's serialization). It comes with later
sub-releases of Perl 5.004, but a re-installation just to be sure it's
available won't hurt anything.
</para>
<literallayout>
CPAN Download Page: <ulink url="http://search.cpan.org/dist/Data-Dumper/"/>
PPM Download Link: <ulink url="http://ppm.activestate.com/PPMPackages/zips/6xx-builds-only/Data-Dumper.zip"/>
Documentation: <ulink url="http://www.perldoc.com/perl5.8.0/lib/Data/Dumper.html"/>
</literallayout>
</section>
<section id="install-modules-date-format"> <section id="install-modules-date-format">
<title>TimeDate modules (&min-date-format-ver;)</title> <title>TimeDate modules (&min-date-format-ver;)</title>
...@@ -637,12 +687,8 @@ ReadLine support enabled ...@@ -637,12 +687,8 @@ ReadLine support enabled
<section id="install-modules-gd"> <section id="install-modules-gd">
<title>GD (&min-gd-ver;) [optional]</title> <title>GD (&min-gd-ver;) [optional]</title>
<para>The GD library was written by Thomas Boutell a long while ago to <para>You need the GD library if you want any of the graphing to work.
programmatically generate images in C. Since then it's become the </para>
defacto standard for programmatic image construction. The Perl bindings
to it found in the GD library are used on millions of web pages to
generate graphs on the fly. That's what Bugzilla will be using it for
so you must install it if you want any of the graphing to work.</para>
<note> <note>
<para>The Perl GD library requires some other libraries that may or <para>The Perl GD library requires some other libraries that may or
...@@ -687,7 +733,7 @@ ReadLine support enabled ...@@ -687,7 +733,7 @@ ReadLine support enabled
</section> </section>
<section id="install-modules-xml-parser"> <section id="install-modules-xml-parser">
<title>XML::Parser (&min-xml-parser-ver;) [Optional]</title> <title>XML::Parser (&min-xml-parser-ver;) [optional]</title>
<para>XML::Parser is used by the <filename>importxml.pl</filename> <para>XML::Parser is used by the <filename>importxml.pl</filename>
script. You only need it if you are going to be importing bugs (such as script. You only need it if you are going to be importing bugs (such as
...@@ -704,7 +750,7 @@ ReadLine support enabled ...@@ -704,7 +750,7 @@ ReadLine support enabled
</section> </section>
<section id="install-modules-gd-graph"> <section id="install-modules-gd-graph">
<title>GD::Graph (&min-gd-graph-ver;) [Optional]</title> <title>GD::Graph (&min-gd-graph-ver;) [optional]</title>
<para>In addition to GD listed above, the reporting interface of Bugzilla <para>In addition to GD listed above, the reporting interface of Bugzilla
needs to have the GD::Graph module installed. needs to have the GD::Graph module installed.
...@@ -718,7 +764,7 @@ ReadLine support enabled ...@@ -718,7 +764,7 @@ ReadLine support enabled
</section> </section>
<section id="install-modules-gd-text-align"> <section id="install-modules-gd-text-align">
<title>GD::Text::Align (&min-gd-text-align-ver;) [Optional]</title> <title>GD::Text::Align (&min-gd-text-align-ver;) [optional]</title>
<para>GD::Text::Align, as the name implies, is used to draw aligned <para>GD::Text::Align, as the name implies, is used to draw aligned
strings of text. It is needed by the reporting interface. strings of text. It is needed by the reporting interface.
...@@ -732,7 +778,7 @@ ReadLine support enabled ...@@ -732,7 +778,7 @@ ReadLine support enabled
</section> </section>
<section id="install-modules-mime-parser"> <section id="install-modules-mime-parser">
<title>MIME::Parser (&min-mime-parser-ver;) [Optional]</title> <title>MIME::Parser (&min-mime-parser-ver;) [optional]</title>
<para>MIME::Parser is only needed if you want to use the e-mail interface <para>MIME::Parser is only needed if you want to use the e-mail interface
located in the <filename class="directory">contrib</filename> directory. located in the <filename class="directory">contrib</filename> directory.
...@@ -746,7 +792,7 @@ ReadLine support enabled ...@@ -746,7 +792,7 @@ ReadLine support enabled
</section> </section>
<section id="install-modules-patchreader"> <section id="install-modules-patchreader">
<title>PatchReader (&min-patchreader-ver;) [Optional]</title> <title>PatchReader (&min-patchreader-ver;) [optional]</title>
<para>PatchReader is only needed if you want to use Patch Viewer, a <para>PatchReader is only needed if you want to use Patch Viewer, a
Bugzilla feature to format patches in a pretty HTML fashion. There are a Bugzilla feature to format patches in a pretty HTML fashion. There are a
...@@ -767,77 +813,13 @@ ReadLine support enabled ...@@ -767,77 +813,13 @@ ReadLine support enabled
<section> <section>
<title> <title>Configuring Bugzilla</title>
<filename>checksetup.pl</filename>
</title>
<para>Next, run the magic checksetup.pl script.
This is designed to make sure your perl modules are the correct
version and your MySQL database and other
configuration options are consistent with the Bugzilla CGI files.
It will make sure Bugzilla files and directories have reasonable
permissions, set up the
<filename>data</filename>
directory, and create all the MySQL tables.
</para>
<screen>
<prompt>bash#</prompt> ./checksetup.pl
</screen>
<para> <para>
The first time you run it, it will create a file called Once checksetup.pl has run successfully, Bugzilla should start up.
<filename>localconfig</filename>.</para> Proceed to the correct URL and log in with the administrator account
you defined in the last checksetup.pl run.
<para>This file contains a variety of settings you may need to tweak
including how Bugzilla should connect to the MySQL database.</para>
<para>The connection settings include:
<orderedlist>
<listitem>
<para>server's host: just use
<quote>localhost</quote>
if the MySQL server is local</para>
</listitem>
<listitem>
<para>database name:
<quote>bugs_db</quote>
if you're following these directions</para>
</listitem>
<listitem>
<para>MySQL username:
<quote>bugs_user</quote>
if you're following these directions</para>
</listitem>
<listitem>
<para>Password for the
<quote>bugs_user</quote>
MySQL account; (<quote>bugs_password</quote> above)</para>
</listitem>
</orderedlist>
</para> </para>
<para>Once you are happy with the settings,
<filename>su</filename> to the user
your web server runs as, and re-run
<filename>checksetup.pl</filename>. (Note: on some security-conscious
systems, you may need to change the login shell for the webserver
account before you can do this.)
On this second run, it will create the database and an administrator
account for which you will be prompted to provide information.</para>
<note>
<para>The checksetup.pl script is designed so that you can run it at
any time without causing harm. You should run it after any upgrade to
Bugzilla.</para>
</note>
</section>
<section>
<title>Configuring Bugzilla</title>
<para> <para>
You should run through the parameters on the Edit Parameters page You should run through the parameters on the Edit Parameters page
(link in the footer) and set them all to appropriate values. (link in the footer) and set them all to appropriate values.
......
docs/xml/introduction.xml
View file @ 96a0037a
...@@ -17,30 +17,23 @@ ...@@ -17,30 +17,23 @@
<section id="why-tracking"> <section id="why-tracking">
<title>Why use a bug-tracking system?</title> <title>Why use a bug-tracking system?</title>
<para>For many years, defect-tracking software was principally <para>Those who do not use a bug-tracking system tend to rely on
the domain of large software development houses. Most smaller shops shared lists, email, spreadsheets and/or Post-It notes to monitor the
simply relied on status of defects. This procedure
shared lists and email to monitor the status of defects. This procedure is usually error-prone and tends to cause those bugs judged least
was error-prone and tended to cause those bugs judged least significant by significant by developers to be dropped or ignored.</para>
developers to be dropped or ignored.</para>
<para>Integrated defect-tracking systems make sure that nothing gets
<para>Integrated swept under the carpet; they provide a method of creating, storing,
defect-tracking systems reduce downtime, increase productivity, and raise arranging and processing defect reports and enhancement requests.</para>
customer satisfaction with their systems. Along with full disclosure, an
open bug-tracker allows you to keep in touch with your 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 method for accounting for unusual system or software
issues.</para>
</section> </section>
<section id="why-bugzilla"> <section id="why-bugzilla">
<title>Why use Bugzilla?</title> <title>Why use Bugzilla?</title>
<para>Bugzilla boasts many advanced features. These include: <para>Bugzilla is the leading open-source/free software bug tracking
system. It boasts many advanced features, including:
<itemizedlist> <itemizedlist>
<listitem> <listitem>
<para>Powerful searching</para> <para>Powerful searching</para>
...@@ -75,12 +68,12 @@ ...@@ -75,12 +68,12 @@
</listitem> </listitem>
<listitem> <listitem>
<para>Web, XML, email and console interfaces</para> <para>Completely customisable and/or localisable web user
interface</para>
</listitem> </listitem>
<listitem> <listitem>
<para>Completely customisable and/or localisable web user <para>Additional XML, email and console interfaces</para>
interface</para>
</listitem> </listitem>
<listitem> <listitem>
...@@ -102,8 +95,7 @@ ...@@ -102,8 +95,7 @@
<ulink url="http://www.cvshome.org">CVS</ulink>, <ulink url="http://www.cvshome.org">CVS</ulink>,
<ulink url="http://www.mozilla.org/bonsai.html">Bonsai</ulink>, or <ulink url="http://www.mozilla.org/bonsai.html">Bonsai</ulink>, or
<ulink url="http://www.perforce.com">Perforce SCM</ulink>, Bugzilla <ulink url="http://www.perforce.com">Perforce SCM</ulink>, Bugzilla
provides a powerful, easy-to-use solution to configuration management and provides a powerful, easy-to-use configuration management solution.</para>
replication problems.</para>
</section> </section>
</chapter> </chapter>
......
docs/xml/using.xml
View file @ 96a0037a
...@@ -3,14 +3,17 @@ ...@@ -3,14 +3,17 @@
<chapter id="using"> <chapter id="using">
<title>Using Bugzilla</title> <title>Using Bugzilla</title>
<para>This section contains information for end-users of Bugzilla. <section id="using-intro">
There is a Bugzilla test installation, called <title>Introduction</title>
<ulink url="http://landfill.bugzilla.org/bugzilla-tip/">Landfill</ulink>, <para>This section contains information for end-users of Bugzilla.
which you are welcome to play with (if it's up.) There is a Bugzilla test installation, called
However, it does not necessarily <ulink url="http://landfill.bugzilla.org/bugzilla-tip/">Landfill</ulink>,
have all Bugzilla features enabled, and runs an up-to-the-minute version, which you are welcome to play with (if it's up.)
so some things may not quite work as this document describes.</para> However, it does not necessarily
have all Bugzilla features enabled, and runs an up-to-the-minute version,
so some things may not quite work as this document describes.</para>
</section>
<section id="myaccount"> <section id="myaccount">
<title>Create a Bugzilla Account</title> <title>Create a Bugzilla Account</title>
...@@ -296,6 +299,12 @@ ...@@ -296,6 +299,12 @@
of each bug.</member> of each bug.</member>
<member> <member>
<emphasis>CSV:</emphasis>
get the buglist as comma-separated values, for import into e.g.
a spreadsheet.</member>
<member>
<emphasis>Change Columns:</emphasis> <emphasis>Change Columns:</emphasis>
change the bug attributes which appear in the list.</member> change the bug attributes which appear in the list.</member>
...@@ -313,11 +322,18 @@ ...@@ -313,11 +322,18 @@
Sends mail to the owners of all bugs on the list.</member> Sends mail to the owners of all bugs on the list.</member>
<member> <member>
<emphasis>Edit this query:</emphasis> <emphasis>Edit Search:</emphasis>
If you didn't get exactly the results you were looking for, you can 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 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> to the query you just made so you get more accurate results.</member>
<member>
<emphasis>Remember Search As:</emphasis>
You can give a search a name and remember it; a link will appear
in your page footer giving you quick access to run it again later.
</member>
</simplelist> </simplelist>
</para> </para>
</section> </section>
...@@ -365,6 +381,24 @@ ...@@ -365,6 +381,24 @@
<para>Select "Commit" and send in your bug report.</para> <para>Select "Commit" and send in your bug report.</para>
</listitem> </listitem>
</orderedlist> </orderedlist>
<para>Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
ensure your original information is easily accessible.
</para>
<para>
You do not need to put "any" or similar strings in the URL field.
If there is no specific URL associated with the bug, leave this
field blank.
</para>
<para>If you feel a bug you filed was incorrectly marked as a
DUPLICATE of another, please question it in your bug, not
the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed.
</para>
</section> </section>
<section id="patchviewer"> <section id="patchviewer">
...@@ -552,27 +586,6 @@ ...@@ -552,27 +586,6 @@
out of the bug. out of the bug.
</para> </para>
</section> </section>
<section>
<title>Filing Bugs</title>
<para>Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
ensure your original information is easily accessible.
</para>
<para>
You do not need to put "any" or similar strings in the URL field.
If there is no specific URL associated with the bug, leave this
field blank.
</para>
<para>If you feel a bug you filed was incorrectly marked as a
DUPLICATE of another, please question it in your bug, not
the bug it was duped to. Feel free to CC the person who duped it
if they are not already CCed.
</para>
</section>
</section> </section>
<section id="userpreferences"> <section id="userpreferences">
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment