Documentation fixes around openvpn_plugin_func_v3 in openvpn-plugin.h.in
PATCH 1/1 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
--- include/openvpn-plugin.h.in | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)
include/openvpn-plugin.h.in +6 -6
@@ -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,
Signature · 1 line
2.7.6
Quoted 28 lines · Greg Cox
The comments refered to parameters found in
openvpn_plugin_func_v2but not in v3--- include/openvpn-plugin.h.in | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-)include/openvpn-plugin.h.in +4
-4@@ -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 *
include/openvpn-plugin.h.in OPENVPN_PLUGIN_DEF int OPENVPN_PLUGIN_FUNC(openvpn_plugin_open_v3) · line 743
Quoted 10 lines
include/openvpn-plugin.h.in +2
-2@@ -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,
This looks correct, and also matches the description of the openvpn_plugin_open_v3() function, which has the same phrasing.
Thanks a lot!
Signature · 4 lines
kind regards, David Sommerseth OpenVPN Inc
Your patch has been applied to the master, release/2.5 and release/2.4 branch.
(Thanks, David. I thought it looked good, but you have worked with the plugin API for much longer :-) ).
commit 595be121b60f8cee9d4816172a7f9a4987560641 (master) commit c6013abe860e8c76e132e98458fef7122a1622c0 (release/2.5) commit 21f60d052e5f841f0689a83122beba40792d71ea (release/2.4)
Author: Greg Cox Date: Sun Jan 24 23:46:13 2021 +0000
Documentation fixes around openvpn_plugin_func_v3 in openvpn-plugin.h.in
Acked-by: David Sommerseth <[email protected]...>
Message-Id: <[email protected]...>
URL: https://www.mail-archive.com/[email protected]/msg21481.html
Signed-off-by: Gert Doering <[email protected]...>--
kind regards,
Gert Doering