]> git.ipfire.org Git - thirdparty/public-inbox.git/commitdiff
doc/lei-mail-formats: update MH read-only status
authorEric Wong <e@80x24.org>
Tue, 30 Jan 2024 06:31:10 +0000 (06:31 +0000)
committerEric Wong <e@80x24.org>
Tue, 30 Jan 2024 08:28:54 +0000 (08:28 +0000)
I'm not looking forward to dealing with synchronization
problems if we end up dealing with writes...

Documentation/lei-mail-formats.pod

index 930c5d7660ea03e2113f7dc027977ceb76f7e5a1..618bada2f49be02647aab46e64472f0d67311375 100644 (file)
@@ -83,9 +83,19 @@ mbox.
 
 =head1 MH
 
-Not yet supported, locking semantics (or lack thereof) appear to
-make it unsuitable for parallel access.  It is widely-supported
-by a variety of MUAs and mailing list managers, however.
+Preliminary support for reads as of 2.0.0.  Locking semantics differ
+incompatibly amongst existing writers: Python and nmh appear
+compatible with each other, while mutt appears racy and unsuitable
+for parallel access due to rename(2) potentially clobbering the
+C<.mh_sequences> file.  More info about other clients is greatly
+appreciated.
+
+Sequence numbers may be packed and reused by some writers, so lei
+users may need to run L<lei-refresh-mail-sync(1)> if inotify|kevent
+missed packing while L<lei-daemon(8)> wasn't running.
+
+lei is safe for reading mlmmj archives as MH since mlmmj neither
+packs nor uses a .mh_sequences file to store state.
 
 =head1 MMDF