* [PATCH 39/52] Makefile.PL: do not build manpage if POD is missing
2020-10-27 7:54 3% [PATCH 00/52] detached external index: mostly Eric Wong
@ 2020-10-27 7:54 7% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2020-10-27 7:54 UTC (permalink / raw)
To: meta
But warn on it, this lets us test new or throwaway commands more
easily if we don't have to start a new POD for everything we
want to dump in script/.
---
Makefile.PL | 16 +++++++++++++++-
1 file changed, 15 insertions(+), 1 deletion(-)
diff --git a/Makefile.PL b/Makefile.PL
index f6b7abb6..56679598 100644
--- a/Makefile.PL
+++ b/Makefile.PL
@@ -31,7 +31,18 @@ my @syn = (@EXE_FILES, grep(m!^lib/.*\.pm$!, @manifest), @scripts);
@syn = grep(!/SaPlugin/, @syn) if !eval { require Mail::SpamAssasin };
$v->{syn_files} = \@syn;
$v->{my_syntax} = [map { "$_.syntax" } @syn];
-$v->{-m1} = [ map { (split('/'))[-1] } @EXE_FILES ];
+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 ];
$v->{-m5} = [ qw(public-inbox-config public-inbox-v1-format
public-inbox-v2-format) ];
$v->{-m7} = [ qw(public-inbox-overview public-inbox-tuning) ];
@@ -109,6 +120,7 @@ my %man3 = map {; # semi-colon tells Perl this is a BLOCK (and not EXPR)
$mod =~ s/\.\w+\z//;
"lib/PublicInbox/$_" => "blib/man3/PublicInbox::$mod.3"
} 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" : '';
WriteMakefile(
NAME => 'PublicInbox', # n.b. camel-case is not our choice
@@ -172,6 +184,8 @@ $VARS
-include Documentation/include.mk
$TGTS
+check-man ::$warn_no_pod
+
# syntax checks are currently GNU make only:
%.syntax :: %
@\$(PERL) -w -I lib -c \$<
^ permalink raw reply related [relevance 7%]
* [PATCH 00/52] detached external index: mostly
@ 2020-10-27 7:54 3% Eric Wong
2020-10-27 7:54 7% ` [PATCH 39/52] Makefile.PL: do not build manpage if POD is missing Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2020-10-27 7:54 UTC (permalink / raw)
To: meta
...and mostly wired up for WWW, but requires manual config
editing atm. Needs docs and tests, and IMAP support.
This will also form the basis of a mairix workalike client.
Not sure about the usability aspects, but I think this can
replace the need for per-inbox Xapian DBs and save a truckload
of disk space (and more importantly: cache space). Per-inbox
over.sqlite3 remains required for compatibility with NNTP/IMAP
and existing WWW code.
I don't know if the command-line tool is going to be called
public-inbox-eindex or public-inbox-extindex, but probably the
latter...
"xindex" could be confusing, and "eindex" rhymes with "reindex"
which could also be confusing. But I'm even more easily
confused than usual these days :x
Performance isn't great, it took 30+ hours to index my mirror of
lore on a SATA SSD, but the entire index is <200GB due to
deduplication between cross posts. -compact isn't working with
these indices, yet, but will sometime...
More changes on the way, still trying fix my brain and get
through this year...
Eric Wong (52):
doc/standards: add RFCs for URL schemes
search: hoist out _xdb_sharded for v2 inboxes
extsearch: start mocking out
searchidx: expose INDEXLEVELS as `our'
v2writable: add git method
v2writable: make OO calls to last_commit-related methods
search: xdb_sharded: make this a public method for ExtSearch
searchidx: introduce "xref3" concept
v2writable: prepare initialization for external indices
v2writable: hoist out write_alternates
searchidxshard: allow msgref to be undef
v2writable: idx_shard: simplify callers
v2writable: count_shards: allow working without {ibx}
overidx: introduce changes for external index
v2: some changes for ExtSearchIdx compatibility
inboxwritable: eidx_key for external index
v2writable: rename remaining "remote" terminology
v2writable: checkpoint: account for lack of {mm}
extsearchidx: initial implementation
searchidx: index eidx_key as a boolean term
searchidx: xref3 delete support
searchidxshard: special init for eidx
searchidx: put {ibx} into $sync state
searchidx: log2stack: simplify callers
v2writable: more generic sync setup code
v2writable: allow OO method references
v2writable: rename {v2w} field to {self}
v2writable: make *last_commits and sync_prepare OO methods
v2writable: move size check init to sync_prepare
extsearchidx: more compatibility with V2Writable callers
v2writable: reduce scope of epoch-aware code
extsearchidx: remove {unindex_range} field
v2writable: pass oid to uindex_oid
extsearchidx: sync unit updates
searchidx: export prepare_stack
extsearchidx: sync updates
searchidx: reduce inbox-dependency, wrap ->with_umask
searchidx: favor $sync->{ibx} (over $self->{ibx})
Makefile.PL: do not build manpage if POD is missing
script: add preliminary eindex implementation
index: eindex wiring
over: store xref3 data in over.sqlite3
searchidx: remove xref3 support for Xapian
t/extsearch.t: verify results and xref3 ordering
t/v2writable: remove pointless ->barrier call
extsearch: wire up smsg_eml
extsearchidx: handle edits
extsearch: wire up remaining Inbox-like methods for WWW
searchidx: ignore exceptions from ->remove_term
extsearchidx: set current_info in warning callbacks
extsearchidx: support --batch-size checkpoints
searchidxshard: make warnings with eidx_key less confusing
Documentation/standards.perl | 3 +
MANIFEST | 4 +
Makefile.PL | 16 +-
lib/PublicInbox/Config.pm | 12 +
lib/PublicInbox/ExtSearch.pm | 69 +++++
lib/PublicInbox/ExtSearchIdx.pm | 404 ++++++++++++++++++++++++++++++
lib/PublicInbox/Inbox.pm | 53 ++--
lib/PublicInbox/InboxWritable.pm | 23 ++
lib/PublicInbox/Over.pm | 19 ++
lib/PublicInbox/OverIdx.pm | 122 ++++++++-
lib/PublicInbox/Search.pm | 62 ++---
lib/PublicInbox/SearchIdx.pm | 135 +++++++---
lib/PublicInbox/SearchIdxShard.pm | 77 +++++-
lib/PublicInbox/V2Writable.pm | 310 ++++++++++++-----------
lib/PublicInbox/WWW.pm | 3 +-
lib/PublicInbox/Xapcmd.pm | 2 +-
script/public-inbox-eindex | 43 ++++
script/public-inbox-index | 3 +-
t/extsearch.t | 75 ++++++
t/over.t | 24 ++
t/search.t | 2 -
t/v2writable.t | 3 +-
22 files changed, 1204 insertions(+), 260 deletions(-)
create mode 100644 lib/PublicInbox/ExtSearch.pm
create mode 100644 lib/PublicInbox/ExtSearchIdx.pm
create mode 100644 script/public-inbox-eindex
create mode 100644 t/extsearch.t
^ permalink raw reply [relevance 3%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2020-10-27 7:54 3% [PATCH 00/52] detached external index: mostly Eric Wong
2020-10-27 7:54 7% ` [PATCH 39/52] Makefile.PL: do not build manpage if POD is missing Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).