doc: lei-store-format: mail sync section, update IPC

[public-inbox.git] / Documentation / lei-store-format.pod

diff --git a/Documentation/lei-store-format.pod b/Documentation/lei-store-format.pod
index 3e1ddc658579b6cbcc2873157713c33ff805e8ff..625c60f436a8cb3361e905f30e3b4c0a12239252 100644 (file)
--- a/Documentation/lei-store-format.pod
+++ b/Documentation/lei-store-format.pod
@@ -30,9 +30,8 @@ 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
   - local/$EPOCH.git                # normal bare git repositories

-  - net_last.sqlite3                # import state for IMAP & NNTP
+  - mail_sync.sqlite3               # sync state IMAP, Maildir, NNTP

 
 Additionally, the following share the same roles they do in extindex:
 
 
 Additionally, the following share the same roles they do in extindex:
 


@@ -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