about summary refs log tree commit homepage
path: root/lib/PublicInbox/AltId.pm
diff options
authorEric Wong <e@80x24.org>2019-01-07 09:09:51 +0000
committerEric Wong <e@80x24.org>2019-01-09 11:44:52 +0000
commita9cab9c477b74b3b828c26aa64e70d88c9d6744c (patch)
treef0205f3253aad322c6a7e074b3939d1d345e1b56 /lib/PublicInbox/AltId.pm
parente683624b96fdc2587a2e45895d22b373c8a6413b (diff)
Hopefully this helps people familiarize themselves with
the source code.
Diffstat (limited to 'lib/PublicInbox/AltId.pm')
1 files changed, 9 insertions, 0 deletions
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 <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
+# 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&param2=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) = @_;