From: Greg Cox Date: Sun, 24 Jan 2021 23:46:13 +0000 (+0000) Subject: Documentation fixes around openvpn_plugin_func_v3 in openvpn-plugin.h.in X-Git-Tag: v2.5.1~5 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c6013abe860e8c76e132e98458fef7122a1622c0;p=thirdparty%2Fopenvpn.git Documentation fixes around openvpn_plugin_func_v3 in openvpn-plugin.h.in The comments refered to parameters found in openvpn_plugin_func_v2 but not in v3 Acked-by: David Sommerseth Message-Id: <1611531973-443-1-git-send-email-gcox@mozilla.com> URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg21481.html Signed-off-by: Gert Doering (cherry picked from commit 595be121b60f8cee9d4816172a7f9a4987560641) --- diff --git a/include/openvpn-plugin.h.in b/include/openvpn-plugin.h.in index 64b20886e..b73b74533 100644 --- a/include/openvpn-plugin.h.in +++ b/include/openvpn-plugin.h.in @@ -670,12 +670,12 @@ OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_open_v3) * ARGUMENTS * * version : fixed value, defines the API version of the OpenVPN plug-in API. The plug-in - * should validate that this value is matching the OPENVPN_PLUGIN_VERSION value. + * should validate that this value is matching the OPENVPN_PLUGINv3_STRUCTVER + * value. * - * handle : the openvpn_plugin_handle_t value which was returned by - * openvpn_plugin_open. + * arguments : Structure with all arguments available to the plug-in. * - * return_list : used to return data back to OpenVPN. + * retptr : used to return data back to OpenVPN. * * RETURN VALUE * @@ -736,8 +736,8 @@ OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_open_v3) * A given client or subnet rule applies to both incoming and outgoing * packets. * - * See plugin/defer/simple.c for an example on using asynchronous - * authentication and client-specific packet filtering. + * See sample/sample-plugins/defer/simple.c for an example on using + * asynchronous authentication and client-specific packet filtering. */ OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_func_v3) (const int version,