vconn: Add comment describing usage of VCONN_SSL_LONG_OPTIONS

diff --git a/lib/vconn-ssl.h b/lib/vconn-ssl.h
index 551e2ebc1b85ac827caee653555c0488b9c2efb4..564d303337b821286ef8fdd83b7bb63d429aa7dc 100644 (file)
--- a/lib/vconn-ssl.h
+++ b/lib/vconn-ssl.h
@@ -25,6 +25,11 @@ void vconn_ssl_set_certificate_file(const char *file_name);
 void vconn_ssl_set_ca_cert_file(const char *file_name, bool bootstrap);
 void vconn_ssl_set_peer_ca_cert_file(const char *file_name);
 
+/* Define the long options for SSL support.
+ *
+ * Note that the definition includes a final comma, and therefore a comma 
+ * must not be supplied when using the definition.  This is done so that 
+ * compilation succeeds whether or not HAVE_OPENSSL is defined. */
 #define VCONN_SSL_LONG_OPTIONS                      \
         {"private-key", required_argument, 0, 'p'}, \
         {"certificate", required_argument, 0, 'c'}, \