about summary refs log tree commit homepage
path: root/INSTALL
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2019-06-13 02:26:30 +0000
committerEric Wong <e@80x24.org>2019-06-13 02:27:21 +0000
commitf4dbd80157bd785cf5d863d517b7334bd2795bab (patch)
tree1211480d695e54b177709c5963d95a84b801033d /INSTALL
parentac8fb90b7a20e790fc5e927ffd8134b6a5c2661c (diff)
downloadpublic-inbox-f4dbd80157bd785cf5d863d517b7334bd2795bab.tar.gz
Digest::SHA is the most notable missing package at runtime
for a minimal system.

Tests don't run at all without Test::Simple (or Test::More).
Plack::Test is also a separate package, too...

Also, the package for IO::Compress::Gzip should be IO::Compress;
as perl-PerlIO-gzip is a different thing entirely which is not
relevant to our needs.

Test::HTTP::Server::Simple doesn't seem required at all for Plack
tests.

ExtUtils::MakeMaker needs to be documented as a install dependency
for people installing this, too; since AFAIK public-inbox is not
yet in any distros.
Diffstat (limited to 'INSTALL')
-rw-r--r--INSTALL22
1 files changed, 16 insertions, 6 deletions
diff --git a/INSTALL b/INSTALL
index 0246299b..a661c776 100644
--- a/INSTALL
+++ b/INSTALL
@@ -36,6 +36,9 @@ Beyond that, there is a long list of Perl modules required, starting with:
                                    pkg: p5-TimeDate
                                    rpm: perl-TimeDate
 
+* Digest::SHA                      typically installed with Perl
+                                   rpm: perl-Digest-SHA
+
 * Email::MIME                      deb: libemail-mime-perl
                                    pkg: p5-Email-MIME
                                    rpm: perl-Email-MIME
@@ -132,8 +135,8 @@ above, so there is no need to explicitly install them:
                                    (for public-inbox-watch, pulled in by Plack)
 
 - IO::Compress::Gzip               deb: perl-modules (or libio-compress-perl)
-                                   rpm: perl-PerlIO-gzip
                                    pkg: perl5
+                                   rpm: perl-IO-Compress
                                    (for gzipped mbox over HTTP)
 
 Uncommonly needed modules:
@@ -156,18 +159,25 @@ Optional packages testing and development:
                                    pkg: p5-IPC-Run
                                    rpm: perl-IPC-Run
 
+- Plack::Test                      deb: libplack-test-perl
+                                   pkg: p5-Plack
+                                   rpm: perl-Plack-Test
+
+- Test::Simple                     deb: perl-modules-5.$MINOR
+                                   pkg: perl5
+                                   rpm: perl-Test-Simple
+
 - XML::Feed                        deb: libxml-feed-perl
                                    pkg: p5-XML-Feed
                                    rpm: perl-XML-Feed
 
-- Test::HTTP::Server::Simple       deb: libtest-http-server-simple-perl
-                                   pkg: p5-Test-HTTP-Server-Simple
-                                   rpm: perl-Test-HTTP-Server-Simple
-                                   (XXX is this really needed?)
-
 standard MakeMaker installation (Perl)
 --------------------------------------
 
+To use MakeMaker, you need to ensure ExtUtils::MakeMaker is available.
+This is typically installed with Perl, but RPM-based systems will likely
+need to install the `perl-ExtUtils-MakeMaker' package.
+
 Once the dependencies are installed, you should be able to build and
 install the system (into /usr/local) with: