From d09b99cd75d28060df41b84eb4c11aee0cd32f62 Mon Sep 17 00:00:00 2001 From: "jake%bugzilla.org" <> Date: Wed, 23 Apr 2003 09:32:52 +0000 Subject: Recompile the docs from the XML source in anticipation of the 2.17.4 release. --- docs/html/Bugzilla-Guide.html | 971 ++++++++++++++++++++++------------------- docs/html/administration.html | 8 +- docs/html/cust-templates.html | 8 +- docs/html/dbdoc.html | 4 +- docs/html/extraconfig.html | 6 +- docs/html/faq.html | 125 ++++-- docs/html/gfdl-howto.html | 2 +- docs/html/gfdl.html | 2 +- docs/html/glossary.html | 116 ++++- docs/html/index.html | 24 +- docs/html/installation.html | 28 +- docs/html/os-specific.html | 247 +++++------ docs/html/stepbystep.html | 269 ++---------- docs/html/troubleshooting.html | 114 ++++- docs/txt/Bugzilla-Guide.txt | 223 ++++++---- 15 files changed, 1148 insertions(+), 999 deletions(-) (limited to 'docs') diff --git a/docs/html/Bugzilla-Guide.html b/docs/html/Bugzilla-Guide.html index 4c91b1051..694648c26 100644 --- a/docs/html/Bugzilla-Guide.html +++ b/docs/html/Bugzilla-Guide.html @@ -61,7 +61,7 @@ CLASS="corpauthor" >The Bugzilla Team

2003-02-16

2003-04-23

This documentation is maintained in DocBook 4.1.2 XML format. - Changes are best submitted as plain text or SGML diffs, attached + Changes are best submitted as plain text or XML diffs, attached to a bug filed in the

List of Figures
4-1. Other File::Temp error messages
4-2. Patch for File::Temp in Perl 5.6.0
List of Examples
Date::Parse - (any) + (2.21)

  • -

    Linux-Mandrake 8.0 includes every - required and optional library for Bugzilla. The easiest way to - install them is by using the - urpmi - - utility. If you follow these commands, you should have everything you - need for Bugzilla, and - checksetup.pl - - should not complain about any missing libraries. You may already have - some of these installed.

    bash# - - urpmi perl-mysql -
    bash# - - urpmi perl-chart -
    bash# - - urpmi perl-gd -
    bash# - - urpmi perl-MailTools - - (for Bugzilla email integration)
    bash# - - urpmi apache-modules -


    4.1.5.1. DBI


    4.1.5.2. Data::Dumper


    4.1.5.3. MySQL-related modules


    4.1.5.4. TimeDate modules


    4.1.5.5. GD (optional)


    4.1.5.6. Chart::Base (optional)


    4.1.5.7. Template Toolkit


    4.1.7. Bugzilla

    checksetup.pl script, which locks down your installation.

    Lastly, you'll need to set up a symbolic link to - /usr/bonsaitools/bin/perl - for the correct location of your Perl executable (probably - /usr/bin/perl). - Otherwise you must hack all the .cgi files to change where they look - for Perl. This can be done using the following Perl one-liner, but - I suggest using the symlink approach to avoid upgrade hassles. -

    "Bonsaitools" is the name Terry Weissman, the - original author of Bugzilla, created - for his suite of webtools at the time he created Bugzilla and several - other tools in use at mozilla.org. He created a directory, - /usr/bonsaitools to house his specific versions - of perl and other utilities. This usage is still current at - bugzilla.mozilla.org, - but in general most other places do not use it. You can either edit - the paths at the start of each perl file to the correct location of - perl on your system, or simply bow to history and create a - /usr/bonsaitools and /usr/bonsaitools/bin - directory, placing a symlink to perl on your system - inside /usr/bonsaitools/bin -

    -
    
perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm syncshadowdb
    -        
    - - Change /usr/bin/perl to match the location - of Perl on your machine. -


    4.1.8. Setting Up the MySQL Database

    If you are using MySQL 4, the bugs user also needs to be granted + the LOCK TABLES and CREATE TEMPORARY TABLES permissions. +


    4.1.9.

    4.1.10. Configuring Bugzilla

    4.2.1. Dependency Charts


    4.2.2. Bug Graphs


    4.2.3. The Whining Cron


    4.3.1.3.2. System Calls

    In order to get system calls to work on win32's perl, you need - to tell the windows shell what interpreter to use. This is done by - changing the system calls. You will need to - search all of Bugzilla's code for system calls. - To tell perl your interpreter, it needs to be the first argument to - the system call. For example, you'll need to - change: -

    
system("$webdotbase","-Tpng","-o","$pngfilename","$filename");
    -          

    with

    
system("C:\\perl\\bin\\perl", "$webdotbase","-Tpng","-o","$pngfilename","$filename");
    -          

    The grep command is very helpful in finding - these system calls, assuming you have the - cygwin utilities. -

    It appears that the only system call - remaining in the Bugzilla codebase is in - showdependencygraph.cgi. Not changing this - file will only cause dependency graphs to not function if the - webdotbase paramater points to a local - installation of GraphViz. -

    /usr/bonsaitools/bin/perl/usr/bin/perl.

    this patch @@ -4814,42 +4501,141 @@ CLASS="command" > makemake + make test + make install + And don't forget to run + exit + + to get back to CPAN.

    +


    4.3.3. Linux-Mandrake 8.0

    Linux-Mandrake 8.0 includes every required and optional library + for Bugzilla. The easiest way to install them is by using the + urpmi utility. If you follow these commands, you + should have everything you need for Bugzilla, and + ./checksetup.pl should not complain about any + missing libraries. You may already have some of these installed. +

    
bash# urpmi perl-mysql
    +bash# urpmi perl-chart
    -        
    bash# make testurpmi perl-gd -
    bash# make installurpmi perl-MailTools -
    And don't forget to run - bash# exiturpmi apache-modules - - to get back to CPAN.

    -

    for Bugzilla e-mail integration

    4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1


    4.5.2. DBD::Sponge::db prepare failed


    4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT

    This is caused by a bug in the version of + File::Temp that is distributed with perl + 5.6.0. Many minor variations of this error have been reported. Examples + can be found in Figure 4-1. +

    Figure 4-1. Other File::Temp error messages

    
Your vendor has not defined Fcntl macro O_NOINHERIT, used 
    +at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 208.
    +
    +Your vendor has not defined Fcntl macro O_EXLOCK, used 
    +at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 210.
    +
    +Your vendor has not defined Fcntl macro O_TEMPORARY, used 
    +at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233.
    +        

    Numerous people have reported that upgrading to version 5.6.1 + or higher solved the problem for them. A less involved fix is to apply + the patch in Figure 4-2. The patch is also + available as a patch file. +

    Figure 4-2. Patch for File::Temp in Perl 5.6.0

    
--- File/Temp.pm.orig   Thu Feb  6 16:26:00 2003
    ++++ File/Temp.pm        Thu Feb  6 16:26:23 2003
    +@@ -205,6 +205,7 @@
    +     # eg CGI::Carp
    +     local $SIG{__DIE__} = sub {};
    +     local $SIG{__WARN__} = sub {};
    ++    local *CORE::GLOBAL::die = sub {};
    +     $bit = &$func();
    +     1;
    +   };
    +@@ -226,6 +227,7 @@
    +     # eg CGI::Carp
    +     local $SIG{__DIE__} = sub {};
    +     local $SIG{__WARN__} = sub {};
    ++    local *CORE::GLOBAL::die = sub {};
    +     $bit = &$func();
    +     1;
    +   };
    +        

    5.7.1. What to Edit


    5.7.2. How To Edit Templates


    5.7.3. Template Formats


    5.7.4. Particular Templates

    A.1.9. Why do the scripts say "/usr/bonsaitools/bin/perl" instead of - "/usr/bin/perl" or something else? +> What is /usr/bonsaitools/bin/perl?
    A.1.10. My perl is not located at /usr/bin/perl, is + there an easy way to change it everywhere it needs to be changed? +
    A.1.11. Is there an easy way to change the Bugzilla cookie name? A.1.9. - Why do the scripts say "/usr/bonsaitools/bin/perl" instead of - "/usr/bin/perl" or something else? + What is /usr/bonsaitools/bin/perl?

    - Mozilla.org uses /usr/bonsaitools/bin/perl, because originally - Terry wanted a place to put a version of Perl and other tools - that was strictly under his control. -

    /usr/bonsaitools/bin/perl because when + Terry first started writing the code for mozilla.org he needed a + version of Perl and other tools that were completely under his + control. This location was abandoned for the 2.18 release in favor + of the more sensible /usr/bin/perl. If you + installed an older verion of Bugzilla and created the symlink we + suggested, you can remove it now (provided that you don't have + anything else, such as Bonsai, using it and you don't intend to + reinstall an older version of Bugzilla). +

    We always recommend that, if possible, you keep the path - as /usr/bonsaitools/bin/perl, and simply add symlink. - This will make upgrading - your Bugzilla much easier in the future. -

    A.1.10. + My perl is not located at /usr/bin/perl, is + there an easy way to change it everywhere it needs to be changed? +

    + Yes, the following bit of perl magic will change all the shebang + lines. Be sure to change /usr/local/bin/perl + to your path to the perl binary. +

    
perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl
    +          
    A.1.10. A.1.11. Is there an easy way to change the Bugzilla cookie name?

    importxml.pl which is intended to be - used for importing the data generated by xml.cgi - in association with bug moving. Any other use is left as an - exercise for the user. +>show_bug.cgi in association with bug moving. + Any other use is left as an exercise for the user.

    There are also scripts included in the Yes. For more information including available translated templates, see http://www.bugzilla.org/download.htmlhttp://www.bugzilla.org/download.html#localizations. The admin interfaces are still not included in these translated templates and is therefore still English only. Also, there may be @@ -10442,13 +10408,14 @@ CLASS="answer" > Try Klaas Freitag's excellent patch for "whineatassigned" functionality. - You can find it at http://bugzilla.mozilla.org/show_bug.cgi?id=6679http://bugzilla.mozilla.org/show_bug.cgi?id=6679. This patch is against an older version of Bugzilla, so you must apply the diffs manually. +

    Microsoft has some advice on this matter, as well:

    Bugzilla Project Page for details on how to @@ -11550,7 +11517,7 @@ CLASS="section" >

    B.2.1. Bugzilla Database Basics


    B.2.1.1. Bugzilla Database Tables

    Version 1.1, March 2000

    0-9, high ascii

    C

    Zarro Boogs Found

    This is the cryptic response sent by Bugzilla when a query - returned no results. It is just a goofy way of saying "Zero Bugs - Found".

    This is just a goofy way of saying that there were no bugs + found matching your query. When asked to explain this message, + Terry had the following to say: +

     

    I've been asked to explain this ... way back when, when + Netscape released version 4.0 of its browser, we had a release + party. Naturally, there had been a big push to try and fix every + known bug before the release. Naturally, that hadn't actually + happened. (This is not unique to Netscape or to 4.0; the same thing + has happened with every software project I've ever seen.) Anyway, + at the release party, T-shirts were handed out that said something + like "Netscape 4.0: Zarro Boogs". Just like the software, the + T-shirt had no known bugs. Uh-huh. +

    So, when you query for a list of bugs, and it gets no results, + you can think of this as a friendly reminder. Of *course* there are + bugs matching your query, they just aren't in the bugsystem yet... +

     
    --Terry Weissman 
    5.7.1. What to Edit
    5.7.2. How To Edit Templates
    5.7.3. Template Formats
    5.7.4. Particular Templates

    5.7.1. What to Edit

    5.7.2. How To Edit Templates

    5.7.3. Template Formats

    5.7.4. Particular Templates

    B.2.1. Bugzilla Database Basics

    B.2.1.1. Bugzilla Database Tables

    4.2.1. Dependency Charts

    4.2.2. Bug Graphs

    4.2.3. The Whining Cron

    A.1.9. Why do the scripts say "/usr/bonsaitools/bin/perl" instead of - "/usr/bin/perl" or something else? +> What is /usr/bonsaitools/bin/perl?
    A.1.10. My perl is not located at /usr/bin/perl, is + there an easy way to change it everywhere it needs to be changed? +
    A.1.11. Is there an easy way to change the Bugzilla cookie name? A.1.9. - Why do the scripts say "/usr/bonsaitools/bin/perl" instead of - "/usr/bin/perl" or something else? + What is /usr/bonsaitools/bin/perl?

    - Mozilla.org uses /usr/bonsaitools/bin/perl, because originally - Terry wanted a place to put a version of Perl and other tools - that was strictly under his control. -

    /usr/bonsaitools/bin/perl
    because when + Terry first started writing the code for mozilla.org he needed a + version of Perl and other tools that were completely under his + control. This location was abandoned for the 2.18 release in favor + of the more sensible /usr/bin/perl. If you + installed an older verion of Bugzilla and created the symlink we + suggested, you can remove it now (provided that you don't have + anything else, such as Bonsai, using it and you don't intend to + reinstall an older version of Bugzilla). +

    We always recommend that, if possible, you keep the path - as /usr/bonsaitools/bin/perl, and simply add symlink. - This will make upgrading - your Bugzilla much easier in the future. -

    A.1.10. + My perl is not located at /usr/bin/perl, is + there an easy way to change it everywhere it needs to be changed? +

    + Yes, the following bit of perl magic will change all the shebang + lines. Be sure to change /usr/local/bin/perl + to your path to the perl binary. +

    
perl -pi -e 's@#\!/usr/bin/perl@#\!/usr/local/bin/perl@' *cgi *pl
    +          
    A.1.10. A.1.11. Is there an easy way to change the Bugzilla cookie name?

    importxml.pl which is intended to be - used for importing the data generated by xml.cgi - in association with bug moving. Any other use is left as an - exercise for the user. +>show_bug.cgi in association with bug moving. + Any other use is left as an exercise for the user.

    There are also scripts included in the Yes. For more information including available translated templates, see http://www.bugzilla.org/download.htmlhttp://www.bugzilla.org/download.html#localizations. The admin interfaces are still not included in these translated templates and is therefore still English only. Also, there may be @@ -1833,13 +1903,14 @@ CLASS="answer" > Try Klaas Freitag's excellent patch for "whineatassigned" functionality. - You can find it at http://bugzilla.mozilla.org/show_bug.cgi?id=6679http://bugzilla.mozilla.org/show_bug.cgi?id=6679. This patch is against an older version of Bugzilla, so you must apply the diffs manually. +

    Microsoft has some advice on this matter, as well:

    Bugzilla Project Page for details on how to diff --git a/docs/html/gfdl-howto.html b/docs/html/gfdl-howto.html index 931236fc5..5ba320953 100644 --- a/docs/html/gfdl-howto.html +++ b/docs/html/gfdl-howto.html @@ -81,7 +81,7 @@ NAME="gfdl-howto" of the License in the document and put the following copyright and license notices just after the title page:

    Version 1.1, March 2000

    0-9, high ascii

    C

    Zarro Boogs Found

    This is the cryptic response sent by Bugzilla when a query - returned no results. It is just a goofy way of saying "Zero Bugs - Found".

    This is just a goofy way of saying that there were no bugs + found matching your query. When asked to explain this message, + Terry had the following to say: +

     

    I've been asked to explain this ... way back when, when + Netscape released version 4.0 of its browser, we had a release + party. Naturally, there had been a big push to try and fix every + known bug before the release. Naturally, that hadn't actually + happened. (This is not unique to Netscape or to 4.0; the same thing + has happened with every software project I've ever seen.) Anyway, + at the release party, T-shirts were handed out that said something + like "Netscape 4.0: Zarro Boogs". Just like the software, the + T-shirt had no known bugs. Uh-huh. +

    So, when you query for a list of bugs, and it gets no results, + you can think of this as a friendly reminder. Of *course* there are + bugs matching your query, they just aren't in the bugsystem yet... +

     
    --Terry Weissman 
    The Bugzilla Team

    2003-02-16

    2003-04-23

    This documentation is maintained in DocBook 4.1.2 XML format. - Changes are best submitted as plain text or SGML diffs, attached + Changes are best submitted as plain text or XML diffs, attached to a bug filed in the

    List of Figures
    4-1. Other File::Temp error messages
    4-2. Patch for File::Temp in Perl 5.6.0

    4.3.1.3.2. System Calls

    In order to get system calls to work on win32's perl, you need - to tell the windows shell what interpreter to use. This is done by - changing the system calls. You will need to - search all of Bugzilla's code for system calls. - To tell perl your interpreter, it needs to be the first argument to - the system call. For example, you'll need to - change: -

    
system("$webdotbase","-Tpng","-o","$pngfilename","$filename");
    -          

    with

    
system("C:\\perl\\bin\\perl", "$webdotbase","-Tpng","-o","$pngfilename","$filename");
    -          

    The grep command is very helpful in finding - these system calls, assuming you have the - cygwin utilities. -

    It appears that the only system call - remaining in the Bugzilla codebase is in - showdependencygraph.cgi. Not changing this - file will only cause dependency graphs to not function if the - webdotbase paramater points to a local - installation of GraphViz. -

    /usr/bonsaitools/bin/perl/usr/bin/perl.

    this patch @@ -691,6 +547,105 @@ CLASS="command" >

    4.3.3. Linux-Mandrake 8.0

    Linux-Mandrake 8.0 includes every required and optional library + for Bugzilla. The easiest way to install them is by using the + urpmi utility. If you follow these commands, you + should have everything you need for Bugzilla, and + ./checksetup.pl should not complain about any + missing libraries. You may already have some of these installed. +

    
bash# urpmi perl-mysql
    +bash# urpmi perl-chart
    +bash# urpmi perl-gd
    +bash# urpmi perl-MailTools    
    +bash# urpmi apache-modules
    +      
    for Bugzilla e-mail integration
    -

    Linux-Mandrake 8.0 includes every - required and optional library for Bugzilla. The easiest way to - install them is by using the - urpmi - - utility. If you follow these commands, you should have everything you - need for Bugzilla, and - checksetup.pl - - should not complain about any missing libraries. You may already have - some of these installed.

    bash# - - urpmi perl-mysql -
    bash# - - urpmi perl-chart -
    bash# - - urpmi perl-gd -
    bash# - - urpmi perl-MailTools - - (for Bugzilla email integration)
    bash# - - urpmi apache-modules -

    4.1.5.1. DBI

    4.1.5.2. Data::Dumper

    4.1.5.3. MySQL-related modules

    4.1.5.4. TimeDate modules

    4.1.5.5. GD (optional)

    4.1.5.6. Chart::Base (optional)

    4.1.5.7. Template Toolkit

    4.1.7. Bugzilla

    checksetup.pl script, which locks down your installation.

    Lastly, you'll need to set up a symbolic link to - /usr/bonsaitools/bin/perl - for the correct location of your Perl executable (probably - /usr/bin/perl). - Otherwise you must hack all the .cgi files to change where they look - for Perl. This can be done using the following Perl one-liner, but - I suggest using the symlink approach to avoid upgrade hassles. -

    "Bonsaitools" is the name Terry Weissman, the - original author of Bugzilla, created - for his suite of webtools at the time he created Bugzilla and several - other tools in use at mozilla.org. He created a directory, - /usr/bonsaitools to house his specific versions - of perl and other utilities. This usage is still current at - bugzilla.mozilla.org, - but in general most other places do not use it. You can either edit - the paths at the start of each perl file to the correct location of - perl on your system, or simply bow to history and create a - /usr/bonsaitools and /usr/bonsaitools/bin - directory, placing a symlink to perl on your system - inside /usr/bonsaitools/bin -

    -
    
perl -pi -e 's@#\!/usr/bonsaitools/bin/perl@#\!/usr/bin/perl@' *cgi *pl Bug.pm syncshadowdb
    -        
    - - Change /usr/bin/perl to match the location - of Perl on your machine. -

    4.1.8. Setting Up the MySQL Database

    If you are using MySQL 4, the bugs user also needs to be granted + the LOCK TABLES and CREATE TEMPORARY TABLES permissions. +

    4.1.9.

    4.1.10. Configuring Bugzilla

    4.5.1. Bundle::Bugzilla makes me upgrade to Perl 5.6.1

    4.5.2. DBD::Sponge::db prepare failed

    4.5.4. Your vendor has not defined Fcntl macro O_NOINHERIT

    This is caused by a bug in the version of + File::Temp that is distributed with perl + 5.6.0. Many minor variations of this error have been reported. Examples + can be found in Figure 4-1. +

    Figure 4-1. Other File::Temp error messages

    
Your vendor has not defined Fcntl macro O_NOINHERIT, used 
    +at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 208.
    +
    +Your vendor has not defined Fcntl macro O_EXLOCK, used 
    +at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 210.
    +
    +Your vendor has not defined Fcntl macro O_TEMPORARY, used 
    +at /usr/lib/perl5/site_perl/5.6.0/File/Temp.pm line 233.
    +        

    Numerous people have reported that upgrading to version 5.6.1 + or higher solved the problem for them. A less involved fix is to apply + the patch in Figure 4-2. The patch is also + available as a patch file. +

    Figure 4-2. Patch for File::Temp in Perl 5.6.0

    
--- File/Temp.pm.orig   Thu Feb  6 16:26:00 2003
    ++++ File/Temp.pm        Thu Feb  6 16:26:23 2003
    +@@ -205,6 +205,7 @@
    +     # eg CGI::Carp
    +     local $SIG{__DIE__} = sub {};
    +     local $SIG{__WARN__} = sub {};
    ++    local *CORE::GLOBAL::die = sub {};
    +     $bit = &$func();
    +     1;
    +   };
    +@@ -226,6 +227,7 @@
    +     # eg CGI::Carp
    +     local $SIG{__DIE__} = sub {};
    +     local $SIG{__WARN__} = sub {};
    ++    local *CORE::GLOBAL::die = sub {};
    +     $bit = &$func();
    +     1;
    +   };
    +