#!/usr/bin/perl -w
-# Copyright (C) 2013-2015 all contributors <meta@public-inbox.org>
-# License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
+# Copyright (C) 2013-2021 all contributors <meta@public-inbox.org>
+# License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
use strict;
use ExtUtils::MakeMaker;
-my @EXE_FILES = split("\n", `git ls-files 'script/*' 2>/dev/null`);
-my $PM_FILES = `git ls-files lib '*.pm' 2>/dev/null`;
-$PM_FILES =~ tr/\n/ /;
+open my $m, '<', 'MANIFEST' or die "open(MANIFEST): $!\n";
+chomp(my @manifest = (<$m>));
+my @EXE_FILES = grep(m!^script/!, @manifest);
+my $v = {};
+my $t = {};
+
+# do not sort
+my @RELEASES = qw(v1.6.1 v1.6.0 v1.5.0 v1.4.0 v1.3.0 v1.2.0 v1.1.0-pre1 v1.0.0);
+
+$v->{news_deps} = [ map { "Documentation/RelNotes/$_.eml" } @RELEASES ];
+$v->{txt} = [ qw(INSTALL README COPYING TODO HACKING) ];
+my @dtxt = grep(m!\ADocumentation/[^/]+\.txt\z!, @manifest);
+push @dtxt, 'Documentation/standards.txt';
+push @dtxt, 'Documentation/flow.txt';
+push @dtxt, @{$v->{txt}};
+for my $txt (@dtxt) {
+ my $html = $txt;
+ $html =~ s/\.txt\z/.html/ or $html .= '.html';
+ $t->{"$html : $txt"} = [ "\$(txt2pre) <$txt" ];
+}
+$v->{t_slash_star_dot_t} = [ grep(m!\At/.*\.t\z!, @manifest) ];
+my @scripts = qw(scripts/ssoma-replay); # legacy
+my @syn = (@EXE_FILES, grep(m!^lib/.*\.pm$!, @manifest), @scripts);
+@syn = grep(!/DSKQXS\.pm/, @syn) if !eval { require IO::KQueue };
+@syn = grep(!/Unsubscribe\.pm/, @syn) if !eval { require Crypt::CBC };
+@syn = grep(!/SaPlugin/, @syn) if !eval { require Mail::SpamAssasin };
+$v->{syn_files} = \@syn;
+$v->{my_syntax} = [map { "$_.syntax" } @syn];
+my @no_pod;
+$v->{-m1} = [ map {
+ my $x = (split('/'))[-1];
+ my $pod = "Documentation/$x.pod";
+ if (-f $pod) {
+ $x;
+ } else {
+ warn "W: $pod missing\n";
+ push @no_pod, $x;
+ ();
+ }
+ } @EXE_FILES,
+ qw(
+ lei-add-external lei-config lei-daemon-kill lei-daemon-pid
+ lei-forget-external lei-init lei-ls-external lei-q)];
+$v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format
+ public-inbox-v2-format public-inbox-extindex-format) ];
+$v->{-m7} = [ qw(public-inbox-overview public-inbox-tuning) ];
+$v->{-m8} = [ qw(public-inbox-daemon) ];
+my @sections = (1, 5, 7, 8);
+$v->{check_80} = [];
+$v->{manuals} = [];
+$v->{mantxt} = [];
+for my $i (@sections) {
+ my $ary = $v->{"-m$i"};
+ $v->{"m$i"} = $ary;
+ for my $m (@$ary) {
+ my $pod = "Documentation/$m.pod";
+ my $txt = "Documentation/$m.txt";
+ $t->{"$m.$i : $pod"} = [ "\$(podman) -s$i $pod \$@" ];
+ $t->{"$txt : $pod"} = [ "\$(podtext) $pod \$\@+",
+ "touch -r $pod \$\@+",
+ "mv \$\@+ \$@" ];
+ $t->{"Documentation/$m.html : $txt"} = [ "\$(txt2pre) <$txt" ];
+ $t->{".$m.cols : $m.$i"} = [
+ "\@echo CHECK80 $m.$i;".
+ "COLUMNS=80 \$(MAN) ./$m.$i | \$(check_man)" ];
+ $t->{".$m.lexgrog: $m.$i"} = [
+ "\@echo LEXGROG $m.$i;" .
+ "\$(LEXGROG) ./$m.$i >\$\@+ && mv \$\@+ \$@" ];
+ }
+ push @{$v->{check_80}}, map { ".$_.cols" } @$ary;
+ push @{$v->{check_lexgrog}}, map { ".$_.lexgrog" } @$ary;
+ my $manuals = $v->{"man$i"} = [ map { "$_.$i" } @$ary ];
+ push @{$v->{manuals}}, @$manuals;
+ push @{$v->{mantxt}}, map { "Documentation/$_.txt" } @$ary;
+}
+push @dtxt, @{$v->{mantxt}};
+$v->{docs} = [ @dtxt, 'NEWS' ];
+$v->{docs_html} = [ map {;
+ my $x = $_;
+ $x =~ s/\.txt\z//;
+ "$x.html"
+ } @{$v->{docs}} ];
+$v->{gz_docs} = [ map { "$_.gz" } (@{$v->{docs}},@{$v->{docs_html}}) ];
+$v->{rsync_docs} = [ @{$v->{gz_docs}}, @{$v->{docs}},
+ @{$v->{docs_html}}, qw(NEWS.atom NEWS.atom.gz)];
+
+# external manpages which we host ourselves, since some packages
+# (currently just Xapian) doesn't host manpages themselves.
+my @xman = qw(copydatabase.1 xapian-compact.1);
+$v->{xdocs} = [ map { "Documentation/.$_.txt" } @xman ];
+$v->{xdocs_html} = [ map { "Documentation/.$_.html" } @xman ];
+for (@{$v->{xdocs}}) {
+ $t->{"$_:"} = [
+ '$(PERL) -w Documentation/extman.perl $@ >$@+',
+ 'mv $@+ $@'
+ ];
+ my $html = $_;
+ $html =~ s/\.txt\z/.html/;
+ $t->{"$html : $_"} = [ "\$(txt2pre) <$_" ];
+}
+$v->{gz_xdocs} = [ map { "$_.gz" } (@{$v->{xdocs_html}}, @{$v->{xdocs}}) ];
+$v->{rsync_xdocs} = [ @{$v->{gz_xdocs}}, @{$v->{xdocs_html}}, @{$v->{xdocs}} ];
+
+my $TGTS = join("\n", map {;
+ my $tgt_prereq = $_;
+ my $cmds = $t->{$_};
+ "$tgt_prereq\n".join('', map { "\t$_\n" } @$cmds);
+} sort keys %$t);
+
+my $VARS = join("\n", map {;
+ my $varname = $_;
+ join('', map { "$varname += $_\n" } sort @{$v->{$varname}});
+} grep(!/^-/, sort keys %$v));
+$VARS .= "\nRELEASES = ".join(' ', @RELEASES)."\n";
+
+# Don't waste user's disk space by installing some pods from
+# imported code or internal use only
+my %man3 = map {; # semi-colon tells Perl this is a BLOCK (and not EXPR)
+ my $base = $_;
+ my $mod = $base;
+ $mod =~ s!/!::!g;
+ $mod =~ s/\.\w+\z//;
+ "lib/PublicInbox/$_" => "blib/man3/PublicInbox::$mod.\$(MAN3EXT)"
+} qw(Git.pm Import.pm WWW.pod SaPlugin/ListMirror.pod);
+my $warn_no_pod = @no_pod ? "\n\t\@echo W: missing .pod: @no_pod\n" : '';
+chomp(my $lexgrog = `which lexgrog 2>/dev/null`);
+my $check_lexgrog = $lexgrog ? 'check-lexgrog' : '';
WriteMakefile(
- NAME => 'PublicInbox',
- VERSION => '0.0.0',
+ NAME => 'PublicInbox', # n.b. camel-case is not our choice
+
+ # XXX drop "PENDING" in .pod before updating this!
+ VERSION => '1.6.1',
+
AUTHOR => 'Eric Wong <e@80x24.org>',
ABSTRACT => 'public-inbox server infrastructure',
EXE_FILES => \@EXE_FILES,
# note: we use spamc(1), NOT the Perl modules
# We also depend on git.
# Keep this sorted and synced to the INSTALL document
- 'Date::Parse' => 0,
- 'Email::MIME' => 0,
- 'Email::MIME::ContentType' => 0,
- 'Email::Simple' => 0,
- 'Encode::MIME::Header' => 0,
- 'IPC::Run' => 0,
- 'Mail::Thread' => '2.5', # 2.5+ needed for Email::Simple compat
- 'Plack' => 0,
+
+ # libperl$PERL_VERSION,
+ # `perl5' on FreeBSD
+ # perl-Digest-SHA on RH-based
+ 'Digest::SHA' => 0,
+
+ # libperl$PERL_VERSION or libencode-perl on Debian,
+ # `perl5' on FreeBSD
+ 'Encode' => 2.35, # 2.35 shipped with 5.10.1
+
+ # libperl$PERL_VERSION + perl-modules-$PERL_VERSION
+ 'Compress::Raw::Zlib' => 0,
+ 'Compress::Zlib' => 0,
+ 'IO::Compress::Gzip' => 0,
+
+ # Plack is needed for public-inbox-httpd and PublicInbox::WWW
+ # 'Plack' => 0,
+
+ # TODO: this should really be made optional...
'URI::Escape' => 0,
+
# We have more test dependencies, but do not force
- # users to install them
+ # users to install them. See INSTALL
+
+ # All Perl installs I know about have these, but RH-based
+ # distros make them separate even though 'perl' pulls them in
+ 'File::Path' => 0,
+ 'File::Temp' => '0.19', # for ->tmpdir support
+ 'Getopt::Long' => 0,
+ 'Exporter' => 0,
+ # ExtUtils::MakeMaker # this file won't run w/o it...
},
+ MAN3PODS => \%man3,
);
sub MY::postamble {
- <<EOF;
+ my $N = (`{ getconf _NPROCESSORS_ONLN || nproc; } 2>/dev/null` || 1);
+ $N += 1; # account for sleeps in some tests (and makes an IV)
+ <<EOF;
+PROVE = prove
# support using eatmydata to speed up tests (apt-get install eatmydata):
# https://www.flamingspork.com/projects/libeatmydata/
EATMYDATA =
+N = $N
-include config.mak
+$VARS
-include Documentation/include.mk
-N ?= \$(shell echo \$\$(( \$\$(nproc 2>/dev/null || echo 2) + 1)))
-SCRIPTS := scripts/ssoma-replay
-my_syntax := \$(addsuffix .syntax, $PM_FILES \$(EXE_FILES) \$(SCRIPTS))
+$TGTS
+check-man :: $check_lexgrog$warn_no_pod
-%.syntax ::
- @\$(PERL) -I lib -c \$(subst .syntax,,\$@)
+# syntax checks are currently GNU make only:
+%.syntax :: %
+ @\$(PERL) -w -I lib -c \$<
syntax:: \$(my_syntax)
-check:: pure_all
- \$(EATMYDATA) prove -lv -j\$(N)
+changed = \$(shell git ls-files -m)
+dsyn :: \$(addsuffix .syntax, \$(filter \$(changed), \$(syn_files)))
+
+check_manifest := if test -e .git && git ls-files >MANIFEST.gen 2>&1; then \\
+ diff -u MANIFEST MANIFEST.gen; fi
+
+check-manifest : MANIFEST
+ \$(check_manifest)
+
+# the traditional way running per-*.t processes:
+check-each :: pure_all
+ \$(EATMYDATA) \$(PROVE) --state=save -bvw -j\$(N)
+ -@\$(check_manifest)
+
+# lightly-tested way to run tests, relies "--state=save" in check-each
+# for best performance
+check-run :: pure_all check-man
+ \$(EATMYDATA) \$(PROVE) -bvw t/run.perl :: -j\$(N)
+ -@\$(check_manifest)
+
+check :: check-each
+
+lib/PublicInbox/UserContent.pm :: contrib/css/216dark.css
+ \$(PERL) -I lib \$@ \$?
+
+# Ensure new .pm files will always be installed by updating
+# the timestamp of Makefile.PL which forces Makefile to be remade
+Makefile.PL : MANIFEST
+ touch -r MANIFEST \$@
+ \$(PERLRUN) \$@
+
+# Install symlinks to ~/bin (which is hopefuly in PATH) which point to
+# this source tree.
+# prefix + bindir matches git.git Makefile:
+prefix = \$(HOME)
+bindir = \$(prefix)/bin
+symlink-install :
+ mkdir -p \$(bindir)
+ lei=\$\$(realpath lei.sh) && cd \$(bindir) && \\
+ for x in \$(EXE_FILES); do \\
+ ln -sf "\$\$lei" \$\$(basename "\$\$x"); \\
+ done
+update-copyrights :
+ \@case '\$(GNULIB_PATH)' in '') echo >&2 GNULIB_PATH unset; false;; esac
+ git ls-files | UPDATE_COPYRIGHT_HOLDER='all contributors' \\
+ UPDATE_COPYRIGHT_USE_INTERVALS=2 \\
+ xargs \$(GNULIB_PATH)/build-aux/update-copyright
EOF
}