summaryrefslogtreecommitdiffstats
path: root/docs/sgml/patches.sgml
diff options
context:
space:
mode:
authorbarnboy%trilobyte.net <>2001-08-11 07:13:47 +0200
committerbarnboy%trilobyte.net <>2001-08-11 07:13:47 +0200
commitd819eae3af3b13d4b6f17e818d449eaabe58ff9d (patch)
treef11bc5eca5232d01ab7b95a5f3a3ecd11217de30 /docs/sgml/patches.sgml
parent831030614c615d190a2a2c8b57d6c3b175628f56 (diff)
downloadbugzilla-d819eae3af3b13d4b6f17e818d449eaabe58ff9d.tar.gz
bugzilla-d819eae3af3b13d4b6f17e818d449eaabe58ff9d.tar.xz
Checkin for 2.14 release. Still some problems; this cannot yet
be used for 2.14 documentation due to inconsistencies.
Diffstat (limited to 'docs/sgml/patches.sgml')
-rw-r--r--docs/sgml/patches.sgml153
1 files changed, 77 insertions, 76 deletions
diff --git a/docs/sgml/patches.sgml b/docs/sgml/patches.sgml
index 8d7a72682..8ebfdee15 100644
--- a/docs/sgml/patches.sgml
+++ b/docs/sgml/patches.sgml
@@ -1,15 +1,14 @@
-<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN">
+<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
-<appendix id="patches">
+<appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
<title>Useful Patches and Utilities for Bugzilla</title>
-<section id="setperl">
+<section id="setperl" xreflabel="The setperl.csh Utility">
<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> 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>
@@ -28,18 +27,15 @@
</step>
<step>
<para>
- <computeroutput>
- <prompt>bash#</prompt>
- <command>wget -O setperl.csh 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=10795'</command>
- </computeroutput>
+ <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>
+ <computeroutput> <prompt>bash#</prompt> <command>chmod
+ u+x setperl.csh</command> </computeroutput>
</para>
</step>
</substeps>
@@ -59,10 +55,8 @@
</step>
<step>
<para>
- <computeroutput>
- <prompt>bash#</prompt>
- <command>chmod u+x duplicates.cgi</command>
- </computeroutput>
+ <computeroutput> <prompt>bash#</prompt> <command>chmod
+ u+x duplicates.cgi</command> </computeroutput>
</para>
</step>
<step>
@@ -80,16 +74,14 @@
Run the script:
</para>
<para>
- <computeroutput>
- <prompt>bash#</prompt>
+ <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> <prompt>bash#</prompt>
+ <command>./setperl.csh /usr/bin/perl</command>
</computeroutput>
</para>
</example>
@@ -101,22 +93,23 @@
<section id="cmdline">
<title>Command-line Bugzilla Queries</title>
<para>
- Users can query Bugzilla from the command line using
- this suite of utilities.
+ Users can query Bugzilla from the command line using this suite
+ of utilities.
</para>
<para>
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"
+ 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>
- 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=".
+ 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 columlist is taken from the COLUMNLIST environment variable.
@@ -128,10 +121,10 @@
<para>
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
- <command>sed -e 's/,/ /g' | wc | awk '{printf $2 "\n"}'</command>
+ "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 <command>sed -e 's/,/ /g' | wc |
+ awk '{printf $2 "\n"}'</command>
</para>
<para>
Akkana says she has good results piping buglist output through
@@ -145,26 +138,23 @@
<substeps>
<step>
<para>
- <computeroutput>
- <prompt>bash$</prompt>
- <command>wget -O query.conf 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26157'</command>
- </computeroutput>
+ <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>
+ <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>
+ <computeroutput> <prompt>bash#</prompt> <command>wget -O
+ bugs
+ 'http://bugzilla.mozilla.org/showattachment.cgi?attach_id=26215'</command> </computeroutput>
</para>
</step>
</substeps>
@@ -185,53 +175,64 @@
<title>The Quicksearch Utility</title>
<para>
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"
+ It consist of two Javascript files, "quicksearch.js" and
+ "localconfig.js", and two documentation files,
+ "quicksearch.html" and "quicksearchhack.html"
</para>
<para>
- The index.html page has been updated to include the QuickSearch text box.
+ The index.html page has been updated to include the QuickSearch
+ text box.
</para>
<para>
- 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.
+ 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".
+ 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>
+ <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>
- 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.
+ 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-omittag:t
-sgml-shorttag:t
-sgml-namecase-general:t
-sgml-general-insert-case:lower
-sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
-sgml-indent-step:2
-sgml-indent-data:t
-sgml-parent-document:nil
+sgml-auto-insert-required-elements:t
+sgml-balanced-tag-edit:t
sgml-exposed-tags:nil
+sgml-general-insert-case:lower
+sgml-indent-data:t
+sgml-indent-step:2
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.sgml" "book" "chapter")
+sgml-shorttag:t
+sgml-tag-region-if-active:t
End:
-->