From: Justin Pettit <jpettit@nicira.com>
Date: Tue, 5 Jan 2010 08:08:34 +0000 (-0800)
Subject: vconn: Add comment describing usage of VCONN_SSL_LONG_OPTIONS
X-Git-Tag: v0.99.0~4
X-Git-Url: http://git.onelab.eu/?a=commitdiff_plain;h=1b656aa878f8cd667e7700fe52e8a1ca3cb51781;hp=87c8489148d5e6d44b1d55f1325658222852232c;p=sliver-openvswitch.git

vconn: Add comment describing usage of VCONN_SSL_LONG_OPTIONS
---

diff --git a/lib/vconn-ssl.h b/lib/vconn-ssl.h
index 551e2ebc1..564d30333 100644
--- 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'}, \