Expanded comment in binding.gyp

ewr · Oct 9, 2015 · 15def98 · 15def98
1 parent eb185de
commit 15def98
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/binding.gyp b/binding.gyp
@@ -44,6 +44,10 @@
   'target_defaults': {
       # Emperically, Node only exports ALPN symbols if its major version is >0.
       # io.js always reports versions >0 and always exports ALPN symbols.
+      # Therefore, Node's major version will be truthy if and only if it
+      # supports ALPN. The output of "node -v" is v[major].[minor].[patch],
+      # like "v4.1.1" in a recent version. We use grep to extract just the
+      # major version. "4", would be the output for the example.
     'defines': [
       'TSI_OPENSSL_ALPN_SUPPORT=<!(node -v | grep -oP "(?<=v)(\d+)(?=\.\d+\.\d+)")'
     ],

diff --git a/templates/binding.gyp.template b/templates/binding.gyp.template
@@ -46,6 +46,10 @@
     'target_defaults': {
         # Emperically, Node only exports ALPN symbols if its major version is >0.
         # io.js always reports versions >0 and always exports ALPN symbols.
+        # Therefore, Node's major version will be truthy if and only if it
+        # supports ALPN. The output of "node -v" is v[major].[minor].[patch],
+        # like "v4.1.1" in a recent version. We use grep to extract just the
+        # major version. "4", would be the output for the example.
       'defines': [
         'TSI_OPENSSL_ALPN_SUPPORT=<!(node -v | grep -oP "(?<=v)(\d+)(?=\.\d+\.\d+)")'
       ],