about summary refs log tree commit homepage
path: root/Documentation
diff options
authorEric Wong <e@80x24.org>2021-10-26 10:35:50 +0000
committerEric Wong <e@80x24.org>2021-10-26 17:43:51 +0000
commit273090c96e3b5c214605decf5a755546116cc9bd (patch)
tree46b7d3488982980f1eaee6ce4f81bda40ba2f6fd /Documentation
parent6e0ac7612095397ef3b9e019f772d724c62eac5b (diff)
mail_sync.sqlite3 needs to be documented, and brings the IPC
section up-to-date while we're in the area.
Diffstat (limited to 'Documentation')
1 files changed, 10 insertions, 4 deletions
diff --git a/Documentation/lei-store-format.pod b/Documentation/lei-store-format.pod
index 71aa72cb..625c60f4 100644
--- a/Documentation/lei-store-format.pod
+++ b/Documentation/lei-store-format.pod
@@ -30,7 +30,6 @@ prevent them from being accidentally treated as a v2 inbox.
   $SHARD - Integer starting with 0 based on parallelism
-  - ipc.lock                        # lock file for internal lei IPC
   - 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.
+=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
 =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