From: Eric Wong <e@80x24.org>
To: meta@public-inbox.org
Subject: [PATCH 3/6] doc: technical: document weird stuff in our codebase
Date: Thu, 9 Mar 2023 19:28:39 +0000 [thread overview]
Message-ID: <20230309192842.625820-4-e@80x24.org> (raw)
In-Reply-To: <20230309192842.625820-1-e@80x24.org>
Hopefully this makes things less surprising to new hackers.
---
Documentation/technical/weird-stuff.txt | 22 ++++++++++++++++++++++
MANIFEST | 1 +
2 files changed, 23 insertions(+)
create mode 100644 Documentation/technical/weird-stuff.txt
diff --git a/Documentation/technical/weird-stuff.txt b/Documentation/technical/weird-stuff.txt
new file mode 100644
index 00000000..0c8d6891
--- /dev/null
+++ b/Documentation/technical/weird-stuff.txt
@@ -0,0 +1,22 @@
+There's a lot of weird code in public-inbox which may be daunting
+to new hackers.
+
+* The event loop (PublicInbox::DS) is an evolution of a fairly standard
+ C10K event loop. See ds.txt in this directory for more.
+
+Things got weirder in 2021:
+
+* The lei command-line tool is backed by a daemon. This was done to
+ improve startup time for shell completion and manage git/SQLite/Xapian
+ single-writer during long, parallel imports. It may eventually become
+ a read-write IMAP/JMAP server.
+
+* SOCK_SEQPACKET is used extensively in lei, and will likely make its
+ way into more places, still.
+
+And even more so in 2022:
+
+* public-inbox-clone / PublicInbox::LeiMirror relies on ->DESTROY
+ for make-like dependency management while providing parallelism.
+
+More to come, lei will expose Maildirs via FUSE 3...
diff --git a/MANIFEST b/MANIFEST
index 7437bb54..bc652e21 100644
--- a/MANIFEST
+++ b/MANIFEST
@@ -99,6 +99,7 @@ Documentation/standards.perl
Documentation/technical/data_structures.txt
Documentation/technical/ds.txt
Documentation/technical/memory.txt
+Documentation/technical/weird-stuff.txt
Documentation/technical/whyperl.txt
Documentation/txt2pre
HACKING
next prev parent reply other threads:[~2023-03-09 19:28 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-03-09 19:28 [PATCH 0/6] various doc updates Eric Wong
2023-03-09 19:28 ` [PATCH 1/6] doc: technical/memory: add note about mwrap-perl Eric Wong
2023-03-09 19:28 ` [PATCH 2/6] doc: technical/ds: update blurb to note more daemons Eric Wong
2023-03-09 19:28 ` Eric Wong [this message]
2023-03-09 19:28 ` [PATCH 4/6] doc: lei import: add hints about nntp.* and imap.* config options Eric Wong
2023-03-09 19:28 ` [PATCH 5/6] doc: lei config: update with --edit and --list examples Eric Wong
2023-03-09 19:28 ` [PATCH 6/6] doc: 2.0.0 release notes update Eric Wong
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://public-inbox.org/README
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230309192842.625820-4-e@80x24.org \
--to=e@80x24.org \
--cc=meta@public-inbox.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).