doc: various overview-level module comments

[public-inbox.git] / lib / PublicInbox / HTTPD.pm

diff --git a/lib/PublicInbox/HTTPD.pm b/lib/PublicInbox/HTTPD.pm
index 433d6da7787da13881ee78552d1da8be0712d343..8cf365d04ced13658fab55b0fa69929bdc2c9d70 100644 (file)
--- a/lib/PublicInbox/HTTPD.pm
+++ b/lib/PublicInbox/HTTPD.pm
@@ -1,6 +1,8 @@
-# Copyright (C) 2016 all contributors <meta@public-inbox.org>
+# Copyright (C) 2016-2018 all contributors <meta@public-inbox.org>
 # License: AGPL-3.0+ <https://www.gnu.org/licenses/agpl-3.0.txt>
 
+# wraps a listen socket for HTTP and links it to the PSGI app in
+# public-inbox-httpd
 package PublicInbox::HTTPD;
 use strict;
 use warnings;
@@ -29,6 +31,8 @@ sub new {
                'psgi.multiprocess' => Plack::Util::TRUE,
                'psgix.harakiri'=> Plack::Util::FALSE,
                'psgix.input.buffered' => Plack::Util::TRUE,
+
+               # XXX unstable API!
                'pi-httpd.async' => do {
                        no warnings 'once';
                        *pi_httpd_async