diff mbox series

[Openvpn-devel] networking: fix doc for net_iface_new() API

Message ID 20220705091842.24053-1-a@unstable.cc
State Accepted
Headers
Series [Openvpn-devel] networking: fix doc for net_iface_new() API |

Commit Message

Antonio Quartulli July 4, 2022, 11:18 p.m. UTC 
  Some auto correction must have sneaked in.
Restore proper wording.

Signed-off-by: Antonio Quartulli <a@unstable.cc>
---
 src/openvpn/networking.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Heiko Hund July 5, 2022, 2:38 a.m. UTC | #1 
On Dienstag, 5. Juli 2022 11:18:42 CEST Antonio Quartulli wrote:
> Some auto correction must have sneaked in.
> Restore proper wording.
> 
> Signed-off-by: Antonio Quartulli <a@unstable.cc>
> ---
>  src/openvpn/networking.h | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/src/openvpn/networking.h b/src/openvpn/networking.h
> index 647718e0..79963756 100644
> --- a/src/openvpn/networking.h
> +++ b/src/openvpn/networking.h
> @@ -94,7 +94,8 @@ void net_ctx_free(openvpn_net_ctx_t *ctx);
>   * @param iface     interface to create
>   * @param type      string describing interface type
>   * @param arg       extra data required by the specific type
> - * @return int 0 on success, negative error code on error
> + *
> + * @return          0 on success, negative error code on error
>   */
>  int net_iface_new(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface,
> const char *type, void *arg);

Acked-by: Heiko Hund <heiko@ist.eigentlich.net>
Gert Doering July 5, 2022, 10:29 a.m. UTC | #2 
Easy enough ;-) - Heiko just beat me to ACKing it.

Have not tested anything!

Your patch has been applied to the master branch.

commit d5315a5d7400a26f1113bbc44766d49dd0c3688f
Author: Antonio Quartulli
Date:   Tue Jul 5 11:18:42 2022 +0200

     networking: fix doc for net_iface_new() API

     Signed-off-by: Antonio Quartulli <a@unstable.cc>
     Acked-by: Heiko Hund <heiko@ist.eigentlich.net>
     Message-Id: <20220705091842.24053-1-a@unstable.cc>
     URL: https://www.mail-archive.com/openvpn-devel@lists.sourceforge.net/msg24636.html
     Signed-off-by: Gert Doering <gert@greenie.muc.de>


--
kind regards,

Gert Doering
diff mbox series

Patch

diff --git a/src/openvpn/networking.h b/src/openvpn/networking.h
index 647718e0..79963756 100644
--- a/src/openvpn/networking.h
+++ b/src/openvpn/networking.h
@@ -94,7 +94,8 @@  void net_ctx_free(openvpn_net_ctx_t *ctx);
  * @param iface     interface to create
  * @param type      string describing interface type
  * @param arg       extra data required by the specific type
- * @return int 0 on success, negative error code on error
+ *
+ * @return          0 on success, negative error code on error
  */
 int net_iface_new(openvpn_net_ctx_t *ctx, const openvpn_net_iface_t *iface,
                   const char *type, void *arg);