From: silverwind <me@silverwind.io>
Date: Thu, 26 Feb 2015 14:36:41 +0000 (+0100)
Subject: doc: fix 'dhparam' description of tls.createServer
X-Git-Tag: v1.4.1~3
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c5050d8e4d16e59a2bf24da420f84192d6f3d872;p=platform%2Fupstream%2Fnodejs.git

doc: fix 'dhparam' description of tls.createServer

fixes #958

Fixes: https://github.com/iojs/io.js/issues/958
PR-URL: https://github.com/iojs/io.js/pull/968
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
---

diff --git a/doc/api/tls.markdown b/doc/api/tls.markdown
index 910ca5e..ea9b6cd 100644
--- a/doc/api/tls.markdown
+++ b/doc/api/tls.markdown
@@ -158,9 +158,10 @@ automatically set as a listener for the [secureConnection][] event.  The
 
     Defaults to `prime256v1`. Consult [RFC 4492] for more details.
 
-  - `dhparam`: DH parameter file to use for DHE key agreement. Use
-    `openssl dhparam` command to create it. If the file is invalid to
-    load, it is silently discarded.
+  - `dhparam`: A string or `Buffer` containing Diffie Hellman parameters,
+    required for Perfect Forward Secrecy. Use `openssl dhparam` to create it.
+    If omitted or invalid, it is silently discarded and DHE ciphers won't be
+    available.
 
   - `handshakeTimeout`: Abort the connection if the SSL/TLS handshake does not
     finish in this many milliseconds. The default is 120 seconds.