[network-manager-openswan/dcbw/cleanups: 23/23] trivial: explain what actually executes the helper

[Dan Williams <dcbw src gnome org>]

commit b7c6bd823685acbd70c5c227b10983a6be83240b
Author: Dan Williams <dcbw redhat com>
Date:   Fri Aug 29 14:52:38 2014 -0500

    trivial: explain what actually executes the helper

 src/nm-openswan-service-helper.c |    4 ++++
 src/nm-openswan-service.c        |    5 +++++
 2 files changed, 9 insertions(+), 0 deletions(-)
---
diff --git a/src/nm-openswan-service-helper.c b/src/nm-openswan-service-helper.c
index 6634c6f..558de2b 100644
--- a/src/nm-openswan-service-helper.c
+++ b/src/nm-openswan-service-helper.c
@@ -364,6 +364,10 @@ addr_list_to_gvalue (const char *str)
  *    PLUTO_PEER_DOMAIN_INFO
  * PLUTO_PEER_BANNER         -- banner from server
  *
+ * NOTE: this helper is currently called explicitly by the ipsec up/down
+ * script /usr/libexec/ipsec/_updown.netkey when the configuration contains
+ * "nm_configured=yes".  Eventually we want to somehow pass the helper
+ * directly to pluto/whack with the --updown option.
  */
 int 
 main (int argc, char *argv[])
diff --git a/src/nm-openswan-service.c b/src/nm-openswan-service.c
index 24d1c4e..d62d39a 100644
--- a/src/nm-openswan-service.c
+++ b/src/nm-openswan-service.c
@@ -87,6 +87,11 @@ typedef struct {
 
 #define NM_OPENSWAN_PLUGIN_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), NM_TYPE_OPENSWAN_PLUGIN, 
NMOPENSWANPluginPrivate))
 
+/* NOTE: the helper is currently called explicitly by the ipsec up/down
+ * script /usr/libexec/ipsec/_updown.netkey when the configuration contains
+ * "nm_configured=yes".  Eventually we want to somehow pass the helper
+ * directly to pluto/whack with the --updown option.
+ */
 #define NM_OPENSWAN_HELPER_PATH                LIBEXECDIR"/nm-openswan-service-helper"
 
 #define DEBUG(...) \