Skip to content

bugzilla
bugzilla
Commit 1f815b55 authored by Gervase Markham's avatar Gervase Markham Committed by Gervase Markham
Browse files
Options

Fix problem of variables not being replaced in RTD documentation by removing…

Fix problem of variables not being replaced in RTD documentation by removing references to them. r=LpSolit, a=justdave. https://bugzilla.mozilla.org/show_bug.cgi?id=964849
parent d05bbe56
Hide whitespace changes
Inline Side-by-side
Showing with 39 additions and 213 deletions
.bzrignore
View file @ 1f815b55
.htaccess
/lib/*
/template/en/custom
/docs/definitions.rst
/docs/en/html
/docs/en/txt
/docs/en/latex
......
docs/definitions.rst.tmpl deleted 100644 → 0
View file @ d05bbe56
.. |min-perl-ver| replace:: 5.10.1
docs/en/rst/conf.py
View file @ 1f815b55
......@@ -258,10 +258,10 @@ texinfo_documents = [
# How to display URL addresses: 'footnote', 'no', or 'inline'.
#texinfo_show_urls = 'footnote'
definitions = "../../definitions.rst"
if os.path.exists(definitions):
execfile(definitions)
# Global substitutions and other markup required in every page
rst_epilog = """
.. |min-perl-ver| replace:: 5.10.1
"""
# -- Options for PDF output --------------------------------------------------
......
docs/en/rst/installation.rst
View file @ 1f815b55
......@@ -215,14 +215,12 @@ The list of required modules is reasonably long; however, you
may already have several of them installed.
The preferred way to install missing Perl modules is to use the package
manager provided by your operating system (e.g ``rpm`` or
manager provided by your operating system (e.g ``rpm``, ``apt-get`` or
``yum`` on Linux distros, or ``ppm`` on Windows
if using ActivePerl, see :ref:`win32-perl-modules`).
If some Perl modules are still missing or are too old, then we recommend
using the :file:`install-module.pl` script (doesn't work
with ActivePerl on Windows). If for some reason you really need to
install the Perl modules manually, see
:ref:`install-perlmodules-manual`. For instance, on Unix,
with ActivePerl on Windows). For instance, on Unix,
you invoke :file:`install-module.pl` as follows:
::
......@@ -248,93 +246,8 @@ you invoke :file:`install-module.pl` as follows:
these packages will vary depending on the specific distribution you are using,
but are often called :file:`<packagename>-devel`.
Here is a complete list of modules and their minimum versions.
Some modules have special installation notes, which follow.
Required Perl modules:
#. CGI (|min-cgi-ver|)
#. Date::Format (|min-date-format-ver|)
#. DateTime (|min-datetime-ver|)
#. DateTime::TimeZone (|min-datetime-timezone-ver|)
#. DBI (|min-dbi-ver|)
#. DBD::mysql (|min-dbd-mysql-ver|) if using MySQL
#. DBD::Pg (|min-dbd-pg-ver|) if using PostgreSQL
#. DBD::Oracle (|min-dbd-oracle-ver|) if using Oracle
#. Digest::SHA (|min-digest-sha-ver|)
#. Email::Send (|min-email-send-ver|)
#. Email::MIME (|min-email-mime-ver|)
#. Template (|min-template-ver|)
#. URI (|min-uri-ver|)
Optional Perl modules:
#. GD (|min-gd-ver|) for bug charting
#. Template::Plugin::GD::Image
(|min-template-plugin-gd-image-ver|) for Graphical Reports
#. Chart::Lines (|min-chart-lines-ver|) for bug charting
#. GD::Graph (|min-gd-graph-ver|) for bug charting
#. GD::Text (|min-gd-text-ver|) for bug charting
#. XML::Twig (|min-xml-twig-ver|) for bug import/export
#. MIME::Parser (|min-mime-parser-ver|) for bug import/export
#. LWP::UserAgent
(|min-lwp-useragent-ver|) for Automatic Update Notifications
#. PatchReader (|min-patchreader-ver|) for pretty HTML view of patches
#. Net::LDAP
(|min-net-ldap-ver|) for LDAP Authentication
#. Authen::SASL
(|min-authen-sasl-ver|) for SASL Authentication
#. Authen::Radius
(|min-authen-radius-ver|) for RADIUS Authentication
#. SOAP::Lite (|min-soap-lite-ver|) for the web service interface
#. JSON::RPC
(|min-json-rpc-ver|) for the JSON-RPC interface
#. Test::Taint
(|min-test-taint-ver|) for the web service interface
#. HTML::Parser
(|min-html-parser-ver|) for More HTML in Product/Group Descriptions
#. HTML::Scrubber
(|min-html-scrubber-ver|) for More HTML in Product/Group Descriptions
#. Email::Reply
(|min-email-reply-ver|) for Inbound Email
#. TheSchwartz
(|min-theschwartz-ver|) for Mail Queueing
#. Daemon::Generic
(|min-daemon-generic-ver|) for Mail Queueing
#. mod_perl2
(|min-mod_perl2-ver|) for mod_perl
If for some reason you really need to install the Perl modules manually, see
:ref:`install-perlmodules-manual`.
.. _install-MTA:
......
docs/en/rst/modules.rst
View file @ 1f815b55
......@@ -47,73 +47,53 @@ Download Locations
CGI:
::
CPAN Download Page: `<http://search.cpan.org/dist/CGI.pm/>`_
Documentation: `<http://perldoc.perl.org/CGI.html>`_
* CPAN Download Page: `<http://search.cpan.org/dist/CGI.pm/>`_
* Documentation: `<http://perldoc.perl.org/CGI.html>`_
Data-Dumper:
::
CPAN Download Page: `<http://search.cpan.org/dist/Data-Dumper/>`_
Documentation: `<http://search.cpan.org/dist/Data-Dumper/Dumper.pm>`_
* CPAN Download Page: `<http://search.cpan.org/dist/Data-Dumper/>`_
* Documentation: `<http://search.cpan.org/dist/Data-Dumper/Dumper.pm>`_
Date::Format (part of TimeDate):
::
CPAN Download Page: `<http://search.cpan.org/dist/TimeDate/>`_
Documentation: `<http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm>`_
* CPAN Download Page: `<http://search.cpan.org/dist/TimeDate/>`_
* Documentation: `<http://search.cpan.org/dist/TimeDate/lib/Date/Format.pm>`_
DBI:
::
CPAN Download Page: `<http://search.cpan.org/dist/DBI/>`_
Documentation: `<http://dbi.perl.org/docs/>`_
* CPAN Download Page: `<http://search.cpan.org/dist/DBI/>`_
* Documentation: `<http://dbi.perl.org/docs/>`_
DBD::mysql:
::
CPAN Download Page: `<http://search.cpan.org/dist/DBD-mysql/>`_
Documentation: `<http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm>`_
* CPAN Download Page: `<http://search.cpan.org/dist/DBD-mysql/>`_
* Documentation: `<http://search.cpan.org/dist/DBD-mysql/lib/DBD/mysql.pm>`_
DBD::Pg:
::
CPAN Download Page: `<http://search.cpan.org/dist/DBD-Pg/>`_
Documentation: `<http://search.cpan.org/dist/DBD-Pg/Pg.pm>`_
* CPAN Download Page: `<http://search.cpan.org/dist/DBD-Pg/>`_
* Documentation: `<http://search.cpan.org/dist/DBD-Pg/Pg.pm>`_
Template-Toolkit:
::
CPAN Download Page: `<http://search.cpan.org/dist/Template-Toolkit/>`_
Documentation: `<http://www.template-toolkit.org/docs.html>`_
* CPAN Download Page: `<http://search.cpan.org/dist/Template-Toolkit/>`_
* Documentation: `<http://www.template-toolkit.org/docs.html>`_
GD:
::
CPAN Download Page: `<http://search.cpan.org/dist/GD/>`_
Documentation: `<http://search.cpan.org/dist/GD/GD.pm>`_
* CPAN Download Page: `<http://search.cpan.org/dist/GD/>`_
* Documentation: `<http://search.cpan.org/dist/GD/GD.pm>`_
Template::Plugin::GD:
::
CPAN Download Page: `<http://search.cpan.org/dist/Template-GD/>`_
Documentation: `<http://www.template-toolkit.org/docs/aqua/Modules/index.html>`_
* CPAN Download Page: `<http://search.cpan.org/dist/Template-GD/>`_
* Documentation: `<http://www.template-toolkit.org/docs/aqua/Modules/index.html>`_
MIME::Parser (part of MIME-tools):
::
CPAN Download Page: `<http://search.cpan.org/dist/MIME-tools/>`_
Documentation: `<http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm>`_
* CPAN Download Page: `<http://search.cpan.org/dist/MIME-tools/>`_
* Documentation: `<http://search.cpan.org/dist/MIME-tools/lib/MIME/Parser.pm>`_
.. _modules-manual-optional:
......@@ -122,37 +102,25 @@ Optional Modules
Chart::Lines:
::
CPAN Download Page: `<http://search.cpan.org/dist/Chart/>`_
Documentation: `<http://search.cpan.org/dist/Chart/Chart.pod>`_
* CPAN Download Page: `<http://search.cpan.org/dist/Chart/>`_
* Documentation: `<http://search.cpan.org/dist/Chart/Chart.pod>`_
GD::Graph:
::
CPAN Download Page: `<http://search.cpan.org/dist/GDGraph/>`_
Documentation: `<http://search.cpan.org/dist/GDGraph/Graph.pm>`_
* CPAN Download Page: `<http://search.cpan.org/dist/GDGraph/>`_
* Documentation: `<http://search.cpan.org/dist/GDGraph/Graph.pm>`_
GD::Text::Align (part of GD::Text::Util):
::
CPAN Download Page: `<http://search.cpan.org/dist/GDTextUtil/>`_
Documentation: `<http://search.cpan.org/dist/GDTextUtil/Text/Align.pm>`_
* CPAN Download Page: `<http://search.cpan.org/dist/GDTextUtil/>`_
* Documentation: `<http://search.cpan.org/dist/GDTextUtil/Text/Align.pm>`_
XML::Twig:
::
CPAN Download Page: `<http://search.cpan.org/dist/XML-Twig/>`_
Documentation: `<http://standards.ieee.org/resources/spasystem/twig/twig_stable.html>`_
* CPAN Download Page: `<http://search.cpan.org/dist/XML-Twig/>`_
* Documentation: `<http://standards.ieee.org/resources/spasystem/twig/twig_stable.html>`_
PatchReader:
::
CPAN Download Page: `<http://search.cpan.org/author/JKEISER/PatchReader/>`_
Documentation: `<http://www.johnkeiser.com/mozilla/Patch_Viewer.html>`_
* CPAN Download Page: `<http://search.cpan.org/author/JKEISER/PatchReader/>`_
* Documentation: `<http://www.johnkeiser.com/mozilla/Patch_Viewer.html>`_
docs/makedocs.pl
View file @ 1f815b55
......@@ -46,65 +46,12 @@ if (eval { require Pod::Simple }) {
$pod_simple = 1;
};
use Bugzilla::Install::Requirements
qw(REQUIRED_MODULES OPTIONAL_MODULES);
use Bugzilla::Constants qw(DB_MODULE BUGZILLA_VERSION);
use Bugzilla::Constants qw(BUGZILLA_VERSION);
use File::Path qw(rmtree);
use File::Which qw(which);
###############################################################################
# Generate minimum version list
###############################################################################
my $modules = REQUIRED_MODULES;
my $opt_modules = OPTIONAL_MODULES;
my $template;
{
open(TEMPLATE, '<', 'definitions.rst.tmpl')
or die('Could not open definitions.rst.tmpl: ' . $!);
local $/;
$template = <TEMPLATE>;
close TEMPLATE;
}
# This file is included at the end of Sphinx's conf.py. Unfortunately there's
# no way to 'epilog' a file, only text.
open(SUBSTS, '>', 'definitions.rst') or die('Could not open definitions.rst: ' . $!);
print SUBSTS 'rst_epilog = """' . "\n$template\n";
print SUBSTS ".. Module Versions\n\n";
foreach my $module (@$modules, @$opt_modules)
{
my $name = $module->{'module'};
$name =~ s/::/-/g;
$name = lc($name);
#This needs to be a string comparison, due to the modules having
#version numbers like 0.9.4
my $version = $module->{'version'} eq 0 ? 'any' : $module->{'version'};
print SUBSTS '.. |min-' . $name . '-ver| replace:: ' . $version . "\n";
}
print SUBSTS "\n.. Database Versions\n\n";
my $db_modules = DB_MODULE;
foreach my $db (keys %$db_modules) {
my $dbd = $db_modules->{$db}->{dbd};
my $name = $dbd->{module};
$name =~ s/::/-/g;
$name = lc($name);
my $version = $dbd->{version} || 'any';
my $db_version = $db_modules->{$db}->{'db_version'};
print SUBSTS '.. |min-' . $name . '-ver| replace:: ' . $version . "\n";
print SUBSTS '.. |min-' . lc($db) . '-ver| replace:: ' . $db_version . "\n";
}
print SUBSTS '"""';
close(SUBSTS);
###############################################################################
# Subs
###############################################################################
......
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