tls: fix/annotate connect arg comments

PR-URL: https://github.com/nodejs/node/pull/9800
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>

1 files changed, 6 insertions, 1 deletions

diff --git a/lib/_tls_wrap.js b/lib/_tls_wrap.js
index d9dafceb95..b57a40a3be 100644
--- a/lib/_tls_wrap.js
+++ b/lib/_tls_wrap.js
@@ -975,6 +975,11 @@ function normalizeConnectArgs(listArgs) {
   var options = args[0];
   var cb = args[1];
 
+  // If args[0] was options, then normalize dealt with it.
+  // If args[0] is port, or args[0], args[1]  is host,port, we need to
+  // find the options and merge them in, normalize's options has only
+  // the host/port/path args that it knows about, not the tls options.
+  // This means that options.host overrides a host arg.
   if (listArgs[1] !== null && typeof listArgs[1] === 'object') {
     options = util._extend(options, listArgs[1]);
   } else if (listArgs[2] !== null && typeof listArgs[2] === 'object') {
@@ -984,7 +989,7 @@ function normalizeConnectArgs(listArgs) {
   return (cb) ? [options, cb] : [options];
 }
 
-exports.connect = function(/* [port, host], options, cb */) {
+exports.connect = function(/* [port,] [host,] [options,] [cb] */) {
   const argsLen = arguments.length;
   var args = new Array(argsLen);
   for (var i = 0; i < argsLen; i++)