Add more detailed explanation regarding the function of "--rdns-internal"

As agreed in last thursday's IRC meeting [1], I've added a comment to the
code explaining "--rdns-internal".  It's really very much an internal
option, so it does not need to go to the man page.

[1] http://thread.gmane.org/gmane.network.openvpn.devel/4573

Signed-off-by: Gert Doering <gert@greenie.muc.de>
Acked-by: David Sommerseth <davids@redhat.com>
Signed-off-by: David Sommerseth <davids@redhat.com>

diff --git a/options.c b/options.c
index f4897554868405715cdaef1909a959e3ccc902fc..deb6d23c2769c1239117d00801504c1f7fb875f5 100644 (file)
--- a/options.c
+++ b/options.c
@@ -5352,7 +5352,13 @@ add_option (struct options *options,
       VERIFY_PERMISSION (OPT_P_IPWIN32);
       options->tuntap_options.register_dns = true;
     }
-  else if (streq (p[0], "rdns-internal")) /* standalone method for internal use */
+  else if (streq (p[0], "rdns-internal"))
+     /* standalone method for internal use
+      *
+      * (if --register-dns is set, openvpn needs to call itself in a
+      *  sub-process to execute the required functions in a non-blocking
+      *  way, and uses --rdns-internal to signal that to itself)
+      */
     {
       VERIFY_PERMISSION (OPT_P_GENERAL);
       set_debug_level (options->verbosity, SDL_CONSTRAIN);