From: gerv%gerv.net <> Date: Sat, 13 Jul 2002 14:53:58 +0000 (+0000) Subject: Regenerated files from another set of 2.16 doc fixes. X-Git-Tag: bugzilla-2.16~10 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=021c59c9a39b52464930ccb2b867b86125f108a8;p=thirdparty%2Fbugzilla.git Regenerated files from another set of 2.16 doc fixes. --- diff --git a/docs/html/administration.html b/docs/html/administration.html index df31d4ee4e..06b0592414 100644 --- a/docs/html/administration.html +++ b/docs/html/administration.html @@ -154,18 +154,18 @@ HREF="cust-templates.html" >
There are several ways to take advantage of Bugzilla's templates, and which you use depends on what you want to do. The Bugzilla @@ -118,7 +118,11 @@ CLASS="filename" custom. The (you may have to create + custom yourself.) The default @@ -148,7 +152,26 @@ CLASS="filename" the contents of this directory will not be touched during an upgrade, and you can then decide whether to continue using your own templates, or make the effort to merge your changes into the new versions by - hand. + hand. This is also the correct method to use if you upgrade Bugzilla + by untarring tarballs over the top, rather than using CVS. It's perfectly + acceptable to mix and match these two methods. +
Editing templates is a good way of doing a "poor man's custom fields". + For example, if you don't use the Status Whiteboard, but want to have + a free-form text entry box for "Build Identifier", then you can just + edit the templates to change the field labels. It's still be called + status_whiteboard internally, but your users don't need to know that. +
If you are making changes to contribute back to Bugzilla (and we'd + love to have them), then please read the + Developers + Guide first.
The syntax of the Template Toolkit language is beyond the scope of @@ -159,7 +182,9 @@ HREF="http://www.template-toolkit.org" TARGET="_top" >Template Toolkit home page. +>. However, you should particularly remember (for security + reasons) to always HTML filter things which come from the database or + user input, to prevent cross-site scripting attacks.
Some CGIs have the ability to use more than one template. For + example, buglist.cgi can output bug lists as RDF or two + different forms of HTML (complex and simple). (Try this out + by appending &format=simple to a buglist.cgi + URL on your Bugzilla installation.) This + mechanism, called template 'formats', is extensible. +
To see if a CGI supports multiple output formats, grep the + CGI for "ValidateOutputFormat". If it's not present, adding + multiple format support isn't too hard - see how it's done in + other CGIs. +
To make a new format template for a CGI which supports this, + open a current template for + that CGI and take note of the INTERFACE comment (if present.) This + comment defines what variables are passed into this template. If + there isn't one, I'm afraid you'll have to read the template and + the code to find out what information you get. +
Write your template in whatever markup or text style is appropriate. +
You now need to decide what content type you want your template + served as. Open up the localconfig file and find the + $contenttypes + variable. If your content type is not there, add it. Remember + the three- or four-letter tag assigned to you content type. + This tag will be part of the template filename. +
Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl. + Try out the template by calling the CGI as + <cginame>.cgi?format=<formatname> . +
There are a few templates you may be particularly interested in customising for your installation. @@ -207,6 +292,13 @@ NAME="AEN1542">5.7.2. Particular Templates
index.html.tmpl: + This is the Bugzilla front page. +
global/header.html.tmpl and guided + bug submission form.
To make this work, create a custom template for
@@ -246,8 +345,8 @@ CLASS="filename"
and either call it create.html.tmpl or
- or use a format and
+ call it create-<formatname>.html.tmpl.
@@ -263,7 +362,8 @@ CLASS="filename"
custom/bug/create/comment.txt.tmpl, which
+>, also named
+ after your format if you are using one, which
references the form fields you have created. When a bug report is
submitted, the initial comment attached to the bug report will be
formatted according to the layout of this template.
@@ -280,8 +380,7 @@ WIDTH="100%"
COLOR="#000000"
>
<input type="text" name="buildid" size="30">
-
<input type="text" name="buildid" size="30">
BuildID: [% form.buildid %]
-
BuildID: [% form.buildid %]
BuildID: 20020303
-
BuildID: 20020303
Some CGIs have the ability to use more than one template. For - example, buglist.cgi can output bug lists as RDF or two - different forms of HTML (complex and simple). (Try this out - by appending &format=simple to a buglist.cgi - URL on your Bugzilla installation.) This - mechanism, called template 'formats', is extensible. -
To see if a CGI supports multiple output formats, grep the - CGI for "ValidateOutputFormat". If it's not present, adding - multiple format support isn't too hard - see how it's done in - other CGIs. -
To make a new format template for a CGI which supports this, - open a current template for - that CGI and take note of the INTERFACE comment (if present.) This - comment defines what variables are passed into this template. If - there isn't one, I'm afraid you'll have to read the template and - the code to find out what information you get. -
Write your template in whatever markup or text style is appropriate. -
You now need to decide what content type you want your template - served as. Open up the localconfig file and find the $contenttypes - variable. If your content type is not there, add it. Remember - the three- or four-letter tag assigned to you content type. - This tag will be part of the template filename. -
Save the template as <stubname>-<formatname>.<contenttypetag>.tmpl. - Try out the template by calling the CGI as - <cginame>.cgi?format=<formatname> . -
If you were like me, at this point you're totally clueless about the internals of MySQL, and if it weren't for this executive order from @@ -247,7 +247,7 @@ CLASS="section" >
Imagine your MySQL database as a series of spreadsheets, and you won't be too far off. If you use this command:
As well as the text-based dependency graphs, Bugzilla also supports dependency graphing, using a package called 'dot'. @@ -141,7 +141,7 @@ CLASS="section" >
As long as you installed the GD and Graph::Base Perl modules you might as well turn on the nifty Bugzilla bug reporting graphs.
By now you have a fully functional Bugzilla, but what good are bugs if they're not annoying? To help make those bugs more annoying you diff --git a/docs/html/faq.html b/docs/html/faq.html index 7e8b580c4d..18f29302c7 100644 --- a/docs/html/faq.html +++ b/docs/html/faq.html @@ -85,64 +85,64 @@ HREF="faq.html#faq-general" >
A.1.1. Where can I find information about Bugzilla?
A.1.2.
What license is Bugzilla distributed under?
@@ -614,7 +614,7 @@ CLASS="qandaentry"
CLASS="question"
> A.1.3.
How do I get commercial support for Bugzilla?
@@ -649,7 +649,7 @@ CLASS="qandaentry"
CLASS="question"
> A.1.4.
What major companies or projects are currently using Bugzilla
@@ -757,7 +757,7 @@ CLASS="qandaentry"
CLASS="question"
> A.1.5.
Who maintains Bugzilla?
@@ -785,7 +785,7 @@ CLASS="qandaentry"
CLASS="question"
> A.1.6.
How does Bugzilla stack up against other bug-tracking databases?
@@ -821,7 +821,7 @@ CLASS="qandaentry"
CLASS="question"
> A.1.7.
Why doesn't Bugzilla offer this or that feature or compatability
@@ -859,7 +859,7 @@ CLASS="qandaentry"
CLASS="question"
> A.1.8.
Why MySQL? I'm interested in seeing Bugzilla run on
@@ -883,7 +883,7 @@ CLASS="qandaentry"
CLASS="question"
> A.1.9.
Why do the scripts say "/usr/bonsaitools/bin/perl" instead of
@@ -914,7 +914,7 @@ CLASS="qandaentry"
CLASS="question"
> A.1.10.
Is there an easy way to change the Bugzilla cookie name?
@@ -935,7 +935,7 @@ CLASS="answer"
CLASS="qandadiv"
>
The title of this section doesn't mean you're a PHB -- it just means
- you probably HAVE a PHB who wants to know this :)
+>
Questions likely to be asked by managers. :-)
A.2.1.
Is Bugzilla web-based, or do you have to have specific software or
@@ -997,7 +996,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.2.
Can Bugzilla integrate with
@@ -1021,7 +1020,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.3.
Does Bugzilla allow the user to track multiple projects?
@@ -1046,7 +1045,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.4.
If I am on many projects, and search for all bugs assigned to me, will
@@ -1069,7 +1068,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.5.
Does Bugzilla allow attachments (text, screenshots, URLs etc)? If yes,
@@ -1096,7 +1095,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.6.
Does Bugzilla allow us to define our own priorities and levels? Do we
@@ -1131,7 +1130,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.7.
Does Bugzilla provide any reporting features, metrics, graphs, etc? You
@@ -1149,7 +1148,7 @@ HREF="http://bugzilla.mozilla.org/reports.cgi"
TARGET="_top"
>
http://bugzilla.mozilla.org/reports.cgi for basic reporting
- facilities.
+ and graphing facilities.
For more advanced reporting, I recommend hooking up a professional
@@ -1167,7 +1166,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.8.
Is there email notification and if so, what do you see when you get an
@@ -1192,7 +1191,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.9.
Can email notification be set up to send to multiple
@@ -1215,7 +1214,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.10.
Do users have to have any particular
@@ -1272,7 +1271,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.11.
Does Bugzilla allow data to be imported and exported? If I had outsiders
@@ -1317,7 +1316,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.12.
Has anyone converted Bugzilla to another language to be used in other
@@ -1343,7 +1342,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.13.
Can a user create and save reports? Can they do this in Word format?
@@ -1366,7 +1365,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.14.
Does Bugzilla have the ability to search by word, phrase, compound
@@ -1390,7 +1389,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.15.
Does Bugzilla provide record locking when there is simultaneous access
@@ -1415,7 +1414,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.16.
Are there any backup features provided?
@@ -1443,7 +1442,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.17.
Can users be on the system while a backup is in progress?
@@ -1467,7 +1466,7 @@ CLASS="qandaentry"
CLASS="question"
>
Commercial Bug-tracking software typically costs somewhere upwards
@@ -1501,7 +1499,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.19.
What time frame are we looking at if we decide to hire people to install
@@ -1532,7 +1530,7 @@ CLASS="qandaentry"
CLASS="question"
> A.2.20.
Is there any licensing fee or other fees for using Bugzilla? Any
@@ -1562,7 +1560,7 @@ CLASS="qandaentry"
CLASS="question"
> A.3.1.
How do I completely disable MySQL security if it's giving me problems
@@ -1589,7 +1587,7 @@ CLASS="qandaentry"
CLASS="question"
> A.3.2.
Are there any security problems with Bugzilla?
@@ -1615,7 +1613,7 @@ CLASS="qandaentry"
CLASS="question"
> A.3.3.
I've implemented the security fixes mentioned in Chris Yeh's security
@@ -1647,7 +1645,7 @@ CLASS="qandaentry"
CLASS="question"
> A.4.1.
I have a user who doesn't want to receive any more email from Bugzilla.
@@ -1671,7 +1669,7 @@ CLASS="qandaentry"
CLASS="question"
> A.4.2.
I'm evaluating/testing Bugzilla, and don't want it to send email to
@@ -1695,7 +1693,7 @@ CLASS="qandaentry"
CLASS="question"
> A.4.3.
I want whineatnews.pl to whine at something more, or other than, only new
@@ -1725,7 +1723,7 @@ CLASS="qandaentry"
CLASS="question"
> A.4.4.
I don't like/want to use Procmail to hand mail off to bug_email.pl.
@@ -1741,7 +1739,7 @@ CLASS="answer"
You can call bug_email.pl directly from your aliases file, with
an entry like this:
bugzilla-daemon: "|/usr/local/bin/bugzilla/contrib/bug_email.pl"
@@ -1760,7 +1758,7 @@ CLASS="qandaentry"
CLASS="question"
> A.4.5.
How do I set up the email interface to submit/change bugs via email?
@@ -1783,7 +1781,7 @@ CLASS="qandaentry"
CLASS="question"
> A.4.6.
Email takes FOREVER to reach me from Bugzilla -- it's extremely slow.
@@ -1816,7 +1814,7 @@ CLASS="qandaentry"
CLASS="question"
> A.4.7.
How come email from Bugzilla changes never reaches me?
@@ -1852,7 +1850,7 @@ CLASS="qandaentry"
CLASS="question"
> A.5.1.
I've heard Bugzilla can be used with Oracle?
@@ -1877,7 +1875,7 @@ CLASS="qandaentry"
CLASS="question"
> A.5.2.
I think my database might be corrupted, or contain invalid entries. What
@@ -1922,7 +1920,7 @@ CLASS="qandaentry"
CLASS="question"
> A.5.3.
I want to manually edit some entries in my database. How?
@@ -1949,7 +1947,7 @@ CLASS="qandaentry"
CLASS="question"
> A.5.4.
I try to add myself as a user, but Bugzilla always tells me my password is wrong.
@@ -1973,7 +1971,7 @@ CLASS="qandaentry"
CLASS="question"
> A.5.5.
I think I've set up MySQL permissions correctly, but Bugzilla still can't
@@ -2000,7 +1998,7 @@ CLASS="qandaentry"
CLASS="question"
> A.5.6.
How do I synchronize bug information among multiple different Bugzilla
@@ -2042,7 +2040,7 @@ CLASS="qandaentry"
CLASS="question"
> A.6.1.
What is the easiest way to run Bugzilla on Win32 (Win98+/NT/2K)?
@@ -2065,7 +2063,7 @@ CLASS="qandaentry"
CLASS="question"
> A.6.2.
Is there a "Bundle::Bugzilla" equivalent for Win32?
@@ -2089,7 +2087,7 @@ CLASS="qandaentry"
CLASS="question"
> A.6.3.
CGI's are failing with a "something.cgi is not a valid Windows NT
@@ -2110,7 +2108,7 @@ CLASS="answer"
>
Microsoft has some advice on this matter, as well:
"Set application mappings. In the ISM, map the extension for the script
@@ -2133,7 +2131,7 @@ CLASS="qandaentry"
CLASS="question"
> A.6.4.
I'm having trouble with the perl modules for NT not being able to talk to
@@ -2206,7 +2204,7 @@ CLASS="qandaentry"
CLASS="question"
> A.7.1.
How do I change my user name (email address) in Bugzilla?
@@ -2229,7 +2227,7 @@ CLASS="qandaentry"
CLASS="question"
> A.7.2.
The query page is very confusing. Isn't there a simpler way to query?
@@ -2253,7 +2251,7 @@ CLASS="qandaentry"
CLASS="question"
> A.7.3.
I'm confused by the behavior of the "accept" button in the Show Bug form.
@@ -2306,7 +2304,7 @@ CLASS="qandaentry"
CLASS="question"
> A.7.4.
I can't upload anything into the database via the "Create Attachment"
@@ -2331,7 +2329,7 @@ CLASS="qandaentry"
CLASS="question"
> A.7.5.
Email submissions to Bugzilla that have attachments end up asking me to
@@ -2356,7 +2354,7 @@ CLASS="qandaentry"
CLASS="question"
> A.7.6.
How do I change a keyword in Bugzilla, once some bugs are using it?
@@ -2386,7 +2384,7 @@ CLASS="qandaentry"
CLASS="question"
> A.8.1.
What bugs are in Bugzilla right now?
@@ -2430,7 +2428,7 @@ CLASS="qandaentry"
CLASS="question"
> A.8.2.
How can I change the default priority to a null value? For instance, have the default
@@ -2460,7 +2458,7 @@ CLASS="qandaentry"
CLASS="question"
> A.8.3.
What's the best way to submit patches? What guidelines should I follow?
diff --git a/docs/html/glossary.html b/docs/html/glossary.html
index 87a2984a4a..e830ed5824 100644
--- a/docs/html/glossary.html
+++ b/docs/html/glossary.html
@@ -68,7 +68,7 @@ CLASS="glossdiv"
> Try to make sure that everything said in the summary is also
said in the first comment. Summaries are often updated and this will
diff --git a/docs/html/index.html b/docs/html/index.html
index fc65513175..4f78e47531 100644
--- a/docs/html/index.html
+++ b/docs/html/index.html
@@ -390,19 +390,19 @@ CLASS="LOT"
> Bugzilla has been successfully installed under Solaris, Linux,
and Win32. Win32 is not yet officially supported, but many people
@@ -97,7 +97,7 @@ CLASS="section"
> The DBI module is a generic Perl module used the
MySQL-related modules. As long as your Perl installation was done
@@ -835,7 +835,7 @@ CLASS="section"
> The Data::Dumper module provides data structure persistence for
Perl (similar to Java's serialization). It comes with later
@@ -847,7 +847,7 @@ CLASS="section"
> The Perl/MySQL interface requires a few mutually-dependent Perl
modules. These modules are grouped together into the the
@@ -871,7 +871,7 @@ CLASS="section"
> Many of the more common date/time/calendar related Perl modules
have been grouped into a bundle similar to the MySQL modules bundle.
@@ -885,7 +885,7 @@ CLASS="section"
> The GD library was written by Thomas Boutell a long while ago to
programatically generate images in C. Since then it's become the
@@ -938,7 +938,7 @@ CLASS="section"
> The Chart module provides Bugzilla with on-the-fly charting
abilities. It can be installed in the usual fashion after it has been
@@ -946,13 +946,28 @@ NAME="AEN662">4.1.5.6. Chart::Base (optional) When you install Template Toolkit, you'll get asked various
+ questions about features to enable. The defaults are fine, except
+ that it is recommended you use the high speed XS Stash of the Template
+ Toolkit, in order to achieve best performance. However, there are
+ known problems with XS Stash and Perl 5.005_02 and lower. If you
+ wish to use these older versions of Perl, please use the regular
+ stash. You have a freedom of choice here - Apache, Netscape or any other
server on UNIX would do. You can run the web server on a
@@ -1126,7 +1141,7 @@ CLASS="section"
> You should untar the Bugzilla files into a directory that you're
willing to make writable by the default web server user (probably
@@ -1237,7 +1252,7 @@ CLASS="section"
> After you've gotten all the software installed and working you're
ready to start preparing the database for its life as the back end to
@@ -1327,7 +1342,10 @@ CLASS="command"
and enter <new_password>. Remember that MySQL user names have
nothing to do with Unix user names (login names). Next, we create the
+>Next, we use an SQL GRANT command to create a
"bugs" If you followed the installation instructions for setting up your
"bugs" and "root" user in MySQL, much of this should not apply to you.
@@ -1832,7 +1850,7 @@ CLASS="section"
>
You should run through the parameters on the Edit Parameters page
(link in the footer) and set them all to appropriate values.
diff --git a/docs/html/troubleshooting.html b/docs/html/troubleshooting.html
index a34765a5fd..10d8b07693 100644
--- a/docs/html/troubleshooting.html
+++ b/docs/html/troubleshooting.html
@@ -83,7 +83,7 @@ CLASS="section"
>
The following error message may appear due to a bug in DBD::mysql
(over which the Bugzilla team have no control):
diff --git a/docs/html/upgrading.html b/docs/html/upgrading.html
index ab9ec0dd67..445154030e 100644
--- a/docs/html/upgrading.html
+++ b/docs/html/upgrading.html
@@ -76,20 +76,28 @@ CLASS="section"
NAME="upgrading">5.8. Upgrading to New Releases A plain Bugzilla is fairly easy to upgrade from one version to a
- newer one. However, things get a bit more complicated if you've made
- changes to Bugzilla's code. In this case, you may have to re-make or
- reapply those changes. It is recommended that you take a backup of your
- database and your entire Bugzilla installation before attempting an
+ newer one. Always read the release notes to see if there are any issues
+ that you might need to take note of. It is recommended that you take a
+ backup of your database and your entire Bugzilla installation before attempting an
upgrade. You can upgrade a 'clean' installation by untarring a new
tarball over the old installation. If you are upgrading from 2.12 or
- later, you can type
- cvs -z3 update,
- and resolve conflicts if there are any. However, things get a bit more complicated if you've made
+ changes to Bugzilla's code. In this case, you may have to re-make or
+ reapply those changes. One good method is to take a diff of your customised
+ version against the original, so you can survey all that you've changed.
+ Hopefully, templatisation will reduce the need for
+ this in the future. Because the developers of Bugzilla are constantly adding new
+>From version 2.8 onwards, Bugzilla databases can be automatically
+ carried forward during an upgrade. However, because the developers of
+ Bugzilla are constantly adding new
tables, columns and fields, you'll probably get SQL errors if you just
update the code and attempt to use Bugzilla. Always run the
2. Pointy-Haired-Boss Questions
2. Managerial Questions0-9, high ascii
0-9, high asciigeorge@example.com ftp://ftp.mozilla.org 3.2.5. Filing Bugs
3.2.5. Filing Bugs4.1.1. Introduction
4.1.1. Introduction4.1.2. Package List
4.1.2. Package List4.1.5.1. DBI
4.1.5.1. DBI4.1.5.2. Data::Dumper
4.1.5.2. Data::Dumper4.1.5.3. MySQL-related modules
4.1.5.3. MySQL-related modules4.1.5.4. TimeDate modules
4.1.5.4. TimeDate modules4.1.5.5. GD (optional)
4.1.5.5. GD (optional)4.1.5.6. Chart::Base (optional)
4.1.5.6. Chart::Base (optional)4.1.5.7. Template Toolkit
4.1.6. HTTP Server
4.1.6. HTTP Server4.1.7. Bugzilla
4.1.7. Bugzilla4.1.8. Setting Up the MySQL Database
4.1.8. Setting Up the MySQL Database4.1.9. 4.1.9. checksetup.pl
4.1.10. Securing MySQL
4.1.10. Securing MySQL4.1.11. Configuring Bugzilla
4.1.11. Configuring Bugzilla4.5.1. DBD::Sponge::db prepare failed
4.5.1. DBD::Sponge::db prepare failed