httpd: document pi-httpd.async as totally unstable

[public-inbox.git] / script / public-inbox-httpd

diff --git a/script/public-inbox-httpd b/script/public-inbox-httpd
index f1a5d7992a4e539a261bfee044378922f9abea6f..d4070595d16eea44a35b0e8b290e02e978a4b77c 100755 (executable)
--- a/script/public-inbox-httpd
+++ b/script/public-inbox-httpd
@@ -59,6 +59,10 @@ daemon_run('0.0.0.0:8080', $refresh,
 
 1;
 
+# XXX This is a totally unstable API for public-inbox internal use only
+# This is exposed via the 'pi-httpd.async' key in the PSGI env hash.
+# The name of this key is not even stable!
+# Currently is is intended for use with read-only pipes.
 package PublicInbox::HTTPD::Async;
 use strict;
 use warnings;