]> git.ipfire.org Git - thirdparty/public-inbox.git/commitdiff
doc: v2: clarify v2 format vs. v2.x release
authorEric Wong <e@80x24.org>
Thu, 12 Feb 2026 20:19:25 +0000 (20:19 +0000)
committerEric Wong <e@80x24.org>
Wed, 18 Feb 2026 00:42:09 +0000 (00:42 +0000)
An attempt to to avoid confusion between the v2 format from 2018
and the v2.x release from 2025.  We'll also fix the sentence
describing multiple Message-IDs while we're at it.

Documentation/public-inbox-v2-format.pod

index dd6fca3dc593bd8cfd295224e19a42db79e94cae..3da07ee97acc60da4aab5f388cb7f0b6cf6a3923 100644 (file)
@@ -6,16 +6,16 @@ public-inbox-v2-format - structure of public inbox v2 archives
 
 =head1 DESCRIPTION
 
-The v2 format is designed primarily to address several
-scalability problems of the original format described at
-L<public-inbox-v1-format(5)>.  It also handles messages with
-Message-IDs.
+The v2 format was introduced in public-inbox 1.1 and designed
+primarily to address several scalability problems of the
+original format described at L<public-inbox-v1-format(5)>.  It
+also handles messages with multiple Message-IDs.
 
 =head1 INBOX LAYOUT
 
-The key change in v2 is the inbox is no longer a bare git
+The key change in the v2 format is the inbox is no longer a bare git
 repository, but a directory with two or more git repositories.
-v2 divides git repositories by time "epochs" and Xapian
+The v2 format divides git repositories by time "epochs" and Xapian
 databases for parallelism by "shards".
 
 =head2 INBOX OVERVIEW AND DEFINITIONS