diff options
Diffstat (limited to 'docs/en/xml/patches.xml')
| -rw-r--r-- | docs/en/xml/patches.xml | 290 |
1 files changed, 198 insertions, 92 deletions
diff --git a/docs/en/xml/patches.xml b/docs/en/xml/patches.xml index 12efb0ca4..8d7a72682 100644 --- a/docs/en/xml/patches.xml +++ b/docs/en/xml/patches.xml @@ -1,131 +1,237 @@ -<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> --> -<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla"> - <title>Contrib</title> - - <para> - There are a number of unofficial Bugzilla add-ons in the - <filename class="directory">$BUGZILLA_ROOT/contrib/</filename> - directory. This section documents them. - </para> +<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> + +<appendix id="patches"> + <title>Useful Patches and Utilities for Bugzilla</title> + +<section id="setperl"> + <title>The setperl.csh Utility</title> + <para> + 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! + </para> + <procedure> + <step> + <para> + Download the "setperl.csh" utility to your Bugzilla + directory and make it executable. + </para> + <substeps> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>cd /your/path/to/bugzilla</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>wget -O setperl.csh 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>chmod u+x setperl.csh</command> + </computeroutput> + </para> + </step> + </substeps> + </step> + <step> + <para> + Prepare (and fix) Bugzilla file permissions. + </para> + <substeps> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>chmod u+w *</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>chmod u+x duplicates.cgi</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>chmod a-x bug_status.html</command> + </computeroutput> + </para> + </step> + </substeps> + </step> + <step> + <para> + Run the script: + </para> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>./setperl.csh /your/path/to/perl</command> + </computeroutput> +<example> + <title>Using Setperl to set your perl path</title> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>./setperl.csh /usr/bin/perl</command> + </computeroutput> + </para> + </example> + </para> + </step> + </procedure> + </section> <section id="cmdline"> - <title>Command-line Search Interface</title> - + <title>Command-line Bugzilla Queries</title> <para> - There are a suite of Unix utilities for searching Bugzilla from the - command line. They live in the - <filename class="directory">contrib/cmdline</filename> directory. - There are three files - <filename>query.conf</filename>, - <filename>buglist</filename> and <filename>bugs</filename>. + Users can query Bugzilla from the command line using + this suite of utilities. </para> - - <warning> - <para> - These files pre-date the templatization work done as part of the - 2.16 release, and have not been updated. - </para> - </warning> - <para> - <filename>query.conf</filename> contains the mapping from - options to field names and comparison types. Quoted option names - are <quote>grepped</quote> 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 <quote>option</quote>. + 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" </para> - <para> - <filename>buglist</filename> is a shell script that submits a - Bugzilla query and writes the resulting HTML page to stdout. - It supports both short options, (such as <quote>-Afoo</quote> - or <quote>-Rbar</quote>) and long options (such - as <quote>--assignedto=foo</quote> or <quote>--reporter=bar</quote>). - If the first character of an option is not <quote>-</quote>, it is - treated as if it were prefixed with <quote>--default=</quote>. + 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=". </para> - <para> - The column list is taken from the COLUMNLIST environment variable. - This is equivalent to the <quote>Change Columns</quote> 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. + 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 + <command>grep COLUMLIST ~/.netscape/cookies</command> to see + your current COLUMNLIST setting. </para> - <para> - <filename>bugs</filename> is a simple shell script which calls - <filename>buglist</filename> and extracts the - bug numbers from the output. Adding the prefix - <quote>http://bugzilla.mozilla.org/buglist.cgi?bug_id=</quote> + 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 + Counting bugs is easy. Pipe the results through <command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command> </para> - <para> - Akkana Peck says she has good results piping - <filename>buglist</filename> output through + Akkana says she has good results piping buglist output through <command>w3m -T text/html -dump</command> </para> - + <procedure> + <step> + <para> + Download three files: + </para> + <substeps> + <step> + <para> + <computeroutput> + <prompt>bash$</prompt> + <command>wget -O query.conf 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>bash$</prompt> + <command>wget -O buglist 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26944'</command> + </computeroutput> + </para> + </step> + <step> + <para> + <computeroutput> + <prompt>bash#</prompt> + <command>wget -O bugs 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> + </computeroutput> + </para> + </step> + </substeps> + </step> + <step> + <para> + Make your utilities executable: + <computeroutput> + <prompt>bash$</prompt> + <command>chmod u+x buglist bugs</command> + </computeroutput> + </para> + </step> + </procedure> </section> - <section id="cmdline-bugmail"> - <title>Command-line 'Send Unsent Bug-mail' tool</title> - + <section id="quicksearch"> + <title>The Quicksearch Utility</title> <para> - Within the <filename class="directory">contrib</filename> directory - exists a utility with the descriptive (if compact) name - of <filename>sendunsentbugmail.pl</filename>. 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. + 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" </para> - <para> - To accomplish this task, <filename>sendunsentbugmail.pl</filename> uses - the same mechanism as the <filename>sanitycheck.cgi</filename> script; - 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. + The index.html page has been updated to include the QuickSearch text box. </para> - <para> - 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. + 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. + </para> + <para> + 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". + </para> + <para> + Workarounds for Bugzilla users: + <simplelist> + <member>search for '!foo' (this will find only bugs with the keyword "foo"</member> + <member>search 'foo,!foo' (equivalent to 'foo OR keyword:foo')</member> + </simplelist> </para> - <para> - <emphasis>Usage</emphasis>: 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. + When this tool is ported from client-side JavaScript to server-side Perl, + the requirement for hard-coding keywords can be fixed. + <ulink url="http://bugzilla.mozilla.org/show_bug.cgi?id=70907">This bug</ulink> + has details. </para> </section> </appendix> - <!-- Keep this comment at the end of the file Local variables: mode: sgml -sgml-always-quote-attributes:t -sgml-auto-insert-required-elements:t -sgml-balanced-tag-edit:t -sgml-exposed-tags:nil +sgml-omittag:t +sgml-shorttag:t +sgml-namecase-general:t sgml-general-insert-case:lower -sgml-indent-data:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t sgml-indent-step:2 +sgml-indent-data:t +sgml-parent-document:nil +sgml-exposed-tags:nil sgml-local-catalogs:nil sgml-local-ecat-files:nil -sgml-minimize-attributes:nil -sgml-namecase-general:t -sgml-omittag:t -sgml-parent-document:("Bugzilla-Guide.xml" "book" "chapter") -sgml-shorttag:t -sgml-tag-region-if-active:t End: --> - |