From 164b989ee0e92922fa031e870836a30d1a7cc39c Mon Sep 17 00:00:00 2001 From: "mozilla%colinogilvie.co.uk" <> Date: Fri, 4 Apr 2008 11:47:38 +0000 Subject: Bug 232378: switch from entities to XIncludes for inclusion of modular docs files Patch by Colin Ogilvie ; r=vladd --- docs/en/xml/patches.xml | 359 +++++++++++++----------------------------------- 1 file changed, 95 insertions(+), 264 deletions(-) (limited to 'docs/en/xml/patches.xml') diff --git a/docs/en/xml/patches.xml b/docs/en/xml/patches.xml index 540109feb..f3e17290c 100644 --- a/docs/en/xml/patches.xml +++ b/docs/en/xml/patches.xml @@ -1,286 +1,117 @@ - - - Useful Patches and Utilities for Bugzilla - - Are you looking for a way to put your Bugzilla into overdrive? Catch - some of the niftiest tricks here in this section. - -
- Apache - <filename>mod_rewrite</filename> - - magic - - Apache's - mod_rewrite - - module lets you do some truly amazing things with URL rewriting. Here are - a couple of examples of what you can do. - - - - Make it so if someone types - http://www.foo.com/12345 - - , Bugzilla spits back http://www.foo.com/show_bug.cgi?id=12345. Try - setting up your VirtualHost section for Bugzilla with a rule like - this: - - - -RewriteEngine On -RewriteRule ^/([0-9]+)$ http://foo.bar.com/show_bug.cgi?id=$1 [L,R] - -]]> - - - - - There are many, many more things you can do with mod_rewrite. - As time goes on, I will include many more in the Guide. For now, - though, please refer to the mod_rewrite documentation at - http://www.apache.org - - - -
- -
- The setperl.csh Utility - - You can use the "setperl.csh" utility to quickly and easily change - the path to perl on all your Bugzilla files. This is a C-shell script; if - you do not have "csh" or "tcsh" in the search path on your system, it - will not work! - - - - Download the "setperl.csh" utility to your Bugzilla directory - and make it executable. - - - - - - bash# - - cd /your/path/to/bugzilla - - - - - - - - bash# - - wget -O setperl.csh - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795' - - - - - - - - bash# - - chmod u+x setperl.csh - - - - - - - - Prepare (and fix) Bugzilla file permissions. - - - - - - bash# - - chmod u+w * - - - - - - - - bash# - - chmod u+x duplicates.cgi - - - - - - - - bash# - - chmod a-x bug_status.html - - - - - - - - Run the script: + + + %myents; +]> - - - bash# - - ./setperl.csh /your/path/to/perl - - - - Using Setperl to set your perl path + + Contrib - - - bash# - - ./setperl.csh /usr/bin/perl - - - - - - -
+ + There are a number of unofficial Bugzilla add-ons in the + $BUGZILLA_ROOT/contrib/ + directory. This section documents them. +
- Command-line Bugzilla Queries - - Users can query Bugzilla from the command line using this suite of - utilities. - - The query.conf file contains the mapping from options to field - names and comparison types. Quoted option names are "grepped" for, so it - should be easy to edit this file. Comments (#) have no effect; you must - make sure these lines do not contain any quoted "option" - - buglist is a shell script which submits a Bugzilla query and writes - the resulting HTML page to stdout. It supports both short options, (such - as "-Afoo" or "-Rbar") and long options (such as "--assignedto=foo" or - "--reporter=bar"). If the first character of an option is not "-", it is - treated as if it were prefixed with "--default=". - - The columlist is taken from the COLUMNLIST environment variable. - This is equivalent to the "Change Columns" option when you list bugs in - buglist.cgi. If you have already used Bugzilla, use - grep COLUMLIST ~/.netscape/cookies - - to see your current COLUMNLIST setting. - - bugs is a simple shell script which calls buglist and extracts the - bug numbers from the output. Adding the prefix - "http://bugzilla.mozilla.org/buglist.cgi?bug_id=" turns the bug list into - a working link if any bugs are found. Counting bugs is easy. Pipe the - results through - sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}' + Command-line Search Interface + + + There are a suite of Unix utilities for searching Bugzilla from the + command line. They live in the + contrib/cmdline directory. + There are three files - query.conf, + buglist and bugs. - Akkana says she has good results piping buglist output through - w3m -T text/html -dump + + + These files pre-date the templatisation work done as part of the + 2.16 release, and have not been updated. + + + + + query.conf contains the mapping from + options to field names and comparison types. Quoted option names + are grepped for, so it should be easy to edit this + file. Comments (#) have no effect; you must make sure these lines + do not contain any quoted option. - - - Download three files: - - - - - - bash$ - - wget -O query.conf - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157' - - - - - - - - bash$ - - wget -O buglist - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944' - - - + + buglist is a shell script that submits a + Bugzilla query and writes the resulting HTML page to stdout. + It supports both short options, (such as -Afoo + or -Rbar) and long options (such + as --assignedto=foo or --reporter=bar). + If the first character of an option is not -, it is + treated as if it were prefixed with --default=. + - - - - bash# + + The column list is taken from the COLUMNLIST environment variable. + This is equivalent to the Change Columns option + that is available when you list bugs in buglist.cgi. If you have + already used Bugzilla, grep for COLUMNLIST in your cookies file + to see your current COLUMNLIST setting. + - wget -O bugs - 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215' - - - - - + + bugs is a simple shell script which calls + buglist and extracts the + bug numbers from the output. Adding the prefix + http://bugzilla.mozilla.org/buglist.cgi?bug_id= + turns the bug list into a working link if any bugs are found. + Counting bugs is easy. Pipe the results through + sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}' + - - Make your utilities executable: - - bash$ + + Akkana Peck says she has good results piping + buglist output through + w3m -T text/html -dump + - chmod u+x buglist bugs - - - -
-
- The Quicksearch Utility - - Quicksearch is a new, experimental feature of the 2.12 release. It - consist of two Javascript files, "quicksearch.js" and "localconfig.js", - and two documentation files, "quicksearch.html" and - "quicksearchhack.html" - - The index.html page has been updated to include the QuickSearch - text box. +
+ Command-line 'Send Unsent Bug-mail' tool - To take full advantage of the query power, the Bugzilla maintainer - must edit "localconfig.js" according to the value sets used in the local - installation. - - Currently, keywords must be hard-coded in localconfig.js. If they - are not, keywords are not automatically recognized. This means, if - localconfig.js is left unconfigured, that searching for a bug with the - "foo" keyword will only find bugs with "foo" in the summary, status - whiteboard, product or component name, but not those with the keyword - "foo". - - Workarounds for Bugzilla users: - - search for '!foo' (this will find only bugs with the keyword - "foo" + + Within the contrib directory + exists a utility with the descriptive (if compact) name + of sendunsentbugmail.pl. The purpose of this + script is, simply, to send out any bug-related mail that should + have been sent by now, but for one reason or another has not. + - search 'foo,!foo' (equivalent to 'foo OR keyword:foo') - + + To accomplish this task, sendunsentbugmail.pl uses + the same mechanism as the sanitycheck.cgi script; it + it scans through the entire database looking for bugs with changes that + were made more than 30 minutes ago, but where there is no record of + anyone related to that bug having been sent mail. Having compiled a list, + it then uses the standard rules to determine who gets mail, and sends it + out. - When this tool is ported from client-side JavaScript to server-side - Perl, the requirement for hard-coding keywords can be fixed. - This - bug + + As the script runs, it indicates the bug for which it is currently + sending mail; when it has finished, it gives a numerical count of how + many mails were sent and how many people were excluded. (Individual + user names are not recorded or displayed.) If the script produces + no output, that means no unsent mail was detected. + - has details. + + Usage: move the sendunsentbugmail.pl script + up into the main directory, ensure it has execute permission, and run it + from the command line (or from a cron job) with no parameters. +
+