Skip to contentSkip to conversation

networking: fix doc for net_iface_new() API

PATCH In review Antonio Quartulli 3 participants 3 messages Jul 5, 2022

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 networking: fix doc for net_iface_new() API

Some auto correction must have sneaked in.
Restore proper wording.

---
 src/openvpn/networking.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
src/openvpn/networking.h +2 -1
index 647718e0..79963756 100644
@@ -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);
Signature · 1 line
2.35.1
Acked-by on v1 1/1
#1 lore raw
Quoted 13 lines · On Dienstag, 5. Juli 2022 11:18:42 CEST Antonio Quartulli wrote:

Some auto correction must have sneaked in.
Restore proper wording.

---
 src/openvpn/networking.h | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)
src/openvpn/networking.h +0 -0
index 647718e0..79963756 100644

src/openvpn/networking.h void net_ctx_free(openvpn_net_ctx_t *ctx); · line 101

Quoted 9 lines
src/openvpn/networking.h +2 -1
@@ -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);
#2 lore raw
In reply to Antonio Quartulli

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 <[email protected]...>
     Acked-by: Heiko Hund <[email protected]...>
     Message-Id: <[email protected]...>
     URL: https://www.mail-archive.com/[email protected]/msg24636.html
     Signed-off-by: Gert Doering <[email protected]...>

--
kind regards,

Gert Doering