Skip to content

Commit

Permalink
Remove obsolete wording about Perl prior to 5.6.0
Browse files Browse the repository at this point in the history
Simplify the reading of the documentation.
  • Loading branch information
Julien-Elie committed Sep 8, 2024
1 parent 98442ee commit 6e6ad05
Show file tree
Hide file tree
Showing 6 changed files with 21 additions and 38 deletions.
7 changes: 5 additions & 2 deletions .perlcriticrc
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,12 @@ extra_pair_functions = by_hierarchy DateCompare
[Compatibility::PerlMinimumVersionAndWhy]
above_version = 5.006

# INN requires at least Perl 5.6.0.
# INN requires at least Perl 5.12.0 to generate documentation from POD due to
# the use of L<> links with URL and text, Perl 5.10.0 due to the =encoding
# command, and Perl 5.8.0 due to L<> links to URL. Most of the documentation
# can be generated with Perl 5.6.0 though.
[Compatibility::PodMinimumVersion]
above_version = 5.006
above_version = 5.012

# We still have some qx() calls.
[InputOutput::ProhibitBacktickOperators]
Expand Down
5 changes: 4 additions & 1 deletion configure.ac
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,10 @@ dnl Embedded Perl requires 5.004. Use of the three-arg open and the our
dnl keyword requires 5.006, so makes 5.006 the minimum level; anyone should
dnl really have at least that these days.
dnl The recommendation in INSTALL and README is even a bit higher (Perl 5.8.0).
dnl An optional Perl module (INN::ovsqlite_client) requires 5.8.0 though.
dnl An optional Perl module (INN::ovsqlite_client) actually requires Perl 5.8.0
dnl though. Generating all the documentation from POD requires Perl 5.12.0
dnl but most of it can be generated with Perl 5.6.0. If need be, the
dnl documentation can be fetched from the release tarball.
dnl We also check for useful Perl modules.
INN_PROG_PERL([5.006])
INN_PERL_CHECK_MODULE([Encode], [],
Expand Down
12 changes: 1 addition & 11 deletions doc/pod/controlchan.pod
Original file line number Diff line number Diff line change
Expand Up @@ -45,17 +45,7 @@ in F<inn.conf>, because in this case B<controlchan> needs a site name,
not an IP address.

B<controlchan> tries to report all log messages through syslog(3), unless
connected to an interactive terminal. To enable syslog(3)'ing for versions of
Perl prior to 5.6.0, you will need to have run B<h2ph> on your system include
files at some point (this is required to make C<Sys::Syslog> work). If you
have not done so, do this:

cd /usr/include
h2ph * sys/*

If you run FreeBSD, you will need to run the following in addition:

h2ph machine/*
connected to an interactive terminal.

=head1 OPTIONS

Expand Down
4 changes: 1 addition & 3 deletions doc/pod/hacking.pod
Original file line number Diff line number Diff line change
Expand Up @@ -126,9 +126,7 @@ If you use POD or regenerate POD documentation, please install something
close to the latest versions of the POD processing utilities to avoid
changes to the documentation depending on who generated it last. You can
find the latest version of the C<podlators> distribution on CPAN
(L<https://metacpan.org/dist/podlators>). For versions of Perl before 5.6.1
(as Perl 5.6.1 and later come with a recent enough version), you'll also need
C<Pod::Parser> (see L<https://metacpan.org/pod/Pod::Parser>).
(L<https://metacpan.org/dist/podlators>).

There are makefile rules in F<doc/pod/Makefile> to build all of the
documentation whose master form is POD; if you add additional
Expand Down
16 changes: 4 additions & 12 deletions doc/pod/install.pod
Original file line number Diff line number Diff line change
Expand Up @@ -115,18 +115,10 @@ L<https://www.perl.org/get.html>. Note that you may need to use the same
compiler and options (particularly large file support and shared libraries)
for Perl and INN.

If you're using a version of Perl prior to 5.6.0, you may need to make
sure that the Perl versions of your system header files have been
generated in order for C<Sys::Syslog> to work properly (used by various
utility programs, including B<controlchan>). To do this, run the following
two commands:

# cd /usr/include
# h2ph * sys/*

An even better approach is to install S<Perl 5.6.1> or later, which have a
fixed version of C<Sys::Syslog> that doesn't require this (as well as many
other improvements over earlier versions of Perl).
Generating all the documentation from POD requires S<B<Perl 5.12.0>> due
to the use of C<LE<lt>E<gt>> with URL and text in some files but most of the
documentation can be generated with S<B<Perl 5.8.0>>. If need be, it can be
fetched from the release tarball.

=item *

Expand Down
15 changes: 6 additions & 9 deletions readme.pod
Original file line number Diff line number Diff line change
Expand Up @@ -138,15 +138,12 @@ compiling or running INN, or if you successfully run INN on a platform
that isn't listed in F<INSTALL>, please let us know (see L<"Reporting
Bugs"> below).

S<Perl 5.004_03> or later is required to build INN and use the embedded
Perl filtering and authentication hook support (which is highly
recommended; some excellent spam filters have been written for INN).
Since all versions of Perl previous to 5.004 are buggy (including
security problems) and have fewer features, installing S<Perl 5.004_03>
or later (like at least S<Perl 5.8.0>) is recommended. Depending on
what language you want to write your filters and authentication hooks in,
you may also want to install S<Python 2.3.0> or later, or S<Python 3.3.0>
or later.
S<Perl 5.8.0> or later is required to build INN, run several subsystems,
and use the embedded Perl filtering and authentication hook support (which is
highly recommended; some excellent spam filters have been written for INN).
Depending on what language you want to write your filters and authentication
hooks in, you may also want to install S<Python 2.3.0> or later, or S<Python
3.3.0> or later.

For support for authenticated control messages, you will need either PGP
or GnuPG, the latter being recommended. See F<INSTALL> for more details.
Expand Down

0 comments on commit 6e6ad05

Please sign in to comment.