t/*.t: localize $SIG{__WARN__} changes

[public-inbox.git] / HACKING

diff --git a/HACKING b/HACKING
index 666d504e7336b61ef7d26f559e5b192c56fbd9de..cceb686f2e83e41e07b14beae70fd96fc60d745d 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -32,7 +32,7 @@ may be too difficult to upgrade due to resource demands.
 Only depend on Free Software packages which exist in the "main"
 section of Debian "stable" distribution.  That is Debian 9.x
 ("stretch") as of this writing, but "oldstable" (8.x, "jessie")
-remains supported for v1 repositories.
+remains supported for v1 inboxes.
 
 In general, we favor mature and well-tested old things rather than
 the shiny new.
@@ -43,6 +43,11 @@ distribute and verify.  public-inbox itself will only be implemented
 in scripting languages (currently Perl 5) and optional JIT-compiled C
 (via Inline::C)
 
+Do not recurse on user-supplied data.  Neither Perl or C handle
+deep recursion gracefully.  See lib/PublicInbox/SearchThread.pm
+and lib/PublicInbox/MsgIter.pm for examples of non-recursive
+alternatives to previously-recursive algorithms.
+
 Performance should be reasonably good for server administrators, too,
 and we will sacrifice features to achieve predictable performance.
 Encouraging folks to self-host will be easier with lower hardware
@@ -51,6 +56,9 @@ requirements.
 See design_www.txt and design_notes.txt in the Documentation/
 directory for design decisions made during development.
 
+See Documentation/technical/ in the source tree for more details
+on specific topics, in particular data_structures.txt
+
 Perl notes
 ----------