clarify the documentation on what's expected from LoadX509

2014-01-29 04:41:18 +00:00 · 2014-01-29 04:41:18 +00:00 · a59f8b334a
commit a59f8b334a
parent a96e575243
1 changed files with 2 additions and 1 deletions
--- a/core/Network/TLS/Credentials.hs
+++ b/core/Network/TLS/Credentials.hs
@ -31,7 +31,8 @@ instance Monoid Credentials where
    mappend (Credentials l1) (Credentials l2) = Credentials (l1 ++ l2)

 -- | try to create a new credential object from a public certificate
-- and the associated private key.
+-- and the associated private key that are stored on the filesystem
+-- in PEM format.
 credentialLoadX509 :: FilePath -- ^ public certificate (X.509 format)
                   -> FilePath -- ^ private key associated
                   -> IO (Either String Credential)