* [PATCH 3/6] doc: technical: document weird stuff in our codebase
2023-03-09 19:28 6% [PATCH 0/6] various doc updates Eric Wong
@ 2023-03-09 19:28 7% ` Eric Wong
0 siblings, 0 replies; 2+ results
From: Eric Wong @ 2023-03-09 19:28 UTC (permalink / raw)
To: meta
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
^ permalink raw reply related [relevance 7%]
* [PATCH 0/6] various doc updates
@ 2023-03-09 19:28 6% Eric Wong
2023-03-09 19:28 7% ` [PATCH 3/6] doc: technical: document weird stuff in our codebase Eric Wong
0 siblings, 1 reply; 2+ results
From: Eric Wong @ 2023-03-09 19:28 UTC (permalink / raw)
To: meta
Something to distract me while waiting on codesearch indexing
slowness...
Eric Wong (6):
doc: technical/memory: add note about mwrap-perl
doc: technical/ds: update blurb to note more daemons
doc: technical: document weird stuff in our codebase
doc: lei import: add hints about nntp.* and imap.* config options
doc: lei config: update with --edit and --list examples
doc: 2.0.0 release notes update
Documentation/RelNotes/v2.0.0.wip | 28 +++++++++++++++++++++---
Documentation/lei-config.pod | 29 +++++++++++++++++++++++--
Documentation/lei-import.pod | 7 +++++-
Documentation/technical/ds.txt | 13 +++++++----
Documentation/technical/memory.txt | 6 +++++
Documentation/technical/weird-stuff.txt | 22 +++++++++++++++++++
MANIFEST | 1 +
7 files changed, 96 insertions(+), 10 deletions(-)
create mode 100644 Documentation/technical/weird-stuff.txt
^ permalink raw reply [relevance 6%]
Results 1-2 of 2 | reverse | options above
-- pct% links below jump to the message on this page, permalinks otherwise --
2023-03-09 19:28 6% [PATCH 0/6] various doc updates Eric Wong
2023-03-09 19:28 7% ` [PATCH 3/6] doc: technical: document weird stuff in our codebase Eric Wong
Code repositories for project(s) associated with this public inbox
https://80x24.org/public-inbox.git
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).