Document new files / changes

emmax86 · emmax86 · commit 44ae2b741ee3 · 2018-09-26T14:16:56.000-07:00
diff --git a/generate/templates/templates/binding.gyp b/generate/templates/templates/binding.gyp
@@ -40,7 +40,8 @@
             "action_name": "acquire",
             "action": ["node", "utils/acquireOpenSSL.js"],
             "inputs": ["vendor/openssl_distributions.json"],
-            "outputs": ["vendor/openssl"]
+            "outputs": ["vendor/openssl"],
+            "message": "Acquiring OpensSL binaries and headers"
           }]
         }]
       ]
diff --git a/utils/README.md b/utils/README.md
@@ -4,3 +4,18 @@
 
   #### buildFlags
   Determines how NodeGit should build. Use `BUILD_ONLY` environment variable to build from source.
+
+  ## discoverOpenSSLDistros
+  Crawls a series of static links on the [Conan package manager](https://conan.io/) for the [latest release of OpenSSL](https://bintray.com/conan-community/conan/OpenSSL%3Aconan#files/conan%2FOpenSSL%2F1.1.0i) (1.1.0i at the time of writing). It acquires statically linked binaries and header files of OpenSSL for Mac and Windows. The provided binaries are compiled on:
+  
+  * Mac: clang-8.1 or clang-9.
+  * Windows: vs12, vs14, vs15
+
+  The discovered distributions are written into `vendor/openssl_distributions.json`. This script does not need to be run unless you are updating the version of OpenSSL to build against.
+
+  ### acquireOpenSSL
+  Download the OpenSSL binaries and headers applicable to the current OS for the latest compiler version (clang-9/vs15).
+  
+  TODO:
+    * Make the script pull the debug versions if node-gyp is building in debug mode
+    * Make the script pull down a version of the binaries that matches the sytem compiler
diff --git a/utils/acquireOpenSSL.js b/utils/acquireOpenSSL.js
@@ -38,7 +38,7 @@ const getCompilerVersion = () => {
   }
 }
 
-const getIsDebug = () => true // TODO: Determine if we are GYPing in Debug
+const getIsDebug = () => false // TODO: Determine if we are GYPing in Debug
 
 const getMatchingDistributionName = () =>
   `${getOSName()}-${getCompilerVersion()}-static${getIsDebug() ? '-debug' : ''}`;
diff --git a/utils/configureLibssh2.js b/utils/configureLibssh2.js
@@ -18,6 +18,9 @@ module.exports = function retrieveExternalDependencies() {
     var opensslIncludes = isElectron ? path.join(opensslDir, "includes") : opensslDir;
 
     var newEnv = {};
+
+    // For some magic reason, MacOS fails to build if we copy over the current environment variables, but Linux
+    // builds fail if we DON'T copy over the current environment variables
     if (process.platform !== "darwin") {
       Object.keys(process.env).forEach(function(key) {
         newEnv[key] = process.env[key];

Original file line number	Diff line number	Diff line change
`@@ -38,7 +38,7 @@ const getCompilerVersion = () => {`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`
`41`		`-const getIsDebug = () => true // TODO: Determine if we are GYPing in Debug`
	`41`	`+const getIsDebug = () => false // TODO: Determine if we are GYPing in Debug`
`42`	`42`
`43`	`43`	`const getMatchingDistributionName = () =>`
`44`	`44`	`${getOSName()}-${getCompilerVersion()}-static${getIsDebug() ? '-debug' : ''}`;