X-Git-Url: http://www.git.stargrave.org/?a=blobdiff_plain;f=lib%2FPublicInbox%2FAltId.pm;h=6103d52e7fba0a4768a0bad20e2d7071bec5b53e;hb=9bd675d33ad1e49bd2ebe12a1d216216e61380de;hp=4a6ff97cc5e4aca470504123bbc30ce68dac6744;hpb=6f21c507cc4b2278a81159ebbfc9d1b0c3d00ab9;p=public-inbox.git

diff --git a/lib/PublicInbox/AltId.pm b/lib/PublicInbox/AltId.pm
index 4a6ff97c..6103d52e 100644
--- a/lib/PublicInbox/AltId.pm
+++ b/lib/PublicInbox/AltId.pm
@@ -1,15 +1,24 @@
-# Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2019 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) = @_;
+	my ($class, $ibx, $spec, $writable) = @_;
 	my ($type, $prefix, $query) = split(/:/, $spec, 3);
 	$type eq 'serial' or die "non-serial not supported, yet\n";
 
@@ -22,10 +31,10 @@ sub new {
 	} split(/[&;]/, $query);
 	my $f = $params{file} or die "file: required for $type spec $spec\n";
 	unless (index($f, '/') == 0) {
-		if (($inbox->{version} || 1) == 1) {
-			$f = "$inbox->{mainrepo}/public-inbox/$f";
+		if (($ibx->{version} || 1) == 1) {
+			$f = "$ibx->{mainrepo}/public-inbox/$f";
 		} else {
-			$f = "$inbox->{mainrepo}/$f";
+			$f = "$ibx->{mainrepo}/$f";
 		}
 	}
 	bless {