]> Sergey Matveev's repositories - public-inbox.git/commitdiff
doc: lei-store-format: mail sync section, update IPC
authorEric Wong <e@80x24.org>
Tue, 26 Oct 2021 10:35:50 +0000 (10:35 +0000)
committerEric Wong <e@80x24.org>
Tue, 26 Oct 2021 17:43:51 +0000 (17:43 +0000)
mail_sync.sqlite3 needs to be documented, and brings the IPC
section up-to-date while we're in the area.

Documentation/lei-store-format.pod

index 71aa72cb96e3b6d9a03dce1680f11e9848ee40c9..625c60f436a8cb3361e905f30e3b4c0a12239252 100644 (file)
@@ -30,7 +30,6 @@ prevent them from being accidentally treated as a v2 inbox.
   $SHARD - Integer starting with 0 based on parallelism
 
   ~/.local/share/lei/store
   $SHARD - Integer starting with 0 based on parallelism
 
   ~/.local/share/lei/store
-  - ipc.lock                        # lock file for internal lei IPC
   - local/$EPOCH.git                # normal bare git repositories
   - mail_sync.sqlite3               # sync state IMAP, Maildir, NNTP
 
   - local/$EPOCH.git                # normal bare git repositories
   - mail_sync.sqlite3               # sync state IMAP, Maildir, NNTP
 
@@ -66,11 +65,18 @@ stored in Xapian indices, volatile metadata is associated with
 the Xapian document, thus it is shared across different blobs of
 the "same" message.
 
 the Xapian document, thus it is shared across different blobs of
 the "same" message.
 
+=head2 mail_sync.sqlite3
+
+This SQLite database maintained for bidirectional mapping of
+git blobs to IMAP UIDs, Maildir file names, and NNTP article numbers.
+
+It is also used for retrieving messages from Maildirs indexed by
+L<lei-index(1)>.
+
 =head1 IPC
 
 =head1 IPC
 
-When L<lei(1)> is run in daemon mode, L<flock(2)> is used on
-C<ipc.lock> is used to serialize writes to C<lei/store> across
-multiple internal lei workers while minimizing commits.
+L<lei-daemon(8)> communicates with the C<lei/store> process using
+L<unix(7)> C<SOCK_SEQPACKET> sockets.
 
 =head1 CAVEATS
 
 
 =head1 CAVEATS