about summary refs log tree commit homepage
path: root/lib/PublicInbox/Msgmap.pm
diff options
context:
space:
mode:
authorEric Wong <e@80x24.org>2015-11-20 01:02:40 +0000
committerEric Wong <e@80x24.org>2015-11-20 01:02:40 +0000
commitf564327fd1e694056a4b13ed398cabd8d0d4c173 (patch)
tree1c24ebf56f203d7476f4dce43b5c5c47625df078 /lib/PublicInbox/Msgmap.pm
parenta36e2d3c6f7e5cc1e7aa2b495ad67bbd2b3d709c (diff)
downloadpublic-inbox-f564327fd1e694056a4b13ed398cabd8d0d4c173.tar.gz
Hopefully this gives new hackers a better overview of
how the components relate to each other.
Diffstat (limited to 'lib/PublicInbox/Msgmap.pm')
-rw-r--r--lib/PublicInbox/Msgmap.pm8
1 files changed, 7 insertions, 1 deletions
diff --git a/lib/PublicInbox/Msgmap.pm b/lib/PublicInbox/Msgmap.pm
index 6e9f2743..8fe17a95 100644
--- a/lib/PublicInbox/Msgmap.pm
+++ b/lib/PublicInbox/Msgmap.pm
@@ -1,6 +1,12 @@
 # Copyright (C) 2015 all contributors <meta@public-inbox.org>
 # License: AGPLv3 or later (https://www.gnu.org/licenses/agpl-3.0.txt)
-# bidirectional Message-ID <-> Article Number mapping
+
+# bidirectional Message-ID <-> Article Number mapping for the NNTP
+# and web interfaces.  This is required for implementing stable article
+# numbers for NNTP and allows prefix lookups for partial Message-IDs
+# in case URLs get truncated from copy-n-paste errors by users.
+#
+# This is maintained by ::SearchIdx
 package PublicInbox::Msgmap;
 use strict;
 use warnings;