From a9cab9c477b74b3b828c26aa64e70d88c9d6744c Mon Sep 17 00:00:00 2001 From: Eric Wong Date: Mon, 7 Jan 2019 09:09:51 +0000 Subject: doc: various overview-level module comments Hopefully this helps people familiarize themselves with the source code. --- lib/PublicInbox/AltId.pm | 9 +++++++++ 1 file changed, 9 insertions(+) (limited to 'lib/PublicInbox/AltId.pm') diff --git a/lib/PublicInbox/AltId.pm b/lib/PublicInbox/AltId.pm index 4a6ff97c..300bdc0b 100644 --- a/lib/PublicInbox/AltId.pm +++ b/lib/PublicInbox/AltId.pm @@ -1,12 +1,21 @@ # Copyright (C) 2016-2018 all contributors # License: AGPL-3.0+ +# Used for giving serial numbers to messages. This can be tied to +# the msgmap for live updates to living lists (see +# PublicInbox::Filters::RubyLang), or kept separate for imports +# of defunct NNTP groups (e.g. scripts/xhdr-num2mid) +# +# Introducing NEW uses of serial numbers is discouraged because of +# it leads to reliance on centralization. However, being able +# to use existing serial numbers is beneficial. package PublicInbox::AltId; use strict; use warnings; use URI::Escape qw(uri_unescape); # spec: TYPE:PREFIX:param1=value1¶m2=value2&... +# The PREFIX will be a searchable boolean prefix in Xapian # Example: serial:gmane:file=/path/to/altmsgmap.sqlite3 sub new { my ($class, $inbox, $spec, $writable) = @_; -- cgit v1.2.3-24-ge0c7