X-Git-Url: http://git.cielonegro.org/gitweb.cgi?p=Lucu.git;a=blobdiff_plain;f=Network%2FHTTP%2FLucu%2FConfig.hs;h=68bc365ade7c2d950d2949b70c3a13d0b74ca144;hp=cdeef3b435305ae8e76a5630f07d5fb8f884c162;hb=9668dc2;hpb=f402841101b4b84f263eea1a43c848f81c48ff93

diff --git a/Network/HTTP/Lucu/Config.hs b/Network/HTTP/Lucu/Config.hs
index cdeef3b..68bc365 100644
--- a/Network/HTTP/Lucu/Config.hs
+++ b/Network/HTTP/Lucu/Config.hs
@@ -2,7 +2,7 @@
     OverloadedStrings
   , UnicodeSyntax
   #-}
--- |Configurations for the Lucu httpd like a port to listen.
+-- |Configurations for the Lucu httpd.
 module Network.HTTP.Lucu.Config
     ( Config(..)
     , SSLConfig(..)
@@ -19,18 +19,18 @@ import Network.HTTP.Lucu.MIMEType.DefaultExtensionMap
 import OpenSSL.Session
 import System.IO.Unsafe
 
--- |Configuration record for the Lucu httpd. You need to use
--- 'defaultConfig' or setup your own configuration to run the httpd.
+-- |Configuration record for to run the httpd.
 data Config = Config {
 
-    -- |A string which will be sent to clients as \"Server\" field.
+    -- |A banner string to be sent to clients with \"Server\" response
+    -- header field.
       cnfServerSoftware ∷ !Ascii
 
     -- |The host name of the server. This value will be used in
     -- built-in pages like \"404 Not Found\".
     , cnfServerHost ∷ !Text
 
-    -- |A port number (or service name) to listen to HTTP clients.
+    -- |A port number (or a service name) to listen to HTTP clients.
     , cnfServerPort ∷ !ServiceName
 
     -- |Local IPv4 address to listen to both HTTP and HTTPS
@@ -41,55 +41,54 @@ data Config = Config {
     -- |Local IPv6 address to listen to both HTTP and HTTPS
     -- clients. Set this to @('Just' "::")@ if you want to accept any
     -- IPv6 connections. Set this to 'Nothing' to disable IPv6. Note
-    -- that there is currently no way to assign separate ports to IPv4
-    -- and IPv6 server sockets.
+    -- that there is currently no ways to assign separate ports to
+    -- IPv4 and IPv6 server sockets (but I don't think that will be a
+    -- problem.)
     , cnfServerV6Addr ∷ !(Maybe HostName)
 
     -- |Configuration for HTTPS connections. Set this 'Nothing' to
     -- disable HTTPS.
     , cnfSSLConfig ∷ !(Maybe SSLConfig)
 
-    -- |The maximum number of requests to accept in one connection
-    -- simultaneously. If a client exceeds this limitation, its last
+    -- |The maximum number of requests to simultaneously accept in one
+    -- connection. If a client exceeds this limitation, its last
     -- request won't be processed until a response for its earliest
     -- pending request is sent back to the client.
     , cnfMaxPipelineDepth ∷ !Int
 
-    -- |The maximum length of request entity to accept in bytes. Note
-    -- that this is nothing but a default value which is used when
-    -- 'Network.HTTP.Lucu.Resource.getForm' and such like are applied
-    -- to 'Network.HTTP.Lucu.Resource.defaultLimit', so there is no
-    -- guarantee that this value always constrains all the requests.
+    -- |The maximum length of request entity to accept in octets. Note
+    -- that this is nothing but a default value used by
+    -- 'Network.HTTP.Lucu.Resource.getForm' and such when they are
+    -- applied to 'Network.HTTP.Lucu.Resource.defaultLimit', so there
+    -- is no guarantee that this value always constrains all the
+    -- requests.
     , cnfMaxEntityLength ∷ !Int
 
-    -- | Whether to dump too late abortion to the stderr or not. See
+    -- |Whether to dump too late abortions to the stderr or not. See
     -- 'Network.HTTP.Lucu.Abortion.abort'.
     , cnfDumpTooLateAbortionToStderr ∷ !Bool
 
-    -- |A mapping from extension to MIME Type. This value is used by
-    -- 'Network.HTTP.Lucu.StaticFile.staticFile' to guess the MIME
-    -- Type of static files. Note that MIME Types are currently
-    -- guessed only by file name. 
+    -- |A mapping table from file extensions to MIME Types. This value
+    -- is used by 'Network.HTTP.Lucu.StaticFile.staticFile' to guess
+    -- the MIME Type of static files. Note that MIME Types are
+    -- currently guessed only by file name.
     -- 
-    -- Guessing by file magic is indeed a wonderful idea but that is
-    -- not implemented (yet). But, don't you think it's better a file
-    -- system got a MIME Type as a part of inode? Or it might be a
-    -- good idea to use GnomeVFS
-    -- (<http://developer.gnome.org/doc/API/2.0/gnome-vfs-2.0/>)
-    -- instead of vanilla FS.
+    -- Guessing by file magic might be a good idea but that's not
+    -- implemented (yet).
     , cnfExtToMIMEType ∷ !ExtMap
     }
 
 -- |Configuration record for HTTPS connections.
 data SSLConfig
     = SSLConfig {
-        -- |A port ID to listen to HTTPS clients. Local addresses
-        -- (both for IPv4 and IPv6) will be derived from the parent
-        -- 'Config'.
+        -- |A port number (or a service name) to listen to HTTPS
+        -- clients. Local addresses (both for IPv4 and IPv6) will be
+        -- derived from the parent 'Config'.
         sslServerPort ∷ !ServiceName
 
-        -- |An SSL context for accepting connections.
-      , sslContext    ∷ !SSLContext
+        -- |An SSL context for accepting connections. You must set it
+        -- up yourself with at least a server certification.
+      , sslContext ∷ !SSLContext
       }
 
 -- |The default configuration. Generally you can use this value as-is,