lib/yahns.rb in yahns-1.17.0 vs lib/yahns.rb in yahns-1.18.0

@@ -1,7 +1,7 @@
-# Copyright (C) 2013-2016 all contributors <[e-mail]>
-# License: GPL-3.0+ (https://www.gnu.org/licenses/gpl-3.0.txt)
+# Copyright (C) 2013-2019 all contributors <[e-mail]>
+# License: GPL-3.0+ <https://www.gnu.org/licenses/gpl-3.0.txt>
 # frozen_string_literal: true
 $stdout.sync = $stderr.sync = true
 
 require 'unicorn' # pulls in raindrops, kgio, fcntl, etc, stringio, and logger
 require 'sleepy_penguin'
@@ -14,15 +14,18 @@
   :SSLConfigurator, :Configurator, :TmpIO, :Util, :Worker, :SSLServer,
   :HttpServer ].each do |sym|
     Unicorn.__send__(:remove_const, sym) if Unicorn.const_defined?(sym)
 end
 
-# yahns exposes no user-visible API outside of the config file.
-# See https://yhbt.net/yahns.git/tree/examples/yahns_config.txt
-# for the config documentation
+# yahns exposes little user-visible API outside of the config file.
+# See https://yhbt.net/yahns/yahns_config.txt
+# for the config documentation (or yahns_config(5) manpage)
 # and https://yhbt.net/yahns.git/about/ for the homepage.
-# Internals are subject to change.
-
+#
+# Yahns::ProxyPass is currently the only public API.
+#
+# Documented APIs and options are supported forever,
+# internals are subject to change.
 module Yahns
   # :stopdoc:
   # We populate this at startup so we can figure out how to reexecute
   # and upgrade the currently running instance of yahns
   # Unlike unicorn, this Hash is NOT a stable/public interface.