Skip to content

bugzilla
bugzilla
Commit 58593ba9 authored by barnboy%trilobyte.net's avatar barnboy%trilobyte.net
Browse files
Options

Buncha' release updates. Moved all images to

./images so we don't have multiple copies of the same image, fixed these doc bugs (in no particular order): 94949 97070 97071 97114 96498 95970 96677 94953 96501 96679 97068 97191 97192
parent 073c4767
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 1931 additions and 505 deletions
docs/html/Bugzilla-Guide.html
View file @ 58593ba9
This source diff could not be displayed because it is too large. You can view the blob instead.
docs/html/aboutthisguide.html
View file @ 58593ba9
......@@ -131,8 +131,8 @@ TARGET="_top"
<TT
CLASS="EMAIL"
>&#60;<A
HREF="mailto:barnboy@NOSPAM.trilobyte.net"
>barnboy@NOSPAM.trilobyte.net</A
HREF="mailto:barnboy@trilobyte.net"
>barnboy@trilobyte.net</A
>&#62;</TT
> to correct them.
</P
......
docs/html/bzhacking.html 0 → 100644
View file @ 58593ba9
<HTML
><HEAD
><TITLE
>Hacking Bugzilla</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.61
"><LINK
REL="HOME"
TITLE="The Bugzilla Guide"
HREF="index.html"><LINK
REL="UP"
TITLE="Useful Patches and Utilities for Bugzilla"
HREF="patches.html"><LINK
REL="PREVIOUS"
TITLE="The Quicksearch Utility"
HREF="quicksearch.html"><LINK
REL="NEXT"
TITLE="GNU Free Documentation License"
HREF="gfdl.html"></HEAD
><BODY
CLASS="SECTION"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Bugzilla Guide</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="quicksearch.html"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Appendix D. Useful Patches and Utilities for Bugzilla</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="gfdl.html"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECTION"
><H1
CLASS="SECTION"
><A
NAME="BZHACKING"
>D.5. Hacking Bugzilla</A
></H1
><P
> What follows are some general guidelines for changing Bugzilla, and adhering to good coding practice while doing so. We've had some checkins in the past which ruined Bugzilla installations because of disregard for these conventions. Sorry for the lack of formatting; I got this info into the Guide on the day of 2.14 release and haven't formatted it yet.
</P
><P
CLASS="LITERALLAYOUT"
><br>
The&nbsp;following&nbsp;is&nbsp;a&nbsp;guide&nbsp;for&nbsp;reviewers&nbsp;when&nbsp;checking&nbsp;code&nbsp;into&nbsp;Bugzilla's<br>
CVS&nbsp;repostory&nbsp;at&nbsp;mozilla.org.&nbsp;&nbsp;If&nbsp;you&nbsp;wish&nbsp;to&nbsp;submit&nbsp;patches&nbsp;to&nbsp;Bugzilla,<br>
you&nbsp;should&nbsp;follow&nbsp;the&nbsp;rules&nbsp;and&nbsp;style&nbsp;conventions&nbsp;below.&nbsp;&nbsp;Any&nbsp;code&nbsp;that<br>
does&nbsp;not&nbsp;adhere&nbsp;to&nbsp;these&nbsp;basic&nbsp;rules&nbsp;will&nbsp;not&nbsp;be&nbsp;added&nbsp;to&nbsp;Bugzilla's<br>
codebase.<br>
<br>
&nbsp;1.&nbsp;Usage&nbsp;of&nbsp;variables&nbsp;in&nbsp;Regular&nbsp;Expressions<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;It&nbsp;is&nbsp;very&nbsp;important&nbsp;that&nbsp;you&nbsp;don't&nbsp;use&nbsp;a&nbsp;variable&nbsp;in&nbsp;a&nbsp;regular<br>
&nbsp;&nbsp;&nbsp;&nbsp;expression&nbsp;unless&nbsp;that&nbsp;variable&nbsp;is&nbsp;supposed&nbsp;to&nbsp;contain&nbsp;an&nbsp;expression.<br>
&nbsp;&nbsp;&nbsp;&nbsp;This&nbsp;especially&nbsp;applies&nbsp;when&nbsp;using&nbsp;grep.&nbsp;&nbsp;You&nbsp;should&nbsp;use:<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;grep&nbsp;($_&nbsp;eq&nbsp;$value,&nbsp;@array);<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;NOT&nbsp;-<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;grep&nbsp;(/$value/,&nbsp;@array);<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;you&nbsp;need&nbsp;to&nbsp;use&nbsp;a&nbsp;non-expression&nbsp;variable&nbsp;inside&nbsp;of&nbsp;an&nbsp;expression,&nbsp;be<br>
&nbsp;&nbsp;&nbsp;&nbsp;sure&nbsp;to&nbsp;quote&nbsp;it&nbsp;properly&nbsp;(using&nbsp;\Q..\E).<br>
<br>
Coding&nbsp;Style&nbsp;for&nbsp;Bugzilla<br>
-------------------------<br>
<br>
While&nbsp;it's&nbsp;true&nbsp;that&nbsp;not&nbsp;all&nbsp;of&nbsp;the&nbsp;code&nbsp;currently&nbsp;in&nbsp;Bugzilla&nbsp;adheres&nbsp;to<br>
this&nbsp;styleguide,&nbsp;it&nbsp;is&nbsp;something&nbsp;that&nbsp;is&nbsp;being&nbsp;worked&nbsp;toward.&nbsp;&nbsp;Therefore,<br>
we&nbsp;ask&nbsp;that&nbsp;all&nbsp;new&nbsp;code&nbsp;(submitted&nbsp;patches&nbsp;and&nbsp;new&nbsp;files)&nbsp;follow&nbsp;this&nbsp;guide<br>
as&nbsp;closely&nbsp;as&nbsp;possible&nbsp;(if&nbsp;you're&nbsp;only&nbsp;changing&nbsp;1&nbsp;or&nbsp;2&nbsp;lines,&nbsp;you&nbsp;don't&nbsp;have<br>
to&nbsp;reformat&nbsp;the&nbsp;entire&nbsp;file&nbsp;:).<br>
<br>
&nbsp;1.&nbsp;Whitespace<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;Bugzilla's&nbsp;prefered&nbsp;indentation&nbsp;is&nbsp;4&nbsp;spaces&nbsp;(no&nbsp;tabs,&nbsp;please).<br>
<br>
&nbsp;2.&nbsp;Curly&nbsp;braces.<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;The&nbsp;opening&nbsp;brace&nbsp;of&nbsp;a&nbsp;block&nbsp;should&nbsp;be&nbsp;on&nbsp;the&nbsp;same&nbsp;line&nbsp;as&nbsp;the&nbsp;statement<br>
&nbsp;&nbsp;&nbsp;&nbsp;that&nbsp;is&nbsp;causing&nbsp;the&nbsp;block&nbsp;and&nbsp;the&nbsp;closing&nbsp;brace&nbsp;should&nbsp;be&nbsp;at&nbsp;the&nbsp;same<br>
&nbsp;&nbsp;&nbsp;&nbsp;indentation&nbsp;level&nbsp;as&nbsp;that&nbsp;statement,&nbsp;for&nbsp;example:<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;($var)&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;print&nbsp;"The&nbsp;variable&nbsp;is&nbsp;true";<br>
&nbsp;&nbsp;&nbsp;&nbsp;}&nbsp;else&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;print&nbsp;"Try&nbsp;again";<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;-&nbsp;NOT&nbsp;-<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;if&nbsp;($var)<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;print&nbsp;"The&nbsp;variable&nbsp;is&nbsp;true";<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
&nbsp;&nbsp;&nbsp;&nbsp;else<br>
&nbsp;&nbsp;&nbsp;&nbsp;{<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;print&nbsp;"Try&nbsp;again";<br>
&nbsp;&nbsp;&nbsp;&nbsp;}<br>
<br>
&nbsp;3.&nbsp;File&nbsp;Names<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;File&nbsp;names&nbsp;for&nbsp;bugzilla&nbsp;code&nbsp;and&nbsp;support&nbsp;documention&nbsp;should&nbsp;be&nbsp;legal&nbsp;across<br>
&nbsp;&nbsp;&nbsp;&nbsp;multiple&nbsp;platforms.&nbsp;&nbsp;\&nbsp;/&nbsp;:&nbsp;*&nbsp;?&nbsp;"&nbsp;&#60;&nbsp;&#62;&nbsp;and&nbsp;|&nbsp;are&nbsp;all&nbsp;illegal&nbsp;characters&nbsp;for<br>
&nbsp;&nbsp;&nbsp;&nbsp;filenames&nbsp;on&nbsp;various&nbsp;platforms.&nbsp;&nbsp;Also,&nbsp;file&nbsp;names&nbsp;should&nbsp;not&nbsp;have&nbsp;spaces&nbsp;in<br>
&nbsp;&nbsp;&nbsp;&nbsp;them&nbsp;as&nbsp;they&nbsp;can&nbsp;cause&nbsp;confusion&nbsp;in&nbsp;CVS&nbsp;and&nbsp;other&nbsp;mozilla.org&nbsp;utilities.<br>
<br>
&nbsp;4.&nbsp;Variable&nbsp;Names<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;If&nbsp;a&nbsp;variable&nbsp;is&nbsp;scoped&nbsp;globally&nbsp;($::variable)&nbsp;its&nbsp;name&nbsp;should&nbsp;be&nbsp;descriptive<br>
&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;what&nbsp;it&nbsp;contains.&nbsp;&nbsp;Local&nbsp;variables&nbsp;can&nbsp;be&nbsp;named&nbsp;a&nbsp;bit&nbsp;looser,&nbsp;provided&nbsp;the<br>
&nbsp;&nbsp;&nbsp;&nbsp;context&nbsp;makes&nbsp;their&nbsp;content&nbsp;obvious.&nbsp;&nbsp;For&nbsp;example,&nbsp;$ret&nbsp;could&nbsp;be&nbsp;used&nbsp;as&nbsp;a<br>
&nbsp;&nbsp;&nbsp;&nbsp;staging&nbsp;variable&nbsp;for&nbsp;a&nbsp;routine's&nbsp;return&nbsp;value&nbsp;as&nbsp;the&nbsp;line&nbsp;|return&nbsp;$ret;|&nbsp;will<br>
&nbsp;&nbsp;&nbsp;&nbsp;make&nbsp;it&nbsp;blatently&nbsp;obvious&nbsp;what&nbsp;the&nbsp;variable&nbsp;holds&nbsp;and&nbsp;most&nbsp;likely&nbsp;be&nbsp;shown<br>
&nbsp;&nbsp;&nbsp;&nbsp;on&nbsp;the&nbsp;same&nbsp;screen&nbsp;as&nbsp;|my&nbsp;$ret&nbsp;=&nbsp;"";|.<br>
<br>
&nbsp;5.&nbsp;Cross&nbsp;Database&nbsp;Compatability<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;Bugzilla&nbsp;was&nbsp;originally&nbsp;written&nbsp;to&nbsp;work&nbsp;with&nbsp;MySQL&nbsp;and&nbsp;therefore&nbsp;took&nbsp;advantage<br>
&nbsp;&nbsp;&nbsp;&nbsp;of&nbsp;some&nbsp;of&nbsp;its&nbsp;features&nbsp;that&nbsp;aren't&nbsp;contained&nbsp;in&nbsp;other&nbsp;RDBMS&nbsp;software.&nbsp;&nbsp;These<br>
&nbsp;&nbsp;&nbsp;&nbsp;should&nbsp;be&nbsp;avoided&nbsp;in&nbsp;all&nbsp;new&nbsp;code.&nbsp;&nbsp;Examples&nbsp;of&nbsp;these&nbsp;features&nbsp;are&nbsp;enums&nbsp;and<br>
&nbsp;&nbsp;&nbsp;&nbsp;encrypt().<br>
<br>
&nbsp;6.&nbsp;Cross&nbsp;Platform&nbsp;Compatability<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;While&nbsp;Bugzilla&nbsp;was&nbsp;written&nbsp;to&nbsp;be&nbsp;used&nbsp;on&nbsp;Unix&nbsp;based&nbsp;systems&nbsp;(and&nbsp;Unix/Linux&nbsp;is<br>
&nbsp;&nbsp;&nbsp;&nbsp;still&nbsp;the&nbsp;only&nbsp;officially&nbsp;supported&nbsp;platform)&nbsp;there&nbsp;are&nbsp;many&nbsp;who&nbsp;desire/need&nbsp;to<br>
&nbsp;&nbsp;&nbsp;&nbsp;run&nbsp;Bugzilla&nbsp;on&nbsp;Microsoft&nbsp;Windows&nbsp;boxes.&nbsp;&nbsp;Whenever&nbsp;possible,&nbsp;we&nbsp;should&nbsp;strive<br>
&nbsp;&nbsp;&nbsp;&nbsp;not&nbsp;to&nbsp;make&nbsp;the&nbsp;lives&nbsp;of&nbsp;these&nbsp;people&nbsp;any&nbsp;more&nbsp;complicated&nbsp;and&nbsp;avoid&nbsp;doing&nbsp;things<br>
&nbsp;&nbsp;&nbsp;&nbsp;that&nbsp;break&nbsp;Bugzilla's&nbsp;ability&nbsp;to&nbsp;run&nbsp;on&nbsp;multiple&nbsp;operating&nbsp;systems.<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="quicksearch.html"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="gfdl.html"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>The Quicksearch Utility</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="patches.html"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>GNU Free Documentation License</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
\ No newline at end of file
docs/html/contributors.html
View file @ 58593ba9
......@@ -78,7 +78,8 @@ NAME="CONTRIBUTORS"
documentation (in no particular order):
</P
><P
> Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum
> Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron
Teitelbaum, Jacob Steenhagen, Joe Robins
</P
></DIV
><DIV
......
docs/html/copyright.html
View file @ 58593ba9
......@@ -122,8 +122,7 @@ WIDTH="10%"
><P
> If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
please contact Matthew P. Barnson. Remove "NOSPAM" from email address
to send.
please contact Matthew P. Barnson.
</P
></DIV
><DIV
......
docs/html/credits.html
View file @ 58593ba9
......@@ -85,8 +85,8 @@ HREF="mailto://terry@mozilla.org"
TARGET="_top"
>Terry Weissman</A
>
for initially converting Bugzilla from BugSplat! and writing the
README upon which this documentation is largely based.
for initially writing Bugzilla and creating the
README upon which the UNIX installation documentation is largely based.
</P
><P
> <A
......
docs/html/cvs.html
View file @ 58593ba9
......@@ -91,6 +91,20 @@ CLASS="QUOTE"
an @resolution field, you can even change the Bugzilla bug
state.
</P
><P
> There is also a project, based upon somewhat dated Bugzilla
code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at:
<A
HREF="http://homepages.kcbbs.gen.nz/~tonyg/"
TARGET="_top"
> http://homepages.kcbbs.gen.nz/~tonyg/</A
>, under the
<SPAN
CLASS="QUOTE"
>"cvszilla"</SPAN
> link.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
......
docs/html/dbdoc.html
View file @ 58593ba9
......@@ -137,7 +137,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN2217"
NAME="AEN2331"
>C.2.1. Bugzilla Database Basics</A
></H2
><P
......@@ -260,7 +260,7 @@ CLASS="SECTION"
><H3
CLASS="SECTION"
><A
NAME="AEN2246"
NAME="AEN2360"
>C.2.1.1. Bugzilla Database Tables</A
></H3
><P
......
docs/html/dbschema.html
View file @ 58593ba9
......@@ -78,7 +78,7 @@ NAME="DBSCHEMA"
CLASS="MEDIAOBJECT"
><P
><IMG
SRC="dbschema.jpg"
SRC="../images/dbschema.jpg"
ALT="Database Relationships"
></IMG
><DIV
......
docs/html/geninstall.html
View file @ 58593ba9
......@@ -78,7 +78,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN916"
NAME="AEN941"
>3.5.1. Modifying Your Running System</A
></H2
><P
......@@ -111,7 +111,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN923"
NAME="AEN948"
>3.5.2. Upgrading From Previous Versions</A
></H2
><P
......@@ -323,7 +323,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN964"
NAME="UNIXHISTORY"
>3.5.6. UNIX Installation Instructions History</A
></H2
><P
......@@ -335,9 +335,11 @@ NAME="AEN964"
> The February 25, 1999 re-write of this page was done by Ry4an
Brase &#60;ry4an@ry4an.org&#62;, with some edits by Terry
Weissman, Bryce Nesbitt, Martin Pool, &#38; Dan Mosedale (But
don't send bug reports to them; report them using bugzilla, at
http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools,
component Bugzilla).
don't send bug reports to them; report them using bugzilla, at <A
HREF="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla"
TARGET="_top"
>http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</A
> ).
</P
><P
> This document was heavily modified again Wednesday, March 07
......
docs/html/gfdl.html
View file @ 58593ba9
......@@ -10,8 +10,8 @@ REL="HOME"
TITLE="The Bugzilla Guide"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="The Quicksearch Utility"
HREF="quicksearch.html"><LINK
TITLE="Hacking Bugzilla"
HREF="bzhacking.html"><LINK
REL="NEXT"
TITLE="PREAMBLE"
HREF="gfdl_0.html"></HEAD
......@@ -41,7 +41,7 @@ WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="quicksearch.html"
HREF="bzhacking.html"
>Prev</A
></TD
><TD
......@@ -141,7 +141,7 @@ HREF="gfdl_howto.html"
><P
>Version 1.1, March 2000</P
><A
NAME="AEN2416"
NAME="AEN2499"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
......@@ -167,7 +167,7 @@ WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="quicksearch.html"
HREF="bzhacking.html"
>Prev</A
></TD
><TD
......@@ -192,7 +192,7 @@ HREF="gfdl_0.html"
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>The Quicksearch Utility</TD
>Hacking Bugzilla</TD
><TD
WIDTH="34%"
ALIGN="center"
......
docs/html/gfdl_howto.html
View file @ 58593ba9
......@@ -78,7 +78,7 @@ NAME="GFDL_HOWTO"
a copy of the License in the document and put the following
copyright and license notices just after the title page:</P
><A
NAME="AEN2506"
NAME="AEN2589"
></A
><BLOCKQUOTE
CLASS="BLOCKQUOTE"
......
docs/html/glossary.html
View file @ 58593ba9
......@@ -68,7 +68,7 @@ CLASS="GLOSSDIV"
><H1
CLASS="GLOSSDIV"
><A
NAME="AEN2511"
NAME="AEN2594"
>0-9, high ascii</A
></H1
><DL
......@@ -402,7 +402,7 @@ NAME="GLOSS_P"
><DIV
CLASS="EXAMPLE"
><A
NAME="AEN2602"
NAME="AEN2685"
></A
><P
><B
......
docs/html/granttables.html
View file @ 58593ba9
......@@ -16,8 +16,8 @@ REL="PREVIOUS"
TITLE="MySQL Bugzilla Database Introduction"
HREF="dbdoc.html"><LINK
REL="NEXT"
TITLE="Bugzilla Variants and Competitors"
HREF="variants.html"></HEAD
TITLE="Useful Patches and Utilities for Bugzilla"
HREF="patches.html"></HEAD
><BODY
CLASS="SECTION"
BGCOLOR="#FFFFFF"
......@@ -57,7 +57,7 @@ WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="variants.html"
HREF="patches.html"
>Next</A
></TD
></TR
......@@ -313,7 +313,7 @@ WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="variants.html"
HREF="patches.html"
>Next</A
></TD
></TR
......@@ -335,7 +335,7 @@ HREF="database.html"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Bugzilla Variants and Competitors</TD
>Useful Patches and Utilities for Bugzilla</TD
></TR
></TABLE
></DIV
......
docs/html/how.html
View file @ 58593ba9
......@@ -438,13 +438,13 @@ CLASS="QUOTE"
>scrollbox</EM
>. Using the down arrow on
the scrollbox, scroll down until you can see an entry
called "Webtools". Select this entry.
called "Bugzilla". Select this entry.
</P
></LI
><LI
><P
> Did you notice that some of the boxes to the right changed
when you selected "Webtools"? Every Program (or Product)
when you selected "Bugzilla"? Every Program (or Product)
has different Versions, Components, and Target Milestones
associated with it. A "Version" is the number of a
software program.
......@@ -519,7 +519,7 @@ NAME="AEN317"
></A
><P
><B
>Example 2-2. Mozilla Webtools Components</B
>Example 2-2. Mozilla's Bugzilla Components</B
></P
><DIV
CLASS="INFORMALEXAMPLE"
......@@ -529,7 +529,7 @@ NAME="AEN319"
><P
></P
><P
> Mozilla's "Webtools" Product is composed of several pieces (Components):
> Mozilla's "Bugzilla" Product is composed of several pieces (Components):
<P
></P
><TABLE
......@@ -538,60 +538,166 @@ BORDER="0"
><TR
><TD
><EM
>Bonsai</EM
>Administration</EM
>,
a tool to show recent changes to Mozilla</TD
Administration of a bugzilla installation, including
<TT
CLASS="FILENAME"
>editcomponents.cgi</TT
>,
<TT
CLASS="FILENAME"
>editgroups.cgi</TT
>,
<TT
CLASS="FILENAME"
>editkeywords.cgi</TT
>,
<TT
CLASS="FILENAME"
>editparams.cgi</TT
>,
<TT
CLASS="FILENAME"
>editproducts.cgi</TT
>,
<TT
CLASS="FILENAME"
>editusers.cgi</TT
>,
<TT
CLASS="FILENAME"
>editversions.cgi,</TT
> and
<TT
CLASS="FILENAME"
>sanitycheck.cgi</TT
>.
</TD
></TR
><TR
><TD
><EM
>Bugzilla</EM
>Bugzilla-General</EM
>,
a defect-tracking tool</TD
Anything that doesn't fit in the other components, or spans
multiple components.
</TD
></TR
><TR
><TD
><EM
>Build</EM
>Creating/Changing Bugs</EM
>,
Creating, changing, and viewing bugs.
<TT
CLASS="FILENAME"
>enter_bug.cgi</TT
>,
<TT
CLASS="FILENAME"
>post_bug.cgi</TT
>,
a tool to automatically compile source code
into machine-readable form</TD
<TT
CLASS="FILENAME"
>show_bug.cgi</TT
> and
<TT
CLASS="FILENAME"
>process_bug.cgi</TT
>.
</TD
></TR
><TR
><TD
><EM
>Despot</EM
>Documentation</EM
>,
a program that controls access to the other Webtools</TD
The bugzilla documentation, including anything in the
<TT
CLASS="FILENAME"
>docs/</TT
> directory and The Bugzilla Guide
(This document :)
</TD
></TR
><TR
><TD
><EM
>LXR</EM
>Email</EM
>,
a utility that automatically marks up text files
to make them more readable</TD
Anything to do with email sent by Bugzilla.
<TT
CLASS="FILENAME"
>processmail</TT
>
</TD
></TR
><TR
><TD
><EM
>MozBot</EM
>Installation</EM
>,
a "robot" that announces changes to Mozilla in Chat</TD
The installation process of Bugzilla. This includes
<TT
CLASS="FILENAME"
>checksetup.pl</TT
> and whatever else it evolves into.
</TD
></TR
><TR
><TD
><EM
>TestManager</EM
>Query/Buglist</EM
>,
a tool to help find bugs in Mozilla</TD
Anything to do with searching for bugs and viewing the buglists.
<TT
CLASS="FILENAME"
>query.cgi</TT
> and
<TT
CLASS="FILENAME"
>buglist.cgi</TT
>
</TD
></TR
><TR
><TD
><EM
>Tinderbox</EM
>Reporting/Charting</EM
>,
which displays reports from Build</TD
Getting reports from Bugzilla.
<TT
CLASS="FILENAME"
>reports.cgi</TT
> and
<TT
CLASS="FILENAME"
>duplicates.cgi</TT
>
</TD
></TR
><TR
><TD
><EM
>User Accounts</EM
>,
Anything about managing a user account from the user's perspective.
<TT
CLASS="FILENAME"
>userprefs.cgi</TT
>, saved queries, creating accounts,
changing passwords, logging in, etc.
</TD
></TR
><TR
><TD
><EM
>User Interface</EM
>,
General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates, etc.
</TD
></TR
></TBODY
></TABLE
......@@ -600,11 +706,6 @@ BORDER="0"
>
</P
><P
> A different person is responsible for each of these Components.
Tara Hernandez keeps
the "Bugzilla" component up-to-date.
</P
><P
></P
></DIV
></DIV
......
docs/html/index.html
View file @ 58593ba9
......@@ -59,7 +59,7 @@ CLASS="AFFILIATION"
CLASS="ADDRESS"
><P
CLASS="ADDRESS"
>barnboy@NOSPAM.trilobyte.net</P
>barnboy@trilobyte.net</P
></DIV
></DIV
><SPAN
......@@ -73,7 +73,7 @@ CLASS="AFFILIATION"
CLASS="ADDRESS"
><P
CLASS="ADDRESS"
>zach@NOSPAM.zachlipton.com</P
>zach AT zachlipton DOT com</P
></DIV
></DIV
><BR></SPAN
......@@ -409,12 +409,12 @@ HREF="stepbystep.html"
><DL
><DT
>3.2.1. <A
HREF="stepbystep.html#AEN486"
HREF="stepbystep.html#AEN509"
>Introduction</A
></DT
><DT
>3.2.2. <A
HREF="stepbystep.html#AEN492"
HREF="stepbystep.html#AEN515"
>Installing the Prerequisites</A
></DT
><DT
......@@ -429,57 +429,57 @@ HREF="stepbystep.html#INSTALL-PERL"
></DT
><DT
>3.2.5. <A
HREF="stepbystep.html#AEN579"
HREF="stepbystep.html#AEN602"
>DBI Perl Module</A
></DT
><DT
>3.2.6. <A
HREF="stepbystep.html#AEN617"
HREF="stepbystep.html#AEN640"
>Data::Dumper Perl Module</A
></DT
><DT
>3.2.7. <A
HREF="stepbystep.html#AEN622"
HREF="stepbystep.html#AEN645"
>MySQL related Perl Module Collection</A
></DT
><DT
>3.2.8. <A
HREF="stepbystep.html#AEN631"
HREF="stepbystep.html#AEN654"
>TimeDate Perl Module Collection</A
></DT
><DT
>3.2.9. <A
HREF="stepbystep.html#AEN635"
HREF="stepbystep.html#AEN658"
>GD Perl Module (1.8.3)</A
></DT
><DT
>3.2.10. <A
HREF="stepbystep.html#AEN644"
HREF="stepbystep.html#AEN667"
>Chart::Base Perl Module (0.99c)</A
></DT
><DT
>3.2.11. <A
HREF="stepbystep.html#AEN648"
HREF="stepbystep.html#AEN671"
>DB_File Perl Module</A
></DT
><DT
>3.2.12. <A
HREF="stepbystep.html#AEN651"
HREF="stepbystep.html#AEN674"
>HTTP Server</A
></DT
><DT
>3.2.13. <A
HREF="stepbystep.html#AEN669"
HREF="stepbystep.html#AEN692"
>Installing the Bugzilla Files</A
></DT
><DT
>3.2.14. <A
HREF="stepbystep.html#AEN696"
HREF="stepbystep.html#AEN721"
>Setting Up the MySQL Database</A
></DT
><DT
>3.2.15. <A
HREF="stepbystep.html#AEN743"
HREF="stepbystep.html#AEN768"
>Tweaking <TT
CLASS="FILENAME"
>localconfig</TT
......@@ -487,22 +487,22 @@ CLASS="FILENAME"
></DT
><DT
>3.2.16. <A
HREF="stepbystep.html#AEN781"
HREF="stepbystep.html#AEN806"
>Setting Up Maintainers Manually (Optional)</A
></DT
><DT
>3.2.17. <A
HREF="stepbystep.html#AEN792"
HREF="stepbystep.html#AEN817"
>The Whining Cron (Optional)</A
></DT
><DT
>3.2.18. <A
HREF="stepbystep.html#AEN802"
HREF="stepbystep.html#AEN827"
>Bug Graphs (Optional)</A
></DT
><DT
>3.2.19. <A
HREF="stepbystep.html#AEN814"
HREF="stepbystep.html#AEN839"
>Securing MySQL</A
></DT
></DL
......@@ -526,12 +526,12 @@ HREF="geninstall.html"
><DL
><DT
>3.5.1. <A
HREF="geninstall.html#AEN916"
HREF="geninstall.html#AEN941"
>Modifying Your Running System</A
></DT
><DT
>3.5.2. <A
HREF="geninstall.html#AEN923"
HREF="geninstall.html#AEN948"
>Upgrading From Previous Versions</A
></DT
><DT
......@@ -557,7 +557,7 @@ HREF="geninstall.html#CONTENT_TYPE"
></DT
><DT
>3.5.6. <A
HREF="geninstall.html#AEN964"
HREF="geninstall.html#UNIXHISTORY"
>UNIX Installation Instructions History</A
></DT
></DL
......@@ -579,6 +579,11 @@ HREF="win32.html#WININSTALL"
HREF="win32.html#ADDLWINTIPS"
>Additional Windows Tips</A
></DT
><DT
>3.6.3. <A
HREF="win32.html#BZLDAP"
>Bugzilla LDAP Integration</A
></DT
></DL
></DD
></DL
......@@ -720,6 +725,45 @@ HREF="future.html"
>The Future of Bugzilla</A
></DT
><DT
>7. <A
HREF="variants.html"
>Bugzilla Variants and Competitors</A
></DT
><DD
><DL
><DT
>7.1. <A
HREF="rhbugzilla.html"
>Red Hat Bugzilla</A
></DT
><DT
>7.2. <A
HREF="variant_fenris.html"
>Loki Bugzilla (Fenris)</A
></DT
><DT
>7.3. <A
HREF="variant_issuezilla.html"
>Issuezilla</A
></DT
><DT
>7.4. <A
HREF="variant_scarab.html"
>Scarab</A
></DT
><DT
>7.5. <A
HREF="variant_perforce.html"
>Perforce SCM</A
></DT
><DT
>7.6. <A
HREF="variant_sourceforge.html"
>SourceForge</A
></DT
></DL
></DD
><DT
>A. <A
HREF="faq.html"
>The Bugzilla FAQ</A
......@@ -750,14 +794,14 @@ HREF="dbdoc.html"
><DL
><DT
>C.2.1. <A
HREF="dbdoc.html#AEN2217"
HREF="dbdoc.html#AEN2331"
>Bugzilla Database Basics</A
></DT
><DD
><DL
><DT
>C.2.1.1. <A
HREF="dbdoc.html#AEN2246"
HREF="dbdoc.html#AEN2360"
>Bugzilla Database Tables</A
></DT
></DL
......@@ -772,45 +816,6 @@ HREF="granttables.html"
></DL
></DD
><DT
>7. <A
HREF="variants.html"
>Bugzilla Variants and Competitors</A
></DT
><DD
><DL
><DT
>7.1. <A
HREF="rhbugzilla.html"
>Red Hat Bugzilla</A
></DT
><DT
>7.2. <A
HREF="variant_fenris.html"
>Loki Bugzilla (Fenris)</A
></DT
><DT
>7.3. <A
HREF="variant_issuezilla.html"
>Issuezilla</A
></DT
><DT
>7.4. <A
HREF="variant_scarab.html"
>Scarab</A
></DT
><DT
>7.5. <A
HREF="variant_perforce.html"
>Perforce SCM</A
></DT
><DT
>7.6. <A
HREF="variant_sourceforge.html"
>SourceForge</A
></DT
></DL
></DD
><DT
>D. <A
HREF="patches.html"
>Useful Patches and Utilities for Bugzilla</A
......@@ -840,6 +845,11 @@ HREF="cmdline.html"
HREF="quicksearch.html"
>The Quicksearch Utility</A
></DT
><DT
>D.5. <A
HREF="bzhacking.html"
>Hacking Bugzilla</A
></DT
></DL
></DD
><DT
......@@ -934,67 +944,72 @@ HREF="how.html#AEN307"
><DT
>2-2. <A
HREF="how.html#AEN317"
>Mozilla Webtools Components</A
>Mozilla's Bugzilla Components</A
></DT
><DT
>3-1. <A
HREF="stepbystep.html#AEN685"
HREF="stepbystep.html#AEN708"
>Setting up bonsaitools symlink</A
></DT
><DT
>3-2. <A
HREF="stepbystep.html#AEN774"
HREF="stepbystep.html#AEN799"
>Running checksetup.pl as the web user</A
></DT
><DT
>3-3. <A
HREF="win32.html#AEN1012"
HREF="win32.html#AEN1038"
>Installing ActivePerl ppd Modules on Microsoft Windows</A
></DT
><DT
>3-4. <A
HREF="win32.html#AEN1180"
HREF="win32.html#AEN1224"
>Removing encrypt() for Windows NT Bugzilla version
2.12 or earlier</A
></DT
><DT
>4-1. <A
HREF="programadmin.html#AEN1413"
HREF="programadmin.html#AEN1461"
>Creating some Components</A
></DT
><DT
>4-2. <A
HREF="programadmin.html#AEN1442"
HREF="programadmin.html#AEN1490"
>Common Use of Versions</A
></DT
><DT
>4-3. <A
HREF="programadmin.html#AEN1446"
HREF="programadmin.html#AEN1494"
>A Different Use of Versions</A
></DT
><DT
>4-4. <A
HREF="programadmin.html#AEN1474"
HREF="programadmin.html#AEN1522"
>Using SortKey with Target Milestone</A
></DT
><DT
>4-5. <A
HREF="programadmin.html#AEN1510"
HREF="programadmin.html#AEN1558"
>When to Use Group Security</A
></DT
><DT
>4-6. <A
HREF="programadmin.html#AEN1527"
HREF="programadmin.html#AEN1575"
>Creating a New Group</A
></DT
><DT
>4-7. <A
HREF="programadmin.html#AEN1592"
>Bugzilla Groups</A
></DT
><DT
>D-1. <A
HREF="setperl.html#AEN2360"
HREF="setperl.html#AEN2439"
>Using Setperl to set your perl path</A
></DT
><DT
>1. <A
HREF="glossary.html#AEN2602"
HREF="glossary.html#AEN2685"
>A Sample Product</A
></DT
></DL
......
docs/html/installation.html
View file @ 58593ba9
......@@ -90,12 +90,12 @@ HREF="stepbystep.html"
><DL
><DT
>3.2.1. <A
HREF="stepbystep.html#AEN486"
HREF="stepbystep.html#AEN509"
>Introduction</A
></DT
><DT
>3.2.2. <A
HREF="stepbystep.html#AEN492"
HREF="stepbystep.html#AEN515"
>Installing the Prerequisites</A
></DT
><DT
......@@ -110,57 +110,57 @@ HREF="stepbystep.html#INSTALL-PERL"
></DT
><DT
>3.2.5. <A
HREF="stepbystep.html#AEN579"
HREF="stepbystep.html#AEN602"
>DBI Perl Module</A
></DT
><DT
>3.2.6. <A
HREF="stepbystep.html#AEN617"
HREF="stepbystep.html#AEN640"
>Data::Dumper Perl Module</A
></DT
><DT
>3.2.7. <A
HREF="stepbystep.html#AEN622"
HREF="stepbystep.html#AEN645"
>MySQL related Perl Module Collection</A
></DT
><DT
>3.2.8. <A
HREF="stepbystep.html#AEN631"
HREF="stepbystep.html#AEN654"
>TimeDate Perl Module Collection</A
></DT
><DT
>3.2.9. <A
HREF="stepbystep.html#AEN635"
HREF="stepbystep.html#AEN658"
>GD Perl Module (1.8.3)</A
></DT
><DT
>3.2.10. <A
HREF="stepbystep.html#AEN644"
HREF="stepbystep.html#AEN667"
>Chart::Base Perl Module (0.99c)</A
></DT
><DT
>3.2.11. <A
HREF="stepbystep.html#AEN648"
HREF="stepbystep.html#AEN671"
>DB_File Perl Module</A
></DT
><DT
>3.2.12. <A
HREF="stepbystep.html#AEN651"
HREF="stepbystep.html#AEN674"
>HTTP Server</A
></DT
><DT
>3.2.13. <A
HREF="stepbystep.html#AEN669"
HREF="stepbystep.html#AEN692"
>Installing the Bugzilla Files</A
></DT
><DT
>3.2.14. <A
HREF="stepbystep.html#AEN696"
HREF="stepbystep.html#AEN721"
>Setting Up the MySQL Database</A
></DT
><DT
>3.2.15. <A
HREF="stepbystep.html#AEN743"
HREF="stepbystep.html#AEN768"
>Tweaking <TT
CLASS="FILENAME"
>localconfig</TT
......@@ -168,22 +168,22 @@ CLASS="FILENAME"
></DT
><DT
>3.2.16. <A
HREF="stepbystep.html#AEN781"
HREF="stepbystep.html#AEN806"
>Setting Up Maintainers Manually (Optional)</A
></DT
><DT
>3.2.17. <A
HREF="stepbystep.html#AEN792"
HREF="stepbystep.html#AEN817"
>The Whining Cron (Optional)</A
></DT
><DT
>3.2.18. <A
HREF="stepbystep.html#AEN802"
HREF="stepbystep.html#AEN827"
>Bug Graphs (Optional)</A
></DT
><DT
>3.2.19. <A
HREF="stepbystep.html#AEN814"
HREF="stepbystep.html#AEN839"
>Securing MySQL</A
></DT
></DL
......@@ -207,12 +207,12 @@ HREF="geninstall.html"
><DL
><DT
>3.5.1. <A
HREF="geninstall.html#AEN916"
HREF="geninstall.html#AEN941"
>Modifying Your Running System</A
></DT
><DT
>3.5.2. <A
HREF="geninstall.html#AEN923"
HREF="geninstall.html#AEN948"
>Upgrading From Previous Versions</A
></DT
><DT
......@@ -238,7 +238,7 @@ HREF="geninstall.html#CONTENT_TYPE"
></DT
><DT
>3.5.6. <A
HREF="geninstall.html#AEN964"
HREF="geninstall.html#UNIXHISTORY"
>UNIX Installation Instructions History</A
></DT
></DL
......@@ -260,6 +260,11 @@ HREF="win32.html#WININSTALL"
HREF="win32.html#ADDLWINTIPS"
>Additional Windows Tips</A
></DT
><DT
>3.6.3. <A
HREF="win32.html#BZLDAP"
>Bugzilla LDAP Integration</A
></DT
></DL
></DD
></DL
......
docs/html/patches.html
View file @ 58593ba9
......@@ -10,8 +10,8 @@ REL="HOME"
TITLE="The Bugzilla Guide"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="SourceForge"
HREF="variant_sourceforge.html"><LINK
TITLE="MySQL Permissions & Grant Tables"
HREF="granttables.html"><LINK
REL="NEXT"
TITLE="Apache mod_rewrite magic"
HREF="rewrite.html"></HEAD
......@@ -41,7 +41,7 @@ WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="variant_sourceforge.html"
HREF="granttables.html"
>Prev</A
></TD
><TD
......@@ -99,6 +99,11 @@ HREF="cmdline.html"
HREF="quicksearch.html"
>The Quicksearch Utility</A
></DT
><DT
>D.5. <A
HREF="bzhacking.html"
>Hacking Bugzilla</A
></DT
></DL
></DIV
><P
......@@ -119,7 +124,7 @@ WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="variant_sourceforge.html"
HREF="granttables.html"
>Prev</A
></TD
><TD
......@@ -144,7 +149,7 @@ HREF="rewrite.html"
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>SourceForge</TD
>MySQL Permissions &#38; Grant Tables</TD
><TD
WIDTH="34%"
ALIGN="center"
......
docs/html/programadmin.html
View file @ 58593ba9
......@@ -232,7 +232,7 @@ NAME="COMPONENTS"
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1413"
NAME="AEN1461"
></A
><P
><B
......@@ -241,7 +241,7 @@ NAME="AEN1413"
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN1415"
NAME="AEN1463"
></A
><P
></P
......@@ -387,7 +387,7 @@ NAME="VERSIONS"
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1442"
NAME="AEN1490"
></A
><P
><B
......@@ -396,7 +396,7 @@ NAME="AEN1442"
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN1444"
NAME="AEN1492"
></A
><P
></P
......@@ -418,7 +418,7 @@ NAME="AEN1444"
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1446"
NAME="AEN1494"
></A
><P
><B
......@@ -427,7 +427,7 @@ NAME="AEN1446"
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN1448"
NAME="AEN1496"
></A
><P
></P
......@@ -564,7 +564,7 @@ TYPE="1"
><DIV
CLASS="EXAMPLE"
><A
NAME="AEN1474"
NAME="AEN1522"
></A
><P
><B
......@@ -573,7 +573,7 @@ NAME="AEN1474"
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN1476"
NAME="AEN1524"
></A
><P
></P
......@@ -787,7 +787,7 @@ NAME="GROUPS"
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1510"
NAME="AEN1558"
></A
><P
><B
......@@ -796,7 +796,7 @@ NAME="AEN1510"
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN1512"
NAME="AEN1560"
></A
><P
></P
......@@ -913,7 +913,7 @@ TYPE="1"
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1527"
NAME="AEN1575"
></A
><P
><B
......@@ -922,7 +922,7 @@ NAME="AEN1527"
><DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN1529"
NAME="AEN1577"
></A
><P
></P
......@@ -1043,6 +1043,112 @@ VALIGN="TOP"
</P
></LI
></OL
><P
> You may find this example illustrative for how bug groups work.
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN1592"
></A
><P
><B
>Example 4-7. Bugzilla Groups</B
></P
><P
CLASS="LITERALLAYOUT"
>Bugzilla&nbsp;Groups&nbsp;example<br>
-----------------------<br>
<br>
For&nbsp;this&nbsp;example,&nbsp;let&nbsp;us&nbsp;suppose&nbsp;we&nbsp;have&nbsp;four&nbsp;groups,&nbsp;call&nbsp;them<br>
Group1,&nbsp;Group2,&nbsp;Group3,&nbsp;and&nbsp;Group4.<br>
<br>
We&nbsp;have&nbsp;5&nbsp;users,&nbsp;User1,&nbsp;User2,&nbsp;User3,&nbsp;User4,&nbsp;User5.<br>
<br>
We&nbsp;have&nbsp;8&nbsp;bugs,&nbsp;Bug1,&nbsp;...,&nbsp;Bug8.<br>
<br>
Group&nbsp;membership&nbsp;is&nbsp;defined&nbsp;by&nbsp;this&nbsp;chart:<br>
(X&nbsp;denotes&nbsp;that&nbsp;user&nbsp;is&nbsp;in&nbsp;that&nbsp;group.)<br>
(I&nbsp;apologize&nbsp;for&nbsp;the&nbsp;nasty&nbsp;formatting&nbsp;of&nbsp;this&nbsp;table.&nbsp;&nbsp;Try&nbsp;viewing<br>
it&nbsp;in&nbsp;a&nbsp;text-based&nbsp;browser&nbsp;or&nbsp;something&nbsp;for&nbsp;now.&nbsp;-MPB)<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;G&nbsp;G&nbsp;G&nbsp;G<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;r&nbsp;r&nbsp;r&nbsp;r<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;o&nbsp;o&nbsp;o&nbsp;o<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;u&nbsp;u&nbsp;u&nbsp;u<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;p&nbsp;p&nbsp;p&nbsp;p<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1&nbsp;2&nbsp;3&nbsp;4<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
User1|X|&nbsp;|&nbsp;|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
User2|&nbsp;|X|&nbsp;|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
User3|X|&nbsp;|X|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
User4|X|X|X|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
User5|&nbsp;|&nbsp;|&nbsp;|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
<br>
Bug&nbsp;restrictions&nbsp;are&nbsp;defined&nbsp;by&nbsp;this&nbsp;chart:<br>
(X&nbsp;denotes&nbsp;that&nbsp;bug&nbsp;is&nbsp;restricted&nbsp;to&nbsp;that&nbsp;group.)<br>
<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;G&nbsp;G&nbsp;G&nbsp;G<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;r&nbsp;r&nbsp;r&nbsp;r<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;o&nbsp;o&nbsp;o&nbsp;o<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;u&nbsp;u&nbsp;u&nbsp;u<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;p&nbsp;p&nbsp;p&nbsp;p<br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;1&nbsp;2&nbsp;3&nbsp;4<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
Bug1|&nbsp;|&nbsp;|&nbsp;|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
Bug2|&nbsp;|X|&nbsp;|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
Bug3|&nbsp;|&nbsp;|X|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
Bug4|&nbsp;|&nbsp;|&nbsp;|X|<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
Bug5|X|X|&nbsp;|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
Bug6|X|&nbsp;|X|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
Bug7|X|X|X|&nbsp;|<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
Bug8|X|X|X|X|<br>
&nbsp;&nbsp;&nbsp;&nbsp;+-+-+-+-+<br>
<br>
Who&nbsp;can&nbsp;see&nbsp;each&nbsp;bug?<br>
<br>
Bug1&nbsp;has&nbsp;no&nbsp;group&nbsp;restrictions.&nbsp;&nbsp;Therefore,&nbsp;Bug1&nbsp;can&nbsp;be&nbsp;seen&nbsp;by&nbsp;any<br>
user,&nbsp;whatever&nbsp;their&nbsp;group&nbsp;membership.&nbsp;&nbsp;This&nbsp;is&nbsp;going&nbsp;to&nbsp;be&nbsp;the&nbsp;only<br>
bug&nbsp;that&nbsp;User5&nbsp;can&nbsp;see,&nbsp;because&nbsp;User5&nbsp;isn't&nbsp;in&nbsp;any&nbsp;groups.<br>
<br>
Bug2&nbsp;can&nbsp;be&nbsp;seen&nbsp;by&nbsp;anyone&nbsp;in&nbsp;Group2,&nbsp;that&nbsp;is&nbsp;User2&nbsp;and&nbsp;User4.<br>
<br>
Bug3&nbsp;can&nbsp;be&nbsp;seen&nbsp;by&nbsp;anyone&nbsp;in&nbsp;Group3,&nbsp;that&nbsp;is&nbsp;User3&nbsp;and&nbsp;User4.<br>
<br>
Bug4&nbsp;can&nbsp;be&nbsp;seen&nbsp;by&nbsp;anyone&nbsp;in&nbsp;Group4.&nbsp;&nbsp;Nobody&nbsp;is&nbsp;in&nbsp;Group4,&nbsp;so&nbsp;none&nbsp;of<br>
these&nbsp;users&nbsp;can&nbsp;see&nbsp;Bug4.<br>
<br>
Bug5&nbsp;can&nbsp;be&nbsp;seen&nbsp;by&nbsp;anyone&nbsp;who&nbsp;is&nbsp;in&nbsp;_both_&nbsp;Group1&nbsp;and&nbsp;Group2.&nbsp;&nbsp;This<br>
is&nbsp;only&nbsp;User4.&nbsp;&nbsp;User1&nbsp;cannot&nbsp;see&nbsp;it&nbsp;because&nbsp;he&nbsp;is&nbsp;not&nbsp;in&nbsp;Group2,&nbsp;and<br>
User2&nbsp;cannot&nbsp;see&nbsp;it&nbsp;because&nbsp;she&nbsp;is&nbsp;not&nbsp;in&nbsp;Group1.<br>
<br>
Bug6&nbsp;can&nbsp;be&nbsp;seen&nbsp;by&nbsp;anyone&nbsp;who&nbsp;is&nbsp;in&nbsp;both&nbsp;Group1&nbsp;and&nbsp;Group3.&nbsp;&nbsp;This<br>
would&nbsp;include&nbsp;User3&nbsp;and&nbsp;User4.&nbsp;&nbsp;Similar&nbsp;to&nbsp;Bug5,&nbsp;User1&nbsp;cannot&nbsp;see&nbsp;Bug6<br>
because&nbsp;he&nbsp;is&nbsp;not&nbsp;in&nbsp;Group3.<br>
<br>
Bug7&nbsp;can&nbsp;be&nbsp;seen&nbsp;by&nbsp;anyone&nbsp;who&nbsp;is&nbsp;in&nbsp;Group1,&nbsp;Group2,&nbsp;and&nbsp;Group3.&nbsp;&nbsp;This<br>
is&nbsp;only&nbsp;User4.&nbsp;&nbsp;All&nbsp;of&nbsp;the&nbsp;others&nbsp;are&nbsp;missing&nbsp;at&nbsp;least&nbsp;one&nbsp;of&nbsp;those<br>
group&nbsp;priveleges,&nbsp;and&nbsp;thus&nbsp;cannot&nbsp;see&nbsp;the&nbsp;bug.<br>
<br>
Bug8&nbsp;can&nbsp;be&nbsp;seen&nbsp;by&nbsp;anyone&nbsp;who&nbsp;is&nbsp;in&nbsp;Group1,&nbsp;Group2,&nbsp;Group3,&nbsp;and<br>
Group4.&nbsp;&nbsp;There&nbsp;is&nbsp;nobody&nbsp;in&nbsp;all&nbsp;four&nbsp;of&nbsp;these&nbsp;groups,&nbsp;so&nbsp;nobody&nbsp;can<br>
see&nbsp;Bug8.&nbsp;&nbsp;It&nbsp;doesn't&nbsp;matter&nbsp;that&nbsp;User4&nbsp;is&nbsp;in&nbsp;Group1,&nbsp;Group2,&nbsp;and<br>
Group3,&nbsp;since&nbsp;he&nbsp;isn't&nbsp;in&nbsp;Group4.<br>
&nbsp;&nbsp;</P
></DIV
>
</P
></DIV
></DIV
><DIV
......
docs/html/quicksearch.html
View file @ 58593ba9
......@@ -16,8 +16,8 @@ REL="PREVIOUS"
TITLE="Command-line Bugzilla Queries"
HREF="cmdline.html"><LINK
REL="NEXT"
TITLE="GNU Free Documentation License"
HREF="gfdl.html"></HEAD
TITLE="Hacking Bugzilla"
HREF="bzhacking.html"></HEAD
><BODY
CLASS="SECTION"
BGCOLOR="#FFFFFF"
......@@ -57,7 +57,7 @@ WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="gfdl.html"
HREF="bzhacking.html"
>Next</A
></TD
></TR
......@@ -160,7 +160,7 @@ WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="gfdl.html"
HREF="bzhacking.html"
>Next</A
></TD
></TR
......@@ -182,7 +182,7 @@ HREF="patches.html"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>GNU Free Documentation License</TD
>Hacking Bugzilla</TD
></TR
></TABLE
></DIV
......
docs/html/setperl.html
View file @ 58593ba9
......@@ -216,7 +216,7 @@ CLASS="COMMAND"
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN2360"
NAME="AEN2439"
></A
><P
><B
......
docs/html/stepbystep.html
View file @ 58593ba9
......@@ -78,7 +78,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN486"
NAME="AEN509"
>3.2.1. Introduction</A
></H2
><P
......@@ -109,7 +109,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN492"
NAME="AEN515"
>3.2.2. Installing the Prerequisites</A
></H2
><DIV
......@@ -613,7 +613,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN579"
NAME="AEN602"
>3.2.5. DBI Perl Module</A
></H2
><P
......@@ -642,7 +642,7 @@ HREF="downloadlinks.html"
<DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN586"
NAME="AEN609"
></A
><P
></P
......@@ -696,7 +696,7 @@ VALIGN="TOP"
<DIV
CLASS="INFORMALEXAMPLE"
><A
NAME="AEN593"
NAME="AEN616"
></A
><P
></P
......@@ -789,7 +789,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN617"
NAME="AEN640"
>3.2.6. Data::Dumper Perl Module</A
></H2
><P
......@@ -814,7 +814,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN622"
NAME="AEN645"
>3.2.7. MySQL related Perl Module Collection</A
></H2
><P
......@@ -860,7 +860,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN631"
NAME="AEN654"
>3.2.8. TimeDate Perl Module Collection</A
></H2
><P
......@@ -882,7 +882,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN635"
NAME="AEN658"
>3.2.9. GD Perl Module (1.8.3)</A
></H2
><P
......@@ -948,7 +948,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN644"
NAME="AEN667"
>3.2.10. Chart::Base Perl Module (0.99c)</A
></H2
><P
......@@ -969,7 +969,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN648"
NAME="AEN671"
>3.2.11. DB_File Perl Module</A
></H2
><P
......@@ -985,7 +985,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN651"
NAME="AEN674"
>3.2.12. HTTP Server</A
></H2
><P
......@@ -1156,7 +1156,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN669"
NAME="AEN692"
>3.2.13. Installing the Bugzilla Files</A
></H2
><P
......@@ -1247,7 +1247,7 @@ HREF="patches.html"
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN685"
NAME="AEN708"
></A
><P
><B
......@@ -1290,6 +1290,29 @@ bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl
></TABLE
>
</P
><P
> Alternately, you can simply run this perl one-liner to
change your path to perl in all the files in your Bugzilla
installation:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><FONT
COLOR="#000000"
><PRE
CLASS="PROGRAMLISTING"
>perl -pi -e 's@#!/usr/bonsaitools/bin/perl@/usr/bin/perl@' *cgi *pl Bug.pm
</PRE
></FONT
></TD
></TR
></TABLE
>
Change the second path to perl to match your installation.
</P
></DIV
>
<DIV
......@@ -1335,7 +1358,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN696"
NAME="AEN721"
>3.2.14. Setting Up the MySQL Database</A
></H2
><P
......@@ -1573,7 +1596,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN743"
NAME="AEN768"
>3.2.15. Tweaking <TT
CLASS="FILENAME"
>localconfig</TT
......@@ -1699,7 +1722,7 @@ CLASS="QUOTE"
<DIV
CLASS="EXAMPLE"
><A
NAME="AEN774"
NAME="AEN799"
></A
><P
><B
......@@ -1779,7 +1802,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN781"
NAME="AEN806"
>3.2.16. Setting Up Maintainers Manually (Optional)</A
></H2
><P
......@@ -1829,7 +1852,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN792"
NAME="AEN817"
>3.2.17. The Whining Cron (Optional)</A
></H2
><P
......@@ -1915,7 +1938,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN802"
NAME="AEN827"
>3.2.18. Bug Graphs (Optional)</A
></H2
><P
......@@ -1972,7 +1995,7 @@ CLASS="SECTION"
><H2
CLASS="SECTION"
><A
NAME="AEN814"
NAME="AEN839"
>3.2.19. Securing MySQL</A
></H2
><P
......
docs/html/variant_sourceforge.html
View file @ 58593ba9
......@@ -16,8 +16,8 @@ REL="PREVIOUS"
TITLE="Perforce SCM"
HREF="variant_perforce.html"><LINK
REL="NEXT"
TITLE="Useful Patches and Utilities for Bugzilla"
HREF="patches.html"></HEAD
TITLE="The Bugzilla FAQ"
HREF="faq.html"></HEAD
><BODY
CLASS="SECTION"
BGCOLOR="#FFFFFF"
......@@ -57,7 +57,7 @@ WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="patches.html"
HREF="faq.html"
>Next</A
></TD
></TR
......@@ -117,7 +117,7 @@ WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="patches.html"
HREF="faq.html"
>Next</A
></TD
></TR
......@@ -139,7 +139,7 @@ HREF="variants.html"
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Useful Patches and Utilities for Bugzilla</TD
>The Bugzilla FAQ</TD
></TR
></TABLE
></DIV
......
docs/html/variants.html
View file @ 58593ba9
......@@ -10,8 +10,8 @@ REL="HOME"
TITLE="The Bugzilla Guide"
HREF="index.html"><LINK
REL="PREVIOUS"
TITLE="MySQL Permissions & Grant Tables"
HREF="granttables.html"><LINK
TITLE="The Future of Bugzilla"
HREF="future.html"><LINK
REL="NEXT"
TITLE="Red Hat Bugzilla"
HREF="rhbugzilla.html"></HEAD
......@@ -41,7 +41,7 @@ WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="granttables.html"
HREF="future.html"
>Prev</A
></TD
><TD
......@@ -133,7 +133,7 @@ WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="granttables.html"
HREF="future.html"
>Prev</A
></TD
><TD
......@@ -158,7 +158,7 @@ HREF="rhbugzilla.html"
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>MySQL Permissions &#38; Grant Tables</TD
>The Future of Bugzilla</TD
><TD
WIDTH="34%"
ALIGN="center"
......
docs/sgml/Bugzilla-Guide.sgml
View file @ 58593ba9
......@@ -26,7 +26,7 @@
<!ENTITY bzg-ver "2.14">
<!ENTITY bzg-cvs-ver "2.15.0">
<!ENTITY bzg-auth "Matthew P. Barnson">
<!ENTITY bzg-auth-email "<email>barnboy@NOSPAM.trilobyte.net</email>">
<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY perl-ver "5.6.1">
......@@ -126,14 +126,14 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<othername>P.</othername>
<surname>Barnson</surname>
<affiliation>
<address><email>barnboy@NOSPAM.trilobyte.net</email></address>
<address><email>barnboy@trilobyte.net</email></address>
</affiliation>
</author>
<collab>
<collabname>Zach Lipton</collabname>
<affiliation>
<address><email>zach@NOSPAM.zachlipton.com</email></address>
<address><email>zach AT zachlipton DOT com</email></address>
</affiliation>
</collab>
......@@ -196,6 +196,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- The Future of Bugzilla -->
&future;
<!-- Major Bugzilla Variants -->
&variants;
<!-- Appendix: The Frequently Asked Questions -->
&faq;
......@@ -205,9 +208,6 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- Appendix: The Database Schema -->
&database;
<!-- Appendix: Major Bugzilla Variants -->
&variants;
<!-- Appendix: Custom Patches -->
&patches;
......
docs/sgml/about.sgml
View file @ 58593ba9
......@@ -70,8 +70,7 @@
<para>
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
please contact &bzg-auth;. Remove "NOSPAM" from email address
to send.
please contact &bzg-auth;.
</para>
</section>
......@@ -172,8 +171,8 @@
</para>
<para>
<ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
for initially converting Bugzilla from BugSplat! and writing the
README upon which this documentation is largely based.
for initially writing Bugzilla and creating the
README upon which the UNIX installation documentation is largely based.
</para>
<para>
<ulink url="mailto://tara@tequilarista.org">Tara
......@@ -204,7 +203,8 @@
documentation (in no particular order):
</para>
<para>
Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum
Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron
Teitelbaum, Jacob Steenhagen, Joe Robins
</para>
</section>
<section id="feedback">
......
docs/sgml/administration.sgml
View file @ 58593ba9
......@@ -1192,6 +1192,103 @@
</para>
</listitem>
</orderedlist>
<para>
You may find this example illustrative for how bug groups work.
<example>
<title>Bugzilla Groups</title>
<literallayout>
Bugzilla Groups example
-----------------------
For this example, let us suppose we have four groups, call them
Group1, Group2, Group3, and Group4.
We have 5 users, User1, User2, User3, User4, User5.
We have 8 bugs, Bug1, ..., Bug8.
Group membership is defined by this chart:
(X denotes that user is in that group.)
(I apologize for the nasty formatting of this table. Try viewing
it in a text-based browser or something for now. -MPB)
G G G G
r r r r
o o o o
u u u u
p p p p
1 2 3 4
+-+-+-+-+
User1|X| | | |
+-+-+-+-+
User2| |X| | |
+-+-+-+-+
User3|X| |X| |
+-+-+-+-+
User4|X|X|X| |
+-+-+-+-+
User5| | | | |
+-+-+-+-+
Bug restrictions are defined by this chart:
(X denotes that bug is restricted to that group.)
G G G G
r r r r
o o o o
u u u u
p p p p
1 2 3 4
+-+-+-+-+
Bug1| | | | |
+-+-+-+-+
Bug2| |X| | |
+-+-+-+-+
Bug3| | |X| |
+-+-+-+-+
Bug4| | | |X|
+-+-+-+-+
Bug5|X|X| | |
+-+-+-+-+
Bug6|X| |X| |
+-+-+-+-+
Bug7|X|X|X| |
+-+-+-+-+
Bug8|X|X|X|X|
+-+-+-+-+
Who can see each bug?
Bug1 has no group restrictions. Therefore, Bug1 can be seen by any
user, whatever their group membership. This is going to be the only
bug that User5 can see, because User5 isn't in any groups.
Bug2 can be seen by anyone in Group2, that is User2 and User4.
Bug3 can be seen by anyone in Group3, that is User3 and User4.
Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of
these users can see Bug4.
Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This
is only User4. User1 cannot see it because he is not in Group2, and
User2 cannot see it because she is not in Group1.
Bug6 can be seen by anyone who is in both Group1 and Group3. This
would include User3 and User4. Similar to Bug5, User1 cannot see Bug6
because he is not in Group3.
Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This
is only User4. All of the others are missing at least one of those
group priveleges, and thus cannot see the bug.
Bug8 can be seen by anyone who is in Group1, Group2, Group3, and
Group4. There is nobody in all four of these groups, so nobody can
see Bug8. It doesn't matter that User4 is in Group1, Group2, and
Group3, since he isn't in Group4.
</literallayout>
</example>
</para>
</section>
</section>
......
docs/sgml/database.sgml
View file @ 58593ba9
......@@ -13,7 +13,7 @@
<para>
<mediaobject>
<imageobject>
<imagedata fileref="dbschema.jpg" format="jpg">
<imagedata fileref="../images/dbschema.jpg" format="jpg">
</imageobject>
<textobject>
......
docs/sgml/faq.sgml
View file @ 58593ba9
......@@ -620,6 +620,12 @@
progression states, also require adjusting the program logic to
compensate for the change.
</para>
<para>
There is no GUI for adding fields to Bugzilla at this
time. You can follow development of this feature at
<ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=91037">http://bugzilla.mozilla.org/show_bug.cgi?id=91037</ulink>
</para>
</answer>
</qandaentry>
......@@ -633,42 +639,62 @@
</para>
</question>
<answer>
<para>
This was a late-breaking question for the Guide, so I just have to
quote the relevant newsgroup thread on it.
</para>
<literallayout>
> AFAIK, most sites (even if they have SSI enabled) won't have #exec cmd
> enabled. Perhaps what would be better is a #include virtual and a
> footer.cgi the basically has the "require 'CGI.pl' and PutFooter command.
>
> Please note that under most configurations, this also requires naming
> the file from index.html to index.shtml (and making sure that it will
> still be reconized as an index). Personally, I think this is better on
> a per-installation basis (perhaps add something to the FAQ that says how
> to do this).
Good point. Yeah, easy enough to do, that it shouldn't be a big deal for
someone to take it on if they want it. FAQ is a good place for it.
> Dave Miller wrote:
>
>> I did a little experimenting with getting the command menu and footer on
>> the end of the index page while leaving it as an HTML file...
>>
>> I was successful. :)
>>
>> I added this line:
>>
>> <!--#exec cmd="/usr/bin/perl -e &quot;require 'CGI.pl';
>>PutFooter();&quot;" -->
>>
>> Just before the &lt;/BODY&gt; &lt;/HTML&gt; at the end of the file. And it worked.
>>
>> Thought I'd toss that out there. Should I check this in? For those that
>> have SSI disabled, it'll act like a comment, so I wouldn't think it would
>> break anything.
</literallayout>
<para>
It's possible to get the footer on the static index page using
Server Side Includes (SSI). The trick to doing this is making
sure that your web server is set up to allow SSI and specifically,
the #exec directive. You should also rename <filename>index.html</filename>
to <filename>index.shtml</filename>.
</para>
<para>
After you've done all that, you can add the following line to
<filename>index.shtml</filename>:
<programlisting>
<![CDATA[
<!--#exec cmd="/usr/bin/perl -e &quot;require 'CGI.pl'; PutFooter();&quot;" -->
]]>
</programlisting>
</para>
<para><note>
<para>
This line will be replaced with the actual HTML for the footer
when the page is requested, so you should put this line where you
want the footer to appear.
</para>
</note></para>
<para>
Because this method depends on being able to use a #exec directive,
and most ISP's will not allow that, there is an alternative method.
You could have a small script (such as <filename>api.cgi</filename>)
that basically looks like:
<programlisting>
<![CDATA[
#!/usr/bonsaitools/bin/perl -w
require 'globals.pl';
if ($::FORM{sub} eq 'PutFooter') {
PutFooter();
} else {
die 'api.cgi was incorrectly called';
}
]]>
</programlisting>
and then put this line in <filename>index.shtml</filename>.
<programlisting>
<![CDATA[
<!--#include virtual="api.cgi?sub=PutFooter"-->
]]>
</programlisting>
</para>
<para> <note>
<para>
This still requires being able to use Server Side Includes, if
this simply will not work for you, see <ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=80183">bug 80183</ulink>
for a third option.
</para>
</note></para>
</answer>
</qandaentry>
<qandaentry>
......@@ -807,21 +833,6 @@ someone to take it on if they want it. FAQ is a good place for it.
<qandaentry>
<question>
<para>
Does Bugzilla allow fields to be added, changed or deleted? If I want to
customize the bug submission form to meet our needs, can I do that using our
terminology?
</para>
</question>
<answer>
<para>
Yes.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Has anyone converted Bugzilla to another language to be used in other
countries? Is it localizable?
</para>
......@@ -1221,20 +1232,11 @@ someone to take it on if they want it. FAQ is a good place for it.
<para>
If you are using an alternate Mail Transport Agent (MTA other than
sendmail), make sure the options given in the "processmail" script for all
instances of "sendmail" are correct for your MTA. If you are using Sendmail,
you may wish to delete the "-ODeliveryMode=deferred" option in the
"processmail" script for every invocation of "sendmail". (Be sure and leave
the "-t" option, though!)
</para>
<para>
A better alternative is to change the "-O" option to
"-ODeliveryMode=background". This prevents Sendmail from hanging your
Bugzilla Perl processes if the domain to which it must send mail
is unavailable.
instances of "sendmail" are correct for your MTA.
</para>
<para>
This is now a configurable parameter called "sendmailnow", available
from editparams.cgi.
If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi.
If you are using Postfix, you will also need to enable <quote>sendmailnow</quote>.
</para>
</answer>
</qandaentry>
......@@ -1315,12 +1317,21 @@ someone to take it on if they want it. FAQ is a good place for it.
</question>
<answer>
<para>
Run the "sanity check" utility (./sanitycheck.cgi in the bugzilla_home
directory) to see! If it all comes back, you're OK. If it doesn't come back
OK (i.e. any red letters), there are certain things Bugzilla can recover
from and certain things it can't. If it can't auto-recover, I hope you're
familiar with mysqladmin commands or have installed another way to manage
your database...
Run the <quote>sanity check</quote> utility
(<filename>./sanitycheck.cgi</filename> in the
Bugzilla_home directory) from your web browser to see! If
it finishes without errors, you're
<emphasis>probably</emphasis> OK. If it doesn't come back
OK (i.e. any red letters), there are certain things
Bugzilla can recover from and certain things it can't. If
it can't auto-recover, I hope you're familiar with
mysqladmin commands or have installed another way to
manage your database. Sanity Check, although it is a good
basic check on your database integrity, by no means is a
substitute for competent database administration and
avoiding deletion of data. It is not exhaustive, and was
created to do a basic check for the most common problems
in Bugzilla databases.
</para>
</answer>
</qandaentry>
......@@ -1428,10 +1439,12 @@ someone to take it on if they want it. FAQ is a good place for it.
</question>
<answer>
<para>
Delete everything from $BUZILLA_HOME/shadow. Bugzilla creates shadow
files there, with each filename corresponding to a
bug number. Also be sure to run syncshadowdb to make sure, if you are using
a shadow database, that the shadow database is current.
This should only happen with Bugzilla &bz-ver; if you are
using the <quote>shadow database</quote> feature, and your
shadow database is out of sync. Try running
<filename>syncshadowdb</filename>
<option>-syncall</option> to make sure your shadow
database is in synch with your primary database.
</para>
</answer>
</qandaentry>
......@@ -1752,14 +1765,14 @@ A: Sure! Here ya go!
</question>
<answer>
<para>
Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;product=Webtools&amp;component=Bugzilla">
Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;product=Bugzilla">
this link</ulink> to view current bugs or requests for
enhancement for Bugzilla.
</para>
<para>
You can view bugs marked for 2.14 release
<ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Webtools&amp;component=Bugzilla&amp;target_milestone=Bugzilla+2.14">here</ulink>.
This list includes bugs for the 2.14 release that have already
You can view bugs marked for 2.16 release
<ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&amp;target_milestone=Bugzilla+2.16">here</ulink>.
This list includes bugs for the 2.16 release that have already
been fixed and checked into CVS. Please consult the
<ulink url="http://www.mozilla.org/projects/bugzilla/">
Bugzilla Project Page</ulink> for details on how to
......@@ -1800,8 +1813,9 @@ A: Sure! Here ya go!
<orderedlist>
<listitem>
<para>
Enter a bug into bugzilla.mozilla.org for the "Webtools" product,
"Bugzilla" component.
Enter a bug into bugzilla.mozilla.org for the <quote><ulink
url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">Bugzilla</ulink></quote>
product.
</para>
</listitem>
<listitem>
......
docs/sgml/installation.sgml
View file @ 58593ba9
......@@ -616,6 +616,15 @@ bash# mkdir /usr/bonsaitools/bin
bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl
</programlisting>
</para>
<para>
Alternately, you can simply run this perl one-liner to
change your path to perl in all the files in your Bugzilla
installation:
<programlisting>
perl -pi -e 's@#!/usr/bonsaitools/bin/perl@/usr/bin/perl@' *cgi *pl Bug.pm
</programlisting>
Change the second path to perl to match your installation.
</para>
</example>
<tip>
<para>
......@@ -1241,7 +1250,7 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
</section>
<section>
<section id="unixhistory">
<title>UNIX Installation Instructions History</title>
<para>
This document was originally adapted from the Bonsai
......@@ -1252,9 +1261,8 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
The February 25, 1999 re-write of this page was done by Ry4an
Brase &lt;ry4an@ry4an.org&gt;, with some edits by Terry
Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But
don't send bug reports to them; report them using bugzilla, at
http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools,
component Bugzilla).
don't send bug reports to them; report them using bugzilla, at <ulink
url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</ulink> ).
</para>
<para>
This document was heavily modified again Wednesday, March 07
......@@ -1696,16 +1704,46 @@ exit;
<step>
<para>
Modify the invocation of all system() calls in all perl scripts in your Bugzilla directory. For instance, change this line in processmail:
<programlisting>
system ("./processmail.pl",@ARGLIST);
</programlisting>
to
<programlisting>
Modify the invocation of all system() calls in all perl
scripts in your Bugzilla directory. For instance, change
this line in processmail:
<programlisting>
system ("./processmail.pl",@ARGLIST);
</programlisting> to
<programlisting>
system ("perl processmail.pl",@ARGLIST);
</programlisting>
</para>
</step>
<step>
<para>
Add <function>binmode()</function> calls so attachments
will work (<ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>).
</para>
<para>
Because Microsoft Windows based systems handle binary
files different than Unix based systems, you need to add
the following lines to
<filename>createattachment.cgi</filename> and
<filename>showattachment.cgi</filename> before the
<function>require 'CGI.pl';</function> line.
</para>
<para>
<programlisting>
<![CDATA[
binmode(STDIN);
binmode(STDOUT);
]]>
</programlisting>
</para>
<note>
<para>
According to <ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>, the perl documentation says that you should always use <function>binmode()</function> when dealing with binary files, but never when dealing with text files. That seems to suggest that rather than aribtrarily putting <function>binmode()</function> at the begining of the attachment files, there should be logic to determine if <function>binmode()</function> is needed or not.
</para>
</note>
</step>
</procedure>
<tip>
......@@ -1714,6 +1752,8 @@ system ("perl processmail.pl",@ARGLIST);
relationships to Properties -> Home directory (tab) ->
Application Settings (section) -> Configuration (button),
such as:
</para>
<para>
<programlisting>
.cgi to: &lt;perl install directory&gt;\perl.exe %s %s
.pl to: &lt;perl install directory&gt;\perl.exe %s %s
......@@ -1742,7 +1782,9 @@ GET,HEAD,POST
registry at the following location:
</para>
<para>
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
<programlisting>
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
</programlisting>
</para>
<para>
The keys should be called ".pl" and ".cgi", and both
......@@ -1761,26 +1803,102 @@ GET,HEAD,POST
If attempting to run Bugzilla 2.12 or older, you will need
to remove encrypt() calls from the Perl source. This is
<emphasis>not necessary</emphasis> for Bugzilla 2.13 and
later.
later, which includes the current release, Bugzilla
&bz-ver;.
<example>
<title>Removing encrypt() for Windows NT Bugzilla version
2.12 or earlier</title>
<para>
Replace this:
<programlisting>
SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")");
my $enteredcryptpwd = FetchOneColumn();
</programlisting>
with this:
<programlisting>
my $enteredcryptpwd = $enteredpwd
</programlisting>
Replace this:
<programlisting>
SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")");
my $enteredcryptpwd = FetchOneColumn();
</programlisting>
with this:
<programlisting>
my $enteredcryptpwd = $enteredpwd
</programlisting>
in cgi.pl.
</para>
</example>
</para>
</tip>
</section>
<section id="bzldap">
<title>Bugzilla LDAP Integration</title>
<para>
What follows is some late-breaking information on using the
LDAP authentication options with Bugzilla. The author has not
tested these (nor even formatted this section!) so please
contribute feedback to the newsgroup.
</para>
<literallayout>
Mozilla::LDAP module
The Mozilla::LDAP module allows you to use LDAP for authentication to
the Bugzilla system. This module is not required if you are not using
LDAP.
Mozilla::LDAP (aka PerLDAP) is available for download from
http://www.mozilla.org/directory.
NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.
Follow the link for "Directory SDK for C" on that same page to
download the SDK first. After you have installed this SDK, then
install the PerLDAP module.
----------------------------------------------------------------------
Post-Installation Checklist
----------------------------------------------------------------------
Set useLDAP to "On" **only** if you will be using an LDAP directory
for authentication. Be very careful when setting up this parameter;
if you set LDAP authentication, but do not have a valid LDAP directory
set up, you will not be able to log back in to Bugzilla once you log
out. (If this happens, you can get back in by manually editing the
data/params file, and setting useLDAP back to 0.)
If using LDAP, you must set the three additional parameters:
Set LDAPserver to the name (and optionally port) of your LDAP server.
If no port is specified, it defaults to the default port of 389. (e.g
"ldap.mycompany.com" or "ldap.mycompany.com:1234")
Set LDAPBaseDN to the base DN for searching for users in your LDAP
directory. (e.g. "ou=People,o=MyCompany") uids must be unique under
the DN specified here.
Set LDAPmailattribute to the name of the attribute in your LDAP
directory which contains the primary email address. On most directory
servers available, this is "mail", but you may need to change this.
----------------------------------------------------------------------
(Not sure where this bit should go, but it's important that it be in
there somewhere...)
----------------------------------------------------------------------
Using LDAP authentication for Bugzilla:
The existing authentication scheme for Bugzilla uses email addresses
as the primary user ID, and a password to authenticate that user. All
places within Bugzilla where you need to deal with user ID (e.g
assigning a bug) use the email address.
The LDAP authentication builds on top of this scheme, rather than
replacing it. The initial log in is done with a username and password
for the LDAP directory. This then fetches the email address from LDAP
and authenticates seamlessly in the standard Bugzilla authentication
scheme using this email address. If an account for this address
already exists in your Bugzilla system, it will log in to that
account. If no account for that email address exists, one is created
at the time of login. (In this case, Bugzilla will attempt to use the
"displayName" or "cn" attribute to determine the user's full name.)
After authentication, all other user-related tasks are still handled
by email address, not LDAP username. You still assign bugs by email
address, query on users by email address, etc.
----------------------------------------------------------------------
</literallayout>
</section>
</section>
</chapter>
......
docs/sgml/integration.sgml
View file @ 58593ba9
......@@ -35,6 +35,14 @@
an @resolution field, you can even change the Bugzilla bug
state.
</para>
<para>
There is also a project, based upon somewhat dated Bugzilla
code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at:
<ulink url="http://homepages.kcbbs.gen.nz/~tonyg/">
http://homepages.kcbbs.gen.nz/~tonyg/</ulink>, under the
<quote>cvszilla</quote> link.
</para>
</section>
<section id="scm" xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
......
docs/sgml/patches.sgml
View file @ 58593ba9
......@@ -247,6 +247,104 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
</para>
</section>
<section id="bzhacking">
<title>Hacking Bugzilla</title>
<para>
What follows are some general guidelines for changing Bugzilla, and adhering to good coding practice while doing so. We've had some checkins in the past which ruined Bugzilla installations because of disregard for these conventions. Sorry for the lack of formatting; I got this info into the Guide on the day of 2.14 release and haven't formatted it yet.
</para>
<literallayout>
The following is a guide for reviewers when checking code into Bugzilla's
CVS repostory at mozilla.org. If you wish to submit patches to Bugzilla,
you should follow the rules and style conventions below. Any code that
does not adhere to these basic rules will not be added to Bugzilla's
codebase.
1. Usage of variables in Regular Expressions
It is very important that you don't use a variable in a regular
expression unless that variable is supposed to contain an expression.
This especially applies when using grep. You should use:
grep ($_ eq $value, @array);
- NOT -
grep (/$value/, @array);
If you need to use a non-expression variable inside of an expression, be
sure to quote it properly (using \Q..\E).
Coding Style for Bugzilla
-------------------------
While it's true that not all of the code currently in Bugzilla adheres to
this styleguide, it is something that is being worked toward. Therefore,
we ask that all new code (submitted patches and new files) follow this guide
as closely as possible (if you're only changing 1 or 2 lines, you don't have
to reformat the entire file :).
1. Whitespace
Bugzilla's prefered indentation is 4 spaces (no tabs, please).
2. Curly braces.
The opening brace of a block should be on the same line as the statement
that is causing the block and the closing brace should be at the same
indentation level as that statement, for example:
if ($var) {
print "The variable is true";
} else {
print "Try again";
}
- NOT -
if ($var)
{
print "The variable is true";
}
else
{
print "Try again";
}
3. File Names
File names for bugzilla code and support documention should be legal across
multiple platforms. \ / : * ? " < > and | are all illegal characters for
filenames on various platforms. Also, file names should not have spaces in
them as they can cause confusion in CVS and other mozilla.org utilities.
4. Variable Names
If a variable is scoped globally ($::variable) its name should be descriptive
of what it contains. Local variables can be named a bit looser, provided the
context makes their content obvious. For example, $ret could be used as a
staging variable for a routine's return value as the line |return $ret;| will
make it blatently obvious what the variable holds and most likely be shown
on the same screen as |my $ret = "";|.
5. Cross Database Compatability
Bugzilla was originally written to work with MySQL and therefore took advantage
of some of its features that aren't contained in other RDBMS software. These
should be avoided in all new code. Examples of these features are enums and
encrypt().
6. Cross Platform Compatability
While Bugzilla was written to be used on Unix based systems (and Unix/Linux is
still the only officially supported platform) there are many who desire/need to
run Bugzilla on Microsoft Windows boxes. Whenever possible, we should strive
not to make the lives of these people any more complicated and avoid doing things
that break Bugzilla's ability to run on multiple operating systems.
</literallayout>
</section>
</appendix>
......
docs/sgml/using.sgml
View file @ 58593ba9
......@@ -399,13 +399,13 @@ system against which all others are measured.
our Bugzilla database. Please notice the box is a
<emphasis>scrollbox</emphasis>. Using the down arrow on
the scrollbox, scroll down until you can see an entry
called "Webtools". Select this entry.
called "Bugzilla". Select this entry.
</para>
</listitem>
<listitem>
<para>
Did you notice that some of the boxes to the right changed
when you selected "Webtools"? Every Program (or Product)
when you selected "Bugzilla"? Every Program (or Product)
has different Versions, Components, and Target Milestones
associated with it. A "Version" is the number of a
software program.
......@@ -452,36 +452,67 @@ system against which all others are measured.
Normally, a Component has a single Owner, who is responsible
for overseeing efforts to improve that Component.
<example>
<title>Mozilla Webtools Components</title>
<title>Mozilla's Bugzilla Components</title>
<informalexample>
<para>
Mozilla's "Webtools" Product is composed of several pieces (Components):
Mozilla's "Bugzilla" Product is composed of several pieces (Components):
<simplelist>
<member><emphasis>Bonsai</emphasis>,
a tool to show recent changes to Mozilla</member>
<member><emphasis>Bugzilla</emphasis>,
a defect-tracking tool</member>
<member><emphasis>Build</emphasis>,
a tool to automatically compile source code
into machine-readable form</member>
<member><emphasis>Despot</emphasis>,
a program that controls access to the other Webtools</member>
<member><emphasis>LXR</emphasis>,
a utility that automatically marks up text files
to make them more readable</member>
<member><emphasis>MozBot</emphasis>,
a "robot" that announces changes to Mozilla in Chat</member>
<member><emphasis>TestManager</emphasis>,
a tool to help find bugs in Mozilla</member>
<member><emphasis>Tinderbox</emphasis>,
which displays reports from Build</member>
<member><emphasis>Administration</emphasis>,
Administration of a bugzilla installation, including
<filename>editcomponents.cgi</filename>,
<filename>editgroups.cgi</filename>,
<filename>editkeywords.cgi</filename>,
<filename>editparams.cgi</filename>,
<filename>editproducts.cgi</filename>,
<filename>editusers.cgi</filename>,
<filename>editversions.cgi,</filename> and
<filename>sanitycheck.cgi</filename>.
</member>
<member><emphasis>Bugzilla-General</emphasis>,
Anything that doesn't fit in the other components, or spans
multiple components.
</member>
<member><emphasis>Creating/Changing Bugs</emphasis>,
Creating, changing, and viewing bugs.
<filename>enter_bug.cgi</filename>,
<filename>post_bug.cgi</filename>,
<filename>show_bug.cgi</filename> and
<filename>process_bug.cgi</filename>.
</member>
<member><emphasis>Documentation</emphasis>,
The bugzilla documentation, including anything in the
<filename>docs/</filename> directory and The Bugzilla Guide
(This document :)
</member>
<member><emphasis>Email</emphasis>,
Anything to do with email sent by Bugzilla.
<filename>processmail</filename>
</member>
<member><emphasis>Installation</emphasis>,
The installation process of Bugzilla. This includes
<filename>checksetup.pl</filename> and whatever else it evolves into.
</member>
<member><emphasis>Query/Buglist</emphasis>,
Anything to do with searching for bugs and viewing the buglists.
<filename>query.cgi</filename> and
<filename>buglist.cgi</filename>
</member>
<member><emphasis>Reporting/Charting</emphasis>,
Getting reports from Bugzilla.
<filename>reports.cgi</filename> and
<filename>duplicates.cgi</filename>
</member>
<member><emphasis>User Accounts</emphasis>,
Anything about managing a user account from the user's perspective.
<filename>userprefs.cgi</filename>, saved queries, creating accounts,
changing passwords, logging in, etc.
</member>
<member><emphasis>User Interface</emphasis>,
General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates, etc.
</member>
</simplelist>
</para>
<para>
A different person is responsible for each of these Components.
Tara Hernandez keeps
the "Bugzilla" component up-to-date.
</para>
</informalexample>
</example>
</para>
......
docs/xml/Bugzilla-Guide.xml
View file @ 58593ba9
......@@ -26,7 +26,7 @@
<!ENTITY bzg-ver "2.14">
<!ENTITY bzg-cvs-ver "2.15.0">
<!ENTITY bzg-auth "Matthew P. Barnson">
<!ENTITY bzg-auth-email "<email>barnboy@NOSPAM.trilobyte.net</email>">
<!ENTITY bzg-auth-email "<email>barnboy@trilobyte.net</email>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY perl-ver "5.6.1">
......@@ -126,14 +126,14 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<othername>P.</othername>
<surname>Barnson</surname>
<affiliation>
<address><email>barnboy@NOSPAM.trilobyte.net</email></address>
<address><email>barnboy@trilobyte.net</email></address>
</affiliation>
</author>
<collab>
<collabname>Zach Lipton</collabname>
<affiliation>
<address><email>zach@NOSPAM.zachlipton.com</email></address>
<address><email>zach AT zachlipton DOT com</email></address>
</affiliation>
</collab>
......@@ -196,6 +196,9 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- The Future of Bugzilla -->
&future;
<!-- Major Bugzilla Variants -->
&variants;
<!-- Appendix: The Frequently Asked Questions -->
&faq;
......@@ -205,9 +208,6 @@ try to avoid clutter and feel free to waste space in the code to make it more re
<!-- Appendix: The Database Schema -->
&database;
<!-- Appendix: Major Bugzilla Variants -->
&variants;
<!-- Appendix: Custom Patches -->
&patches;
......
docs/xml/about.xml
View file @ 58593ba9
......@@ -70,8 +70,7 @@
<para>
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
please contact &bzg-auth;. Remove "NOSPAM" from email address
to send.
please contact &bzg-auth;.
</para>
</section>
......@@ -172,8 +171,8 @@
</para>
<para>
<ulink url="mailto://terry@mozilla.org">Terry Weissman</ulink>
for initially converting Bugzilla from BugSplat! and writing the
README upon which this documentation is largely based.
for initially writing Bugzilla and creating the
README upon which the UNIX installation documentation is largely based.
</para>
<para>
<ulink url="mailto://tara@tequilarista.org">Tara
......@@ -204,7 +203,8 @@
documentation (in no particular order):
</para>
<para>
Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron Teitelbaum
Andrew Pearson, Spencer Smith, Eric Hanson, Kevin Brannen, Ron
Teitelbaum, Jacob Steenhagen, Joe Robins
</para>
</section>
<section id="feedback">
......
docs/xml/administration.xml
View file @ 58593ba9
......@@ -1192,6 +1192,103 @@
</para>
</listitem>
</orderedlist>
<para>
You may find this example illustrative for how bug groups work.
<example>
<title>Bugzilla Groups</title>
<literallayout>
Bugzilla Groups example
-----------------------
For this example, let us suppose we have four groups, call them
Group1, Group2, Group3, and Group4.
We have 5 users, User1, User2, User3, User4, User5.
We have 8 bugs, Bug1, ..., Bug8.
Group membership is defined by this chart:
(X denotes that user is in that group.)
(I apologize for the nasty formatting of this table. Try viewing
it in a text-based browser or something for now. -MPB)
G G G G
r r r r
o o o o
u u u u
p p p p
1 2 3 4
+-+-+-+-+
User1|X| | | |
+-+-+-+-+
User2| |X| | |
+-+-+-+-+
User3|X| |X| |
+-+-+-+-+
User4|X|X|X| |
+-+-+-+-+
User5| | | | |
+-+-+-+-+
Bug restrictions are defined by this chart:
(X denotes that bug is restricted to that group.)
G G G G
r r r r
o o o o
u u u u
p p p p
1 2 3 4
+-+-+-+-+
Bug1| | | | |
+-+-+-+-+
Bug2| |X| | |
+-+-+-+-+
Bug3| | |X| |
+-+-+-+-+
Bug4| | | |X|
+-+-+-+-+
Bug5|X|X| | |
+-+-+-+-+
Bug6|X| |X| |
+-+-+-+-+
Bug7|X|X|X| |
+-+-+-+-+
Bug8|X|X|X|X|
+-+-+-+-+
Who can see each bug?
Bug1 has no group restrictions. Therefore, Bug1 can be seen by any
user, whatever their group membership. This is going to be the only
bug that User5 can see, because User5 isn't in any groups.
Bug2 can be seen by anyone in Group2, that is User2 and User4.
Bug3 can be seen by anyone in Group3, that is User3 and User4.
Bug4 can be seen by anyone in Group4. Nobody is in Group4, so none of
these users can see Bug4.
Bug5 can be seen by anyone who is in _both_ Group1 and Group2. This
is only User4. User1 cannot see it because he is not in Group2, and
User2 cannot see it because she is not in Group1.
Bug6 can be seen by anyone who is in both Group1 and Group3. This
would include User3 and User4. Similar to Bug5, User1 cannot see Bug6
because he is not in Group3.
Bug7 can be seen by anyone who is in Group1, Group2, and Group3. This
is only User4. All of the others are missing at least one of those
group priveleges, and thus cannot see the bug.
Bug8 can be seen by anyone who is in Group1, Group2, Group3, and
Group4. There is nobody in all four of these groups, so nobody can
see Bug8. It doesn't matter that User4 is in Group1, Group2, and
Group3, since he isn't in Group4.
</literallayout>
</example>
</para>
</section>
</section>
......
docs/xml/database.xml
View file @ 58593ba9
......@@ -13,7 +13,7 @@
<para>
<mediaobject>
<imageobject>
<imagedata fileref="dbschema.jpg" format="jpg">
<imagedata fileref="../images/dbschema.jpg" format="jpg">
</imageobject>
<textobject>
......
docs/xml/faq.xml
View file @ 58593ba9
......@@ -620,6 +620,12 @@
progression states, also require adjusting the program logic to
compensate for the change.
</para>
<para>
There is no GUI for adding fields to Bugzilla at this
time. You can follow development of this feature at
<ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=91037">http://bugzilla.mozilla.org/show_bug.cgi?id=91037</ulink>
</para>
</answer>
</qandaentry>
......@@ -633,42 +639,62 @@
</para>
</question>
<answer>
<para>
This was a late-breaking question for the Guide, so I just have to
quote the relevant newsgroup thread on it.
</para>
<literallayout>
> AFAIK, most sites (even if they have SSI enabled) won't have #exec cmd
> enabled. Perhaps what would be better is a #include virtual and a
> footer.cgi the basically has the "require 'CGI.pl' and PutFooter command.
>
> Please note that under most configurations, this also requires naming
> the file from index.html to index.shtml (and making sure that it will
> still be reconized as an index). Personally, I think this is better on
> a per-installation basis (perhaps add something to the FAQ that says how
> to do this).
Good point. Yeah, easy enough to do, that it shouldn't be a big deal for
someone to take it on if they want it. FAQ is a good place for it.
> Dave Miller wrote:
>
>> I did a little experimenting with getting the command menu and footer on
>> the end of the index page while leaving it as an HTML file...
>>
>> I was successful. :)
>>
>> I added this line:
>>
>> <!--#exec cmd="/usr/bin/perl -e &quot;require 'CGI.pl';
>>PutFooter();&quot;" -->
>>
>> Just before the &lt;/BODY&gt; &lt;/HTML&gt; at the end of the file. And it worked.
>>
>> Thought I'd toss that out there. Should I check this in? For those that
>> have SSI disabled, it'll act like a comment, so I wouldn't think it would
>> break anything.
</literallayout>
<para>
It's possible to get the footer on the static index page using
Server Side Includes (SSI). The trick to doing this is making
sure that your web server is set up to allow SSI and specifically,
the #exec directive. You should also rename <filename>index.html</filename>
to <filename>index.shtml</filename>.
</para>
<para>
After you've done all that, you can add the following line to
<filename>index.shtml</filename>:
<programlisting>
<![CDATA[
<!--#exec cmd="/usr/bin/perl -e &quot;require 'CGI.pl'; PutFooter();&quot;" -->
]]>
</programlisting>
</para>
<para><note>
<para>
This line will be replaced with the actual HTML for the footer
when the page is requested, so you should put this line where you
want the footer to appear.
</para>
</note></para>
<para>
Because this method depends on being able to use a #exec directive,
and most ISP's will not allow that, there is an alternative method.
You could have a small script (such as <filename>api.cgi</filename>)
that basically looks like:
<programlisting>
<![CDATA[
#!/usr/bonsaitools/bin/perl -w
require 'globals.pl';
if ($::FORM{sub} eq 'PutFooter') {
PutFooter();
} else {
die 'api.cgi was incorrectly called';
}
]]>
</programlisting>
and then put this line in <filename>index.shtml</filename>.
<programlisting>
<![CDATA[
<!--#include virtual="api.cgi?sub=PutFooter"-->
]]>
</programlisting>
</para>
<para> <note>
<para>
This still requires being able to use Server Side Includes, if
this simply will not work for you, see <ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=80183">bug 80183</ulink>
for a third option.
</para>
</note></para>
</answer>
</qandaentry>
<qandaentry>
......@@ -807,21 +833,6 @@ someone to take it on if they want it. FAQ is a good place for it.
<qandaentry>
<question>
<para>
Does Bugzilla allow fields to be added, changed or deleted? If I want to
customize the bug submission form to meet our needs, can I do that using our
terminology?
</para>
</question>
<answer>
<para>
Yes.
</para>
</answer>
</qandaentry>
<qandaentry>
<question>
<para>
Has anyone converted Bugzilla to another language to be used in other
countries? Is it localizable?
</para>
......@@ -1221,20 +1232,11 @@ someone to take it on if they want it. FAQ is a good place for it.
<para>
If you are using an alternate Mail Transport Agent (MTA other than
sendmail), make sure the options given in the "processmail" script for all
instances of "sendmail" are correct for your MTA. If you are using Sendmail,
you may wish to delete the "-ODeliveryMode=deferred" option in the
"processmail" script for every invocation of "sendmail". (Be sure and leave
the "-t" option, though!)
</para>
<para>
A better alternative is to change the "-O" option to
"-ODeliveryMode=background". This prevents Sendmail from hanging your
Bugzilla Perl processes if the domain to which it must send mail
is unavailable.
instances of "sendmail" are correct for your MTA.
</para>
<para>
This is now a configurable parameter called "sendmailnow", available
from editparams.cgi.
If you are using Sendmail, try enabling "sendmailnow" in editparams.cgi.
If you are using Postfix, you will also need to enable <quote>sendmailnow</quote>.
</para>
</answer>
</qandaentry>
......@@ -1315,12 +1317,21 @@ someone to take it on if they want it. FAQ is a good place for it.
</question>
<answer>
<para>
Run the "sanity check" utility (./sanitycheck.cgi in the bugzilla_home
directory) to see! If it all comes back, you're OK. If it doesn't come back
OK (i.e. any red letters), there are certain things Bugzilla can recover
from and certain things it can't. If it can't auto-recover, I hope you're
familiar with mysqladmin commands or have installed another way to manage
your database...
Run the <quote>sanity check</quote> utility
(<filename>./sanitycheck.cgi</filename> in the
Bugzilla_home directory) from your web browser to see! If
it finishes without errors, you're
<emphasis>probably</emphasis> OK. If it doesn't come back
OK (i.e. any red letters), there are certain things
Bugzilla can recover from and certain things it can't. If
it can't auto-recover, I hope you're familiar with
mysqladmin commands or have installed another way to
manage your database. Sanity Check, although it is a good
basic check on your database integrity, by no means is a
substitute for competent database administration and
avoiding deletion of data. It is not exhaustive, and was
created to do a basic check for the most common problems
in Bugzilla databases.
</para>
</answer>
</qandaentry>
......@@ -1428,10 +1439,12 @@ someone to take it on if they want it. FAQ is a good place for it.
</question>
<answer>
<para>
Delete everything from $BUZILLA_HOME/shadow. Bugzilla creates shadow
files there, with each filename corresponding to a
bug number. Also be sure to run syncshadowdb to make sure, if you are using
a shadow database, that the shadow database is current.
This should only happen with Bugzilla &bz-ver; if you are
using the <quote>shadow database</quote> feature, and your
shadow database is out of sync. Try running
<filename>syncshadowdb</filename>
<option>-syncall</option> to make sure your shadow
database is in synch with your primary database.
</para>
</answer>
</qandaentry>
......@@ -1752,14 +1765,14 @@ A: Sure! Here ya go!
</question>
<answer>
<para>
Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;product=Webtools&amp;component=Bugzilla">
Try <ulink url="http://bugzilla.mozilla.org/buglist.cgi?bug_status=NEW&amp;bug_status=ASSIGNED&amp;bug_status=REOPENED&amp;product=Bugzilla">
this link</ulink> to view current bugs or requests for
enhancement for Bugzilla.
</para>
<para>
You can view bugs marked for 2.14 release
<ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Webtools&amp;component=Bugzilla&amp;target_milestone=Bugzilla+2.14">here</ulink>.
This list includes bugs for the 2.14 release that have already
You can view bugs marked for 2.16 release
<ulink url="http://bugzilla.mozilla.org/buglist.cgi?product=Bugzilla&amp;target_milestone=Bugzilla+2.16">here</ulink>.
This list includes bugs for the 2.16 release that have already
been fixed and checked into CVS. Please consult the
<ulink url="http://www.mozilla.org/projects/bugzilla/">
Bugzilla Project Page</ulink> for details on how to
......@@ -1800,8 +1813,9 @@ A: Sure! Here ya go!
<orderedlist>
<listitem>
<para>
Enter a bug into bugzilla.mozilla.org for the "Webtools" product,
"Bugzilla" component.
Enter a bug into bugzilla.mozilla.org for the <quote><ulink
url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">Bugzilla</ulink></quote>
product.
</para>
</listitem>
<listitem>
......
docs/xml/installation.xml
View file @ 58593ba9
......@@ -616,6 +616,15 @@ bash# mkdir /usr/bonsaitools/bin
bash# ln -s /usr/bin/perl /usr/bosaitools/bin/perl
</programlisting>
</para>
<para>
Alternately, you can simply run this perl one-liner to
change your path to perl in all the files in your Bugzilla
installation:
<programlisting>
perl -pi -e 's@#!/usr/bonsaitools/bin/perl@/usr/bin/perl@' *cgi *pl Bug.pm
</programlisting>
Change the second path to perl to match your installation.
</para>
</example>
<tip>
<para>
......@@ -1241,7 +1250,7 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
</section>
<section>
<section id="unixhistory">
<title>UNIX Installation Instructions History</title>
<para>
This document was originally adapted from the Bonsai
......@@ -1252,9 +1261,8 @@ bash# cd $BUGZILLA_HOME; for i in `ls *.cgi`; \
The February 25, 1999 re-write of this page was done by Ry4an
Brase &lt;ry4an@ry4an.org&gt;, with some edits by Terry
Weissman, Bryce Nesbitt, Martin Pool, & Dan Mosedale (But
don't send bug reports to them; report them using bugzilla, at
http://bugzilla.mozilla.org/enter_bug.cgi , project Webtools,
component Bugzilla).
don't send bug reports to them; report them using bugzilla, at <ulink
url="http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla">http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla</ulink> ).
</para>
<para>
This document was heavily modified again Wednesday, March 07
......@@ -1696,16 +1704,46 @@ exit;
<step>
<para>
Modify the invocation of all system() calls in all perl scripts in your Bugzilla directory. For instance, change this line in processmail:
<programlisting>
system ("./processmail.pl",@ARGLIST);
</programlisting>
to
<programlisting>
Modify the invocation of all system() calls in all perl
scripts in your Bugzilla directory. For instance, change
this line in processmail:
<programlisting>
system ("./processmail.pl",@ARGLIST);
</programlisting> to
<programlisting>
system ("perl processmail.pl",@ARGLIST);
</programlisting>
</para>
</step>
<step>
<para>
Add <function>binmode()</function> calls so attachments
will work (<ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>).
</para>
<para>
Because Microsoft Windows based systems handle binary
files different than Unix based systems, you need to add
the following lines to
<filename>createattachment.cgi</filename> and
<filename>showattachment.cgi</filename> before the
<function>require 'CGI.pl';</function> line.
</para>
<para>
<programlisting>
<![CDATA[
binmode(STDIN);
binmode(STDOUT);
]]>
</programlisting>
</para>
<note>
<para>
According to <ulink
url="http://bugzilla.mozilla.org/show_bug.cgi?id=62000">bug 62000</ulink>, the perl documentation says that you should always use <function>binmode()</function> when dealing with binary files, but never when dealing with text files. That seems to suggest that rather than aribtrarily putting <function>binmode()</function> at the begining of the attachment files, there should be logic to determine if <function>binmode()</function> is needed or not.
</para>
</note>
</step>
</procedure>
<tip>
......@@ -1714,6 +1752,8 @@ system ("perl processmail.pl",@ARGLIST);
relationships to Properties -> Home directory (tab) ->
Application Settings (section) -> Configuration (button),
such as:
</para>
<para>
<programlisting>
.cgi to: &lt;perl install directory&gt;\perl.exe %s %s
.pl to: &lt;perl install directory&gt;\perl.exe %s %s
......@@ -1742,7 +1782,9 @@ GET,HEAD,POST
registry at the following location:
</para>
<para>
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
<programlisting>
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
</programlisting>
</para>
<para>
The keys should be called ".pl" and ".cgi", and both
......@@ -1761,26 +1803,102 @@ GET,HEAD,POST
If attempting to run Bugzilla 2.12 or older, you will need
to remove encrypt() calls from the Perl source. This is
<emphasis>not necessary</emphasis> for Bugzilla 2.13 and
later.
later, which includes the current release, Bugzilla
&bz-ver;.
<example>
<title>Removing encrypt() for Windows NT Bugzilla version
2.12 or earlier</title>
<para>
Replace this:
<programlisting>
SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SqlQuote(substr($realcryptpwd, 0, 2)) . ")");
my $enteredcryptpwd = FetchOneColumn();
</programlisting>
with this:
<programlisting>
my $enteredcryptpwd = $enteredpwd
</programlisting>
Replace this:
<programlisting>
SendSQL("SELECT encrypt(" . SqlQuote($enteredpwd) . ", " . SQLQuote(substr($realcryptpwd, 0, 2)) . ")");
my $enteredcryptpwd = FetchOneColumn();
</programlisting>
with this:
<programlisting>
my $enteredcryptpwd = $enteredpwd
</programlisting>
in cgi.pl.
</para>
</example>
</para>
</tip>
</section>
<section id="bzldap">
<title>Bugzilla LDAP Integration</title>
<para>
What follows is some late-breaking information on using the
LDAP authentication options with Bugzilla. The author has not
tested these (nor even formatted this section!) so please
contribute feedback to the newsgroup.
</para>
<literallayout>
Mozilla::LDAP module
The Mozilla::LDAP module allows you to use LDAP for authentication to
the Bugzilla system. This module is not required if you are not using
LDAP.
Mozilla::LDAP (aka PerLDAP) is available for download from
http://www.mozilla.org/directory.
NOTE: The Mozilla::LDAP module requires Netscape's Directory SDK.
Follow the link for "Directory SDK for C" on that same page to
download the SDK first. After you have installed this SDK, then
install the PerLDAP module.
----------------------------------------------------------------------
Post-Installation Checklist
----------------------------------------------------------------------
Set useLDAP to "On" **only** if you will be using an LDAP directory
for authentication. Be very careful when setting up this parameter;
if you set LDAP authentication, but do not have a valid LDAP directory
set up, you will not be able to log back in to Bugzilla once you log
out. (If this happens, you can get back in by manually editing the
data/params file, and setting useLDAP back to 0.)
If using LDAP, you must set the three additional parameters:
Set LDAPserver to the name (and optionally port) of your LDAP server.
If no port is specified, it defaults to the default port of 389. (e.g
"ldap.mycompany.com" or "ldap.mycompany.com:1234")
Set LDAPBaseDN to the base DN for searching for users in your LDAP
directory. (e.g. "ou=People,o=MyCompany") uids must be unique under
the DN specified here.
Set LDAPmailattribute to the name of the attribute in your LDAP
directory which contains the primary email address. On most directory
servers available, this is "mail", but you may need to change this.
----------------------------------------------------------------------
(Not sure where this bit should go, but it's important that it be in
there somewhere...)
----------------------------------------------------------------------
Using LDAP authentication for Bugzilla:
The existing authentication scheme for Bugzilla uses email addresses
as the primary user ID, and a password to authenticate that user. All
places within Bugzilla where you need to deal with user ID (e.g
assigning a bug) use the email address.
The LDAP authentication builds on top of this scheme, rather than
replacing it. The initial log in is done with a username and password
for the LDAP directory. This then fetches the email address from LDAP
and authenticates seamlessly in the standard Bugzilla authentication
scheme using this email address. If an account for this address
already exists in your Bugzilla system, it will log in to that
account. If no account for that email address exists, one is created
at the time of login. (In this case, Bugzilla will attempt to use the
"displayName" or "cn" attribute to determine the user's full name.)
After authentication, all other user-related tasks are still handled
by email address, not LDAP username. You still assign bugs by email
address, query on users by email address, etc.
----------------------------------------------------------------------
</literallayout>
</section>
</section>
</chapter>
......
docs/xml/integration.xml
View file @ 58593ba9
......@@ -35,6 +35,14 @@
an @resolution field, you can even change the Bugzilla bug
state.
</para>
<para>
There is also a project, based upon somewhat dated Bugzilla
code, to integrate CVS and Bugzilla through CVS' ability to
email. Check it out at:
<ulink url="http://homepages.kcbbs.gen.nz/~tonyg/">
http://homepages.kcbbs.gen.nz/~tonyg/</ulink>, under the
<quote>cvszilla</quote> link.
</para>
</section>
<section id="scm" xreflabel="Perforce SCM (Fast Software Configuration Management System, a powerful commercial alternative to CVS">
......
docs/xml/patches.xml
View file @ 58593ba9
......@@ -247,6 +247,104 @@ RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R]
</para>
</section>
<section id="bzhacking">
<title>Hacking Bugzilla</title>
<para>
What follows are some general guidelines for changing Bugzilla, and adhering to good coding practice while doing so. We've had some checkins in the past which ruined Bugzilla installations because of disregard for these conventions. Sorry for the lack of formatting; I got this info into the Guide on the day of 2.14 release and haven't formatted it yet.
</para>
<literallayout>
The following is a guide for reviewers when checking code into Bugzilla's
CVS repostory at mozilla.org. If you wish to submit patches to Bugzilla,
you should follow the rules and style conventions below. Any code that
does not adhere to these basic rules will not be added to Bugzilla's
codebase.
1. Usage of variables in Regular Expressions
It is very important that you don't use a variable in a regular
expression unless that variable is supposed to contain an expression.
This especially applies when using grep. You should use:
grep ($_ eq $value, @array);
- NOT -
grep (/$value/, @array);
If you need to use a non-expression variable inside of an expression, be
sure to quote it properly (using \Q..\E).
Coding Style for Bugzilla
-------------------------
While it's true that not all of the code currently in Bugzilla adheres to
this styleguide, it is something that is being worked toward. Therefore,
we ask that all new code (submitted patches and new files) follow this guide
as closely as possible (if you're only changing 1 or 2 lines, you don't have
to reformat the entire file :).
1. Whitespace
Bugzilla's prefered indentation is 4 spaces (no tabs, please).
2. Curly braces.
The opening brace of a block should be on the same line as the statement
that is causing the block and the closing brace should be at the same
indentation level as that statement, for example:
if ($var) {
print "The variable is true";
} else {
print "Try again";
}
- NOT -
if ($var)
{
print "The variable is true";
}
else
{
print "Try again";
}
3. File Names
File names for bugzilla code and support documention should be legal across
multiple platforms. \ / : * ? " < > and | are all illegal characters for
filenames on various platforms. Also, file names should not have spaces in
them as they can cause confusion in CVS and other mozilla.org utilities.
4. Variable Names
If a variable is scoped globally ($::variable) its name should be descriptive
of what it contains. Local variables can be named a bit looser, provided the
context makes their content obvious. For example, $ret could be used as a
staging variable for a routine's return value as the line |return $ret;| will
make it blatently obvious what the variable holds and most likely be shown
on the same screen as |my $ret = "";|.
5. Cross Database Compatability
Bugzilla was originally written to work with MySQL and therefore took advantage
of some of its features that aren't contained in other RDBMS software. These
should be avoided in all new code. Examples of these features are enums and
encrypt().
6. Cross Platform Compatability
While Bugzilla was written to be used on Unix based systems (and Unix/Linux is
still the only officially supported platform) there are many who desire/need to
run Bugzilla on Microsoft Windows boxes. Whenever possible, we should strive
not to make the lives of these people any more complicated and avoid doing things
that break Bugzilla's ability to run on multiple operating systems.
</literallayout>
</section>
</appendix>
......
docs/xml/using.xml
View file @ 58593ba9
......@@ -399,13 +399,13 @@ system against which all others are measured.
our Bugzilla database. Please notice the box is a
<emphasis>scrollbox</emphasis>. Using the down arrow on
the scrollbox, scroll down until you can see an entry
called "Webtools". Select this entry.
called "Bugzilla". Select this entry.
</para>
</listitem>
<listitem>
<para>
Did you notice that some of the boxes to the right changed
when you selected "Webtools"? Every Program (or Product)
when you selected "Bugzilla"? Every Program (or Product)
has different Versions, Components, and Target Milestones
associated with it. A "Version" is the number of a
software program.
......@@ -452,36 +452,67 @@ system against which all others are measured.
Normally, a Component has a single Owner, who is responsible
for overseeing efforts to improve that Component.
<example>
<title>Mozilla Webtools Components</title>
<title>Mozilla's Bugzilla Components</title>
<informalexample>
<para>
Mozilla's "Webtools" Product is composed of several pieces (Components):
Mozilla's "Bugzilla" Product is composed of several pieces (Components):
<simplelist>
<member><emphasis>Bonsai</emphasis>,
a tool to show recent changes to Mozilla</member>
<member><emphasis>Bugzilla</emphasis>,
a defect-tracking tool</member>
<member><emphasis>Build</emphasis>,
a tool to automatically compile source code
into machine-readable form</member>
<member><emphasis>Despot</emphasis>,
a program that controls access to the other Webtools</member>
<member><emphasis>LXR</emphasis>,
a utility that automatically marks up text files
to make them more readable</member>
<member><emphasis>MozBot</emphasis>,
a "robot" that announces changes to Mozilla in Chat</member>
<member><emphasis>TestManager</emphasis>,
a tool to help find bugs in Mozilla</member>
<member><emphasis>Tinderbox</emphasis>,
which displays reports from Build</member>
<member><emphasis>Administration</emphasis>,
Administration of a bugzilla installation, including
<filename>editcomponents.cgi</filename>,
<filename>editgroups.cgi</filename>,
<filename>editkeywords.cgi</filename>,
<filename>editparams.cgi</filename>,
<filename>editproducts.cgi</filename>,
<filename>editusers.cgi</filename>,
<filename>editversions.cgi,</filename> and
<filename>sanitycheck.cgi</filename>.
</member>
<member><emphasis>Bugzilla-General</emphasis>,
Anything that doesn't fit in the other components, or spans
multiple components.
</member>
<member><emphasis>Creating/Changing Bugs</emphasis>,
Creating, changing, and viewing bugs.
<filename>enter_bug.cgi</filename>,
<filename>post_bug.cgi</filename>,
<filename>show_bug.cgi</filename> and
<filename>process_bug.cgi</filename>.
</member>
<member><emphasis>Documentation</emphasis>,
The bugzilla documentation, including anything in the
<filename>docs/</filename> directory and The Bugzilla Guide
(This document :)
</member>
<member><emphasis>Email</emphasis>,
Anything to do with email sent by Bugzilla.
<filename>processmail</filename>
</member>
<member><emphasis>Installation</emphasis>,
The installation process of Bugzilla. This includes
<filename>checksetup.pl</filename> and whatever else it evolves into.
</member>
<member><emphasis>Query/Buglist</emphasis>,
Anything to do with searching for bugs and viewing the buglists.
<filename>query.cgi</filename> and
<filename>buglist.cgi</filename>
</member>
<member><emphasis>Reporting/Charting</emphasis>,
Getting reports from Bugzilla.
<filename>reports.cgi</filename> and
<filename>duplicates.cgi</filename>
</member>
<member><emphasis>User Accounts</emphasis>,
Anything about managing a user account from the user's perspective.
<filename>userprefs.cgi</filename>, saved queries, creating accounts,
changing passwords, logging in, etc.
</member>
<member><emphasis>User Interface</emphasis>,
General issues having to do with the user interface cosmetics (not
functionality) including cosmetic issues, HTML templates, etc.
</member>
</simplelist>
</para>
<para>
A different person is responsible for each of these Components.
Tara Hernandez keeps
the "Bugzilla" component up-to-date.
</para>
</informalexample>
</example>
</para>
......
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