Skip to content

bugzilla
bugzilla
Commit 164b989e authored by mozilla%colinogilvie.co.uk's avatar mozilla%colinogilvie.co.uk
Browse files
Options

Bug 232378: switch from entities to XIncludes for inclusion of modular docs files

Patch by Colin Ogilvie <colin.ogilvie@gmail.com>; r=vladd
parent 6e7c6391
Expand all Show whitespace changes
Inline Side-by-side
Showing with 372 additions and 257 deletions
docs/en/xml/Bugzilla-Guide.xml
View file @ 164b989e
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" [
<!-- Include macros -->
<!ENTITY about SYSTEM "about.xml">
<!ENTITY conventions SYSTEM "conventions.xml">
<!ENTITY doc-index SYSTEM "index.xml">
<!ENTITY faq SYSTEM "faq.xml">
<!ENTITY gfdl SYSTEM "gfdl.xml">
<!ENTITY glossary SYSTEM "glossary.xml">
<!ENTITY installation SYSTEM "installation.xml">
<!ENTITY administration SYSTEM "administration.xml">
<!ENTITY using SYSTEM "using.xml">
<!ENTITY integration SYSTEM "integration.xml">
<!ENTITY index SYSTEM "index.xml">
<!ENTITY customization SYSTEM "customization.xml">
<!ENTITY patches SYSTEM "patches.xml">
<!ENTITY introduction SYSTEM "introduction.xml">
<!ENTITY modules SYSTEM "modules.xml">
<?xml version="1.0"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<!-- Things to change for a stable release:
* bz-ver to current stable
* bz-nexver to next stable
* bz-date to the release date
* bz-devel to "IGNORE"
* Remove the BZ-DEVEL comments
- COMPILE DOCS AND CHECKIN -
Also, tag and tarball before completing
* bz-ver to devel version
* bz-devel to "INCLUDE"
For a devel release, simple bump bz-ver and bz-date
-->
<!ENTITY bz-ver "2.18rc1">
<!ENTITY bz-nextver "2.18">
<!ENTITY bz-date "2004-07-10">
<!ENTITY % bz-devel "IGNORE">
<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-2.18-branch/">
<!ENTITY bz "http://www.bugzilla.org/">
<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>">
<!ENTITY mysql "http://www.mysql.com/">
<!ENTITY newest-perl-ver "5.8.3">
<!-- For minimum versions -->
<!ENTITY min-mysql-ver "3.23.41">
<!ENTITY min-perl-ver "5.6.0">
<!ENTITY min-template-ver "2.08">
<!ENTITY min-file-temp-ver "any">
<!ENTITY min-appconfig-ver "1.52">
<!ENTITY min-text-wrap-ver "2001.0131">
<!ENTITY min-file-spec-ver "0.82">
<!ENTITY min-data-dumper-ver "any">
<!ENTITY min-dbd-mysql-ver "2.1010">
<!ENTITY min-dbi-ver "1.32">
<!ENTITY min-date-format-ver "2.21">
<!ENTITY min-cgi-ver "2.93">
<!-- Optional modules -->
<!ENTITY min-gd-ver "1.20">
<!ENTITY min-gd-graph-ver "any">
<!ENTITY min-gd-text-align-ver "any">
<!ENTITY min-chart-base-ver "1.0">
<!ENTITY min-xml-parser-ver "any">
<!ENTITY min-mime-parser-ver "any">
<!ENTITY min-patchreader-ver "0.9.4">
]>
<!-- Coding standards for this document
......@@ -94,7 +46,8 @@
<bookinfo>
<title>The Bugzilla Guide - &bz-ver;
<![%bz-devel;[Development ]]>Release</title>
<!-- BZ-DEVEL -->Development <!-- /BZ-DEVEL -->
Release</title>
<authorgroup>
<corpauthor>The Bugzilla Team</corpauthor>
......@@ -133,37 +86,43 @@
</bookinfo>
<!-- About This Guide -->
&about;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="about.xml" />
<!-- Installing Bugzilla -->
&installation;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="installation.xml" />
<!-- Administering Bugzilla -->
&administration;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="administration.xml" />
<!-- Securing Bugzilla -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security.xml" />
<!-- Customizing Bugzilla -->
&customization;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="customization.xml" />
<!-- Using Bugzilla -->
&using;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="using.xml" />
<!-- Appendix: The Frequently Asked Questions -->
&faq;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="faq.xml" />
<!-- Appendix: Troubleshooting -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" />
<!-- Appendix: Custom Patches -->
&patches;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="patches.xml" />
<!-- Appendix: Manually Installing Perl Modules -->
&modules;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules.xml" />
<!-- Appendix: GNU Free Documentation License -->
&gfdl;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gfdl.xml" />
<!-- Glossary -->
&glossary;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="glossary.xml" />
<!-- Index -->
&index;
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="index.xml" />
</book>
......@@ -188,3 +147,4 @@ sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
docs/en/xml/about.xml
View file @ 164b989e
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
<!ENTITY conventions SYSTEM "conventions.sgml"> ] > -->
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<chapter id="about">
<title>About This Guide</title>
<section id="copyright">
<title>Copyright Information</title>
<para>This document is copyright (c) 2000-&current-year; by the various
Bugzilla contributors who wrote it.</para>
<blockquote>
<attribution>Copyright (c) 2000-2003 Matthew P. Barnson and &bzg-auth;</attribution>
<para>
Permission is granted to copy, distribute and/or modify this
document under the terms of the GNU Free Documentation
......@@ -20,7 +27,7 @@
<para>
If you have any questions regarding this document, its
copyright, or publishing this document in non-electronic form,
please contact &bzg-auth;.
please contact the Bugzilla Team.
</para>
</section>
......@@ -28,7 +35,7 @@
<title>Disclaimer</title>
<para>
No liability for the contents of this document can be accepted.
Use the concepts, examples, and other content at your own risk.
Follow the instructions herein at your own risk.
This document may contain errors
and inaccuracies that may damage your system, cause your partner
to leave you, your boss to fire you, your cats to
......@@ -36,35 +43,20 @@
war. Proceed with caution.
</para>
<para>
All copyrights are held by their respective owners, unless
specifically noted otherwise. Use of a term in this document
should not be regarded as affecting the validity of any
trademark or service mark.
</para>
<para>
Naming of particular products or brands should not be seen as
endorsements, with the exception of the term "GNU/Linux". We
wholeheartedly endorse the use of GNU/Linux in every situation
where it is appropriate. It is an extremely versatile, stable,
wholeheartedly endorse the use of GNU/Linux; it is an extremely
versatile, stable,
and robust operating system that offers an ideal operating
environment for Bugzilla.
</para>
<para>
You are strongly recommended to make a backup of your system
before installing Bugzilla and at regular intervals thereafter.
If you implement any suggestion in this Guide, implement this one!
</para>
<para>
Although the Bugzilla development team has taken great care to
ensure that all easily-exploitable bugs or options are
documented or fixed in the code, security holes surely exist.
Great care should be taken both in the installation and usage of
this software. Carefully consider the implications of installing
other network services with Bugzilla. The Bugzilla development
team members, Netscape Communications, America Online Inc., and
any affiliated developers or sponsors assume no liability for
your use of this product. You have the source code to this
product, and are responsible for auditing it yourself to ensure
ensure that all exploitable bugs have been fixed, security holes surely
exist in any piece of code. Great care should be taken both in
the installation and usage of this software. The Bugzilla development
team members assume no liability for your use of Bugzilla. You have
the source code, and are responsible for auditing it yourself to ensure
your security needs are met.
</para>
</section>
......@@ -76,36 +68,41 @@
<para>
This is the &bz-ver; version of The Bugzilla Guide. It is so named
to match the current version of Bugzilla.
<![%bz-devel;[
This version of the guide, like its associated Bugzilla version is a
development version. Information is subject to change between now and
when &bz-nextver; is released.
]]>
If you are
reading this from any source other than those below, please
check one of these mirrors to make sure you are reading an
up-to-date version of the Guide.
<!-- BZ-DEVEL --> This version of the guide, like its associated Bugzilla version, is a
development version.<!-- /BZ-DEVEL -->
</para>
<para>
The newest version of this guide can always be found at <ulink
url="http://www.bugzilla.org">bugzilla.org</ulink>; including
documentation for past releases and the current development version.
The latest version of this guide can always be found at <ulink
url="http://www.bugzilla.org"/>, or checked out via CVS by
following the <ulink url="http://www.mozilla.org/cvs.html">Mozilla
CVS</ulink> instructions and check out the
<filename>mozilla/webtools/bugzilla/docs/</filename>
subtree. However, you should read the version
which came with the Bugzilla release you are using.
</para>
<para>
The documentation for the most recent stable release of Bugzilla can also
be found at
<ulink url="http://www.tldp.org">The Linux Documentation Project</ulink>.
The Bugzilla Guide, or a section of it, is also available in
the following languages:
<ulink url="http://bugzilla-de.sourceforge.net/docs/html/">German</ulink>.
</para>
<para>
The latest version of this document can always be checked out via CVS.
Please follow the instructions available at
<ulink url="http://www.mozilla.org/cvs.html">the Mozilla CVS page</ulink>,
and check out the <filename>mozilla/webtools/bugzilla/docs/</filename>
subtree.
In addition, there are Bugzilla template localisation projects in
the following languages. They may have translated documentation
available:
<ulink url="http://sourceforge.net/projects/bugzilla-be/">Belarusian</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-br/">Brazilian Portuguese</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-cn/">Chinese</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-fr/">French</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-de/">German</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-kr/">Korean</ulink>,
<ulink url="http://sourceforge.net/projects/bugzilla-ru/">Russian</ulink> and
<ulink url="http://sourceforge.net/projects/bugzilla-es/">Spanish</ulink>.
</para>
<para>
The Bugzilla Guide is currently only available in English.
If you would like to volunteer to translate it, please contact
If you would like to volunteer to translate the Guide into additional
languages, please contact
<ulink url="mailto:justdave@syndicomm.com">Dave Miller</ulink>.
</para>
</section>
......@@ -152,8 +149,7 @@
<term>Dave Lawrence <email>dkl@redhat.com</email></term>
<listitem>
<para>for providing insight into the key differences between Red
Hat's customized Bugzilla, and being largely responsible for
<xref linkend="varient-redhat"/>.
Hat's customized Bugzilla.
</para>
</listitem>
</varlistentry>
......@@ -176,35 +172,49 @@
</listitem>
</varlistentry>
<varlistentry>
<term>Dave Miller <email>justdave@bugzilla.org</email></term>
<listitem>
<para>for taking over as project lead when Tara stepped down and
continually pushing for the documentation to be the best it can be.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Last but not least, all the members of the
<ulink url="news://news.mozilla.org/netscape/public/mozilla/webtools"/>
newsgroup. Without your discussions, insight, suggestions, and patches,
this could never have happened.
</para>
<para>
Thanks also go to the following people for significant contributions
to this documentation (in alphabetical order):
to this documentation:
<simplelist type="inline">
<member>Andrew Pearson</member>
<member>Kevin Brannen</member>
<member>Vlad Dascalu</member>
<member>Ben FrantzDale</member>
<member>Eric Hanson</member>
<member>Zach Lipton</member>
<member>Gervase Markham</member>
<member>Andrew Pearson</member>
<member>Joe Robins</member>
<member>Kevin Brannen</member>
<member>Ron Teitelbaum</member>
<member>Spencer Smith</member>
<member>Zach Liption</member>
</simplelist>
.
<member>Ron Teitelbaum</member>
<member>Shane Travis</member>
<member>Martin Wulffeld</member>
</simplelist>.
</para>
<para>
Also, thanks are due to the members of the
<ulink url="news://news.mozilla.org/netscape.public.mozilla.webtools">
netscape.public.mozilla.webtools</ulink>
newsgroup. Without your discussions, insight, suggestions, and patches,
this could never have happened.
</para>
</section>
<!-- conventions used here (didn't want to give it a chapter of its own) -->
&conventions;
</chapter>
<!-- conventions used here (didn't want to give it a chapter of its own) -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="conventions.xml" />
</chapter>
<!-- Keep this comment at the end of the file
Local variables:
......@@ -221,7 +231,8 @@ 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-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End: -->
docs/en/xml/administration.xml
View file @ 164b989e
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<chapter id="administration">
<title>Administering Bugzilla</title>
......@@ -82,6 +88,22 @@
<varlistentry>
<term>
maildeliverymethod
</term>
<listitem>
<para>
This is used to specify how email is sent, or if it is sent at
all. There are several options included for different MTAs,
along with two additional options that disable email sending.
"testfile" does not send mail, but instead saves it in
<filename>data/mailer.testfile</filename> for later review.
"none" disables email sending entirely.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
shadowdb
</term>
<listitem>
......@@ -193,7 +215,7 @@
<listitem>
<para>
This allows you to define an email address for each component,
in addition to that of the default owner, who will be sent
in addition to that of the default assignee, who will be sent
carbon copies of incoming bugs.
</para>
</listitem>
......@@ -520,6 +542,46 @@
</listitem>
</itemizedlist>
</section>
<section id="impersonatingusers">
<title>Impersonating Users</title>
<para>
There may be times when an administrator would like to do something as
another user. The <command>sudo</command> feature may be used to do
this.
</para>
<note>
<para>
To use the sudo feature, you must be in the
<emphasis>bz_sudoers</emphasis> group. By default, all
administrators are in this group.</para>
</note>
<para>
If you have access to this feature, you may start a session by
going to the Edit Users page, Searching for a user and clicking on
their login. You should see a link below their login name titled
"Impersonate this user". Click on the link. This will take you
to a page where you will see a description of the feature and
instructions for using it. After reading the text, simply
enter the login of the user you would like to impersonate, provide
a short message explaining why you are doing this, and press the
button.</para>
<para>
As long as you are using this feature, everything you do will be done
as if you were logged in as the user you are impersonating.</para>
<warning>
<para>
The user you are impersonating will not be told about what you are
doing. If you do anything that results in mail being sent, that
mail will appear to be from the user you are impersonating. You
should be extremely careful while using this feature.</para>
</warning>
</section>
</section>
</section>
......@@ -580,12 +642,12 @@
company.</para>
<para>
Each component has a owner and (if you turned it on in the parameters),
a QA Contact. The owner should be the primary person who fixes bugs in
Each component has a default assignee and (if you turned it on in the parameters),
a QA Contact. The default assignee should be the primary person who fixes bugs in
that component. The QA Contact should be the person who will ensure
these bugs are completely fixed. The Owner, QA Contact, and Reporter
these bugs are completely fixed. The Assignee, QA Contact, and Reporter
will get email when new bugs are created in this Component and when
these bugs change. Default Owner and Default QA Contact fields only
these bugs change. Default Assignee and Default QA Contact fields only
dictate the
<emphasis>default assignments</emphasis>;
these can be changed on bug submission, or at any later point in
......@@ -605,9 +667,9 @@
<listitem>
<para>Fill out the "Component" field, a short "Description",
the "Initial Owner" and "Initial QA Contact" (if enabled.)
the "Default Assignee" and "Default QA Contact" (if enabled.)
The Component and Description fields may contain HTML;
the "Initial Owner" field must be a login name
the "Default Assignee" field must be a login name
already existing in the database.
</para>
</listitem>
......@@ -672,7 +734,7 @@
<listitem>
<para>Enter the name of the Milestone in the "Milestone" field. You
can optionally set the "sortkey", which is a positive or negative
number (-255 to 255) that defines where in the list this particular
number (-32768 to 32767) that defines where in the list this particular
milestone appears. This is because milestones often do not
occur in alphanumeric order For example, "Future" might be
after "Release 1.2". Select "Add".</para>
......@@ -874,7 +936,7 @@
</para>
<para>
Only users with the ability to edit the bug may
set flags on bugs. This includes the owner, reporter, and
set flags on bugs. This includes the assignee, reporter, and
any user with the <computeroutput>editbugs</computeroutput>
permission.
</para>
......@@ -902,7 +964,7 @@
<para>
When you click on the <quote>Create a Flag Type for...</quote>
link, you will be presented with a form. Here is what the felds in
link, you will be presented with a form. Here is what the fields in
the form mean:
</para>
......@@ -919,7 +981,7 @@
<title>Description</title>
<para>
This describes the flag in more detail. At present, this doesn't
whos up anywhere helpful; ideally, it would be nice to have
show up anywhere helpful; ideally, it would be nice to have
it show up as a tooltip. This field
can be as long as you like, and can contain any character you want.
</para>
......@@ -1255,7 +1317,9 @@
resulted in a user acquiring permanent membership in a group.
To remove a user from a group the user was in due to a regular
expression in version 2.16 or earlier, the user must be explicitly
removed from the group.</para>
removed from the group. This can easily be done by pressing
buttons named 'Remove Memberships' or 'Remove Memberships
included in regular expression' under the table.</para>
</note>
<warning>
<para>If specifying a domain in the regexp, make sure you end
......@@ -1354,7 +1418,7 @@
</orderedlist>
<para>These controls are often described in this order, so a
product that requires a user to be a member of group "foo"
to enter a bug and then requires that the bug stay resticted
to enter a bug and then requires that the bug stay restricted
to group "foo" at all times and that only members of group "foo"
can edit the bug even if they otherwise could see the bug would
have its controls summarized by...</para>
......
docs/en/xml/conventions.xml
View file @ 164b989e
<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<?xml version="1.0"?>
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<section id="conventions">
<title>Document Conventions</title>
......@@ -6,7 +12,7 @@
<primary>conventions</primary>
</indexterm>
<para>This document uses the following conventions</para>
<para>This document uses the following conventions:</para>
<informaltable frame="none">
<tgroup cols="2">
......@@ -20,7 +26,7 @@
<tbody>
<row>
<entry>Warnings</entry>
<entry>Warning</entry>
<entry>
<caution>
......@@ -34,13 +40,13 @@
<entry>
<tip>
<para>Warm jar lids under the hot tap to loosen them.</para>
<para>Would you like a breath mint?</para>
</tip>
</entry>
</row>
<row>
<entry>Notes</entry>
<entry>Note</entry>
<entry>
<note>
......@@ -60,23 +66,15 @@
</row>
<row>
<entry>File Names</entry>
<entry>
<filename>file.extension</filename>
</entry>
</row>
<row>
<entry>Directory Names</entry>
<entry>File or directory name</entry>
<entry>
<filename class="directory">directory</filename>
<filename>filename</filename>
</entry>
</row>
<row>
<entry>Commands to be typed</entry>
<entry>Command to be typed</entry>
<entry>
<command>command</command>
......@@ -84,7 +82,7 @@
</row>
<row>
<entry>Applications Names</entry>
<entry>Application name</entry>
<entry>
<application>application</application>
......@@ -93,33 +91,27 @@
<row>
<entry>
<foreignphrase>Prompt</foreignphrase>
of users command under bash shell</entry>
Normal user's prompt under bash shell</entry>
<entry>bash$</entry>
</row>
<row>
<entry>
<foreignphrase>Prompt</foreignphrase>
of root users command under bash shell</entry>
Root user's prompt under bash shell</entry>
<entry>bash#</entry>
</row>
<row>
<entry>
<foreignphrase>Prompt</foreignphrase>
of user command under tcsh shell</entry>
Normal user's prompt under tcsh shell</entry>
<entry>tcsh$</entry>
</row>
<row>
<entry>Environment Variables</entry>
<entry>Environment variables</entry>
<entry>
<envar>VARIABLE</envar>
......@@ -127,28 +119,32 @@
</row>
<row>
<entry>Emphasized word</entry>
<entry>Term found in the glossary</entry>
<entry>
<emphasis>word</emphasis>
<glossterm linkend="gloss-bugzilla">Bugzilla</glossterm>
</entry>
</row>
<row>
<entry>Code Example</entry>
<entry>Code example</entry>
<entry>
<programlisting>
<sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag>
</programlisting>
<programlisting><sgmltag class="starttag">para</sgmltag>
Beginning and end of paragraph
<sgmltag class="endtag">para</sgmltag></programlisting>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<para>
This documentation is maintained in DocBook 4.1.2 XML format.
Changes are best submitted as plain text or XML diffs, attached
to a bug filed in the &bzg-bugs; component.
</para>
</section>
<!-- Keep this comment at the end of the file
......@@ -166,7 +162,7 @@ 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-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
......
docs/en/xml/customization.xml
View file @ 164b989e
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<chapter id="customization">
<title>Customising Bugzilla</title>
......@@ -153,7 +159,7 @@
to properly HTML filter data that has been passed into the template.
This means that if the data can possibly contain special HTML characters
such as &lt;, and the data was not intended to be HTML, they need to be
converted to entity form, ie &amp;lt;. You use the 'html' filter in the
converted to entity form, i.e. &amp;lt;. You use the 'html' filter in the
Template Toolkit to do this. If you forget, you may open up
your installation to cross-site scripting attacks.
</para>
......@@ -162,7 +168,7 @@
Also note that Bugzilla adds a few filters of its own, that are not
in standard Template Toolkit. In particular, the 'url_quote' filter
can convert characters that are illegal or have special meaning in URLs,
such as &amp;, to the encoded form, ie %26. This actually encodes most
such as &amp;, to the encoded form, i.e. %26. This actually encodes most
characters (but not the common ones such as letters and numbers and so
on), including the HTML-special characters, so there's never a need to
HTML filter afterwards.
......@@ -202,7 +208,7 @@
<para>
To see if a CGI supports multiple output formats and types, grep the
CGI for <quote>GetFormat</quote>. If it's not present, adding
CGI for <quote>get_format</quote>. If it's not present, adding
multiple format/type support isn't too hard - see how it's done in
other CGIs, e.g. config.cgi.
</para>
......@@ -1093,8 +1099,8 @@ this. But you need to know this stuff anyway, right?
</section>
</section>
<!-- Integrating Bugzilla with Third-Party Tools -->
&integration;
<!-- Integrating Bugzilla with Third-Party Tools -->
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="integration.xml" />
</chapter>
......
docs/en/xml/gfdl.xml
View file @ 164b989e
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<appendix id="gfdl">
<title>GNU Free Documentation License</title>
......@@ -16,7 +22,7 @@
</blockquote>
<section label="0" id="gfdl-0">
<title>PREAMBLE</title>
<title>Preamble</title>
<para>The purpose of this License is to make a manual, textbook, or other
written document "free" in the sense of freedom: to assure everyone the
......@@ -41,7 +47,7 @@
</section>
<section label="1" id="gfdl-1">
<title>APPLICABILITY AND DEFINITIONS</title>
<title>Applicability and Definition</title>
<para>This License applies to any manual or other work that contains a
notice placed by the copyright holder saying it can be distributed under
......@@ -101,7 +107,7 @@
</section>
<section label="2" id="gfdl-2">
<title>VERBATIM COPYING</title>
<title>Verbatim Copying</title>
<para>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
......@@ -118,7 +124,7 @@
</section>
<section label="3" id="gfdl-3">
<title>COPYING IN QUANTITY</title>
<title>Copying in Quantity</title>
<para>If you publish printed copies of the Document numbering more than
100, and the Document's license notice requires Cover Texts, you must
......@@ -157,7 +163,7 @@
</section>
<section label="4" id="gfdl-4">
<title>MODIFICATIONS</title>
<title>Modifications</title>
<para>You may copy and distribute a Modified Version of the Document
under the conditions of sections 2 and 3 above, provided that you release
......@@ -287,7 +293,7 @@
</section>
<section label="5" id="gfdl-5">
<title>COMBINING DOCUMENTS</title>
<title>Combining Documents</title>
<para>You may combine the Document with other documents released under
this License, under the terms defined in section 4 above for modified
......@@ -313,7 +319,7 @@
</section>
<section label="6" id="gfdl-6">
<title>COLLECTIONS OF DOCUMENTS</title>
<title>Collections of Documents</title>
<para>You may make a collection consisting of the Document and other
documents released under this License, and replace the individual copies
......@@ -329,7 +335,7 @@
</section>
<section label="7" id="gfdl-7">
<title>AGGREGATION WITH INDEPENDENT WORKS</title>
<title>Aggregation with Independent Works</title>
<para>A compilation of the Document or its derivatives with other
separate and independent documents or works, in or on a volume of a
......@@ -348,7 +354,7 @@
</section>
<section label="8" id="gfdl-8">
<title>TRANSLATION</title>
<title>Translation</title>
<para>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
......@@ -363,7 +369,7 @@
</section>
<section label="9" id="gfdl-9">
<title>TERMINATION</title>
<title>Termination</title>
<para>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided for under this License. Any other attempt to
......@@ -375,16 +381,13 @@
</section>
<section label="10" id="gfdl-10">
<title>FUTURE REVISIONS OF THIS LICENSE</title>
<title>Future Revisions of this License</title>
<para>The Free Software Foundation may publish new, revised versions of
the GNU Free Documentation License from time to time. Such new versions
will be similar in spirit to the present version, but may differ in
detail to address new problems or concerns. See
<ulink url="http://www.gnu.org/copyleft/">
http://www.gnu.org/copyleft/</ulink>
.</para>
<ulink url="http://www.gnu.org/copyleft/"/>.</para>
<para>Each version of the License is given a distinguishing version
number. If the Document specifies that a particular numbered version of
......@@ -440,7 +443,7 @@ 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-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
......
docs/en/xml/glossary.xml
View file @ 164b989e
<!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
<?xml version="1.0"?>
<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<glossary id="glossary">
<glossdiv>
<title>0-9, high ascii</title>
......@@ -269,10 +275,11 @@
<glossdef>
<para>A Message Transport Agent is used to control the flow of email
on a system. Many unix based systems use
<ulink url="http://www.sendmail.org">sendmail</ulink> which is what
Bugzilla expects to find by default at <filename>/usr/sbin/sendmail</filename>.
Many other MTA's will work, but they all require that the
on a system. The <ulink url="http://search.cpan.org/dist/MailTools/Mail/Mailer.pm">Mail::Mailer</ulink>
Perl module, which Bugzilla uses to send email, can be configured to
use many different underlying implementations for actually sending the
mail using the <option>mail_delivery_method</option> parameter.
Implementations other than <literal>sendmail</literal> require that the
<option>sendmailnow</option> param be set to <literal>on</literal>.
</para>
</glossdef>
......
docs/en/xml/index.xml
View file @ 164b989e
......@@ -13,9 +13,8 @@ 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-parent-document:("Bugzilla-Guide.xml" "book" "chapter")
sgml-shorttag:t
sgml-tag-region-if-active:t
End:
-->
docs/en/xml/installation.xml
View file @ 164b989e
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: installation.xml,v 1.107 2008/04/04 06:47:37 mozilla%colinogilvie.co.uk Exp $ -->
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<chapter id="installing-bugzilla">
<title>Installing Bugzilla</title>
......
docs/en/xml/modules.xml
View file @ 164b989e
<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<appendix id="install-perlmodules-manual">
<title>Manual Installation of Perl Modules</title>
......
docs/en/xml/security.xml
View file @ 164b989e
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: security.xml,v 1.6 2008/04/04 06:48:13 zach%zachlipton.com Exp $ -->
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<chapter id="security">
<title>Bugzilla Security</title>
......@@ -207,14 +211,6 @@ skip-networking
</simplelist>
</para>
</listitem>
<listitem>
<para>But allow:
<simplelist type="inline">
<member><filename>localconfig.js</filename></member>
<member><filename>localconfig.rdf</filename></member>
</simplelist>
</para>
</listitem>
</itemizedlist>
</listitem>
......@@ -360,28 +356,25 @@ skip-networking
<section id="security-bugzilla-charset">
<title>Prevent users injecting malicious Javascript</title>
<para>It is possible for a Bugzilla user to take advantage of character
set encoding ambiguities to inject HTML into Bugzilla comments. This
could include malicious scripts.
Due to internationalization concerns, we are unable to
incorporate by default the code changes suggested by
<para>If you installed Bugzilla version 2.22 or later from scratch,
then the <emphasis>utf8</emphasis> parameter is switched on by default.
This makes Bugzilla explicitly set the character encoding, following
<ulink
url="http://www.cert.org/tech_tips/malicious_code_mitigation.html#3">the
CERT advisory</ulink> on this issue.
Making the change in <xref linkend="security-bugzilla-charset-ex"/> will
prevent this problem.
url="http://www.cert.org/tech_tips/malicious_code_mitigation.html#3">a
CERT advisory</ulink> recommending exactly this.
The following therefore does not apply to you; just keep
<emphasis>utf8</emphasis> turned on.
</para>
<example id="security-bugzilla-charset-ex">
<title>Forcing Bugzilla to output a charset</title>
<para>Locate the following line in
<filename>Bugzilla/CGI.pm</filename>:
<programlisting>$self->charset('');</programlisting>
and change it to:
<programlisting>$self->charset('UTF-8');</programlisting>
<para>If you've upgraded from an older version, then it may be possible
for a Bugzilla user to take advantage of character set encoding
ambiguities to inject HTML into Bugzilla comments.
This could include malicious scripts.
This is because due to internationalization concerns, we are unable to
turn the <emphasis>utf8</emphasis> parameter on by default for upgraded
installations.
Turning it on manually will prevent this problem.
</para>
</example>
</section>
</section>
......
docs/en/xml/troubleshooting.xml
View file @ 164b989e
<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
<!-- $Id: troubleshooting.xml,v 1.1 2008/04/03 19:05:43 lpsolit%gmail.com Exp $ -->
<?xml version="1.0"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
<!ENTITY % myents SYSTEM "bugzilla.ent">
%myents;
]>
<appendix id="troubleshooting">
<title>Troubleshooting</title>
......@@ -15,14 +19,14 @@
completion, it normally explains what's wrong and how to fix it.
If you can't work it out, or if it's being uncommunicative, post
the errors in the
<ulink url="news://news.mozilla.org/mozilla.support.bugzilla">mozilla.support.bugzilla</ulink>
<ulink url="news://news.mozilla.org/netscape.public.mozilla.webtools">netscape.public.mozilla.webtools</ulink>
newsgroup.
</para>
<para>If you have made it all the way through
<xref linkend="installation"/> (Installation) and
<xref linkend="configuration"/> (Configuration) but accessing the Bugzilla
URL doesn't work, the first thing to do is to check your web server error
URL doesn't work, the first thing to do is to check your webserver error
log. For Apache, this is often located at
<filename>/etc/logs/httpd/error_log</filename>. The error messages
you see may be self-explanatory enough to enable you to diagnose and
......@@ -32,7 +36,7 @@
<para>
Bugzilla can also log all user-based errors (and many code-based errors)
that occur, without polluting the web server's error log. To enable
that occur, without polluting the web server error log. To enable
Bugzilla error logging, create a file that Bugzilla can write to, named
<filename>errorlog</filename>, in the Bugzilla <filename>data</filename>
directory. Errors will be logged as they occur, and will include the type
......@@ -45,10 +49,10 @@
</section>
<section id="trbl-testserver">
<title>The Apache web server is not serving Bugzilla pages</title>
<title>The Apache webserver is not serving Bugzilla pages</title>
<para>After you have run <command>checksetup.pl</command> twice,
run <command>testserver.pl http://yoursite.yourdomain/yoururl</command>
to confirm that your web server is configured properly for
to confirm that your webserver is configured properly for
Bugzilla.
</para>
<programlisting>
......@@ -76,13 +80,31 @@ TEST-OK Webserver is preventing fetch of http://landfill.bugzilla.org/bugzilla-t
</listitem>
<listitem>
<para>The permissions on your library directories are set incorrectly.
They must, at the very least, be readable by the web server user or
They must, at the very least, be readable by the webserver user or
group. It is recommended that they be world readable.
</para>
</listitem>
</orderedlist>
</section>
<section id="trbl-bundleBugzilla">
<title>Bundle::Bugzilla makes me upgrade to Perl 5.6.1</title>
<para>Try executing <command>perl -MCPAN -e 'install CPAN'</command>
and then continuing.
</para>
<para>Certain older versions of the CPAN toolset were somewhat naive about
how to upgrade Perl modules. When a couple of modules got rolled into the
core Perl distribution for 5.6.1, CPAN thought that the best way to get
those modules up to date was to haul down the Perl distribution itself and
build it. Needless to say, this has caused headaches for just about
everybody. Upgrading to a newer version of CPAN with the
commandline above should fix things.
</para>
</section>
<section id="trbl-dbdSponge">
<title>DBD::Sponge::db prepare failed</title>
......@@ -139,12 +161,55 @@ TEST-OK Webserver is preventing fetch of http://landfill.bugzilla.org/bugzilla-t
</para>
</section>
<section id="trouble-filetemp">
<title>Your vendor has not defined Fcntl macro O_NOINHERIT</title>
<para>This is caused by a bug in the version of
<productname>File::Temp</productname> that is distributed with perl
5.6.0. Many minor variations of this error have been reported:
</para>
<programlisting>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.</programlisting>
<para>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 following patch, which is also
available as a <ulink url="../xml/filetemp.patch">patch file</ulink>.
</para>
<programlisting><![CDATA[--- 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;
};]]></programlisting>
</section>
<section id="trbl-relogin-everyone">
<title>Everybody is constantly being forced to relogin</title>
<para>The most-likely cause is that the <quote>cookiepath</quote> parameter
is not set correctly in the Bugzilla configuration. You can change this (if
you're a Bugzilla administrator) from the editparams.cgi page via the web interface.
you're a Bugzilla administrator) from the editparams.cgi page via the web.
</para>
<para>The value of the cookiepath parameter should be the actual directory
......@@ -213,7 +278,7 @@ TEST-OK Webserver is preventing fetch of http://landfill.bugzilla.org/bugzilla-t
</para>
</section>
<section id="trbl-relogin-some">
<section>
<title>Some users are constantly being forced to relogin</title>
<para>First, make sure cookies are enabled in the user's browser.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment