diff mbox series

[Openvpn-devel] Documentation fixes around openvpn_plugin_func_v3 in openvpn-plugin.h.in

Message ID 1611531973-443-1-git-send-email-gcox@mozilla.com
State Accepted
Headers show
Series [Openvpn-devel] Documentation fixes around openvpn_plugin_func_v3 in openvpn-plugin.h.in | expand

Commit Message

Greg Cox Jan. 24, 2021, 12:46 p.m. UTC 
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(-)

Comments

David Sommerseth Jan. 27, 2021, 7:02 a.m. UTC | #1 
On 25/01/2021 00:46, Greg Cox wrote:
> 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(-)
> 
> diff --git a/include/openvpn-plugin.h.in b/include/openvpn-plugin.h.in
> index 64b20886eb364c9317fbb177abe827158b7e3018..b73b7453397344beda7543183fe989eda268a372 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,
> 

This looks correct, and also matches the description of the 
openvpn_plugin_open_v3() function, which has the same phrasing.

Thanks a lot!

Acked-By: David Sommerseth <davids@openvpn.net>
Gert Doering Jan. 27, 2021, 7:27 a.m. UTC | #2 
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 <davids@openvpn.net>
     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 <gert@greenie.muc.de>


--
kind regards,

Gert Doering
diff mbox series

Patch

diff --git a/include/openvpn-plugin.h.in b/include/openvpn-plugin.h.in
index 64b20886eb364c9317fbb177abe827158b7e3018..b73b7453397344beda7543183fe989eda268a372 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,