[S] Change in openvpn[master]: doc: Update doxygen references to removed tunnel_server_{udp, tcp}()

Attention is currently required from: plaisthos.

Hello plaisthos,

I'd like you to do a code review.
Please visit

    http://gerrit.openvpn.net/c/openvpn/+/1850?usp=email

to review the following change.


Change subject: doc: Update doxygen references to removed tunnel_server_{udp,tcp}()
......................................................................

doc: Update doxygen references to removed tunnel_server_{udp,tcp}()

The point-to-multipoint server event loop is no longer split into
protocol-specific tunnel_server_udp() and tunnel_server_tcp()
functions; tunnel_server() now handles both UDP and TCP.

Update the Doxygen module documentation accordingly: list
tunnel_server() as the server-mode event loop implementation, and
rewrite the server-mode startup, initialization and cleanup sections
so that they describe tunnel_server() instead of the removed
functions.

Documentation only, no functional change.

Change-Id: I57b4122b292f643ddedd91e81bf95fe2f5b2e03a
Signed-off-by: Razvan Cojocaru <[email protected]>
---
M doc/doxygen/doc_eventloop.h
M doc/doxygen/doc_tunnel_state.h
2 files changed, 11 insertions(+), 14 deletions(-)



  git pull ssh://gerrit.openvpn.net:29418/openvpn refs/changes/50/1850/1

diff --git a/doc/doxygen/doc_eventloop.h b/doc/doxygen/doc_eventloop.h
index 55ecd73..4c1b012 100644
--- a/doc/doxygen/doc_eventloop.h
+++ b/doc/doxygen/doc_eventloop.h
@@ -60,6 +60,5 @@
  * event loop function is called to drive the event processing.  The
  * following implementations are available:
  * - Client mode using UDP or TCP: \c tunnel_point_to_point()
- * - Server mode using UDP: \c tunnel_server_udp()
- * - Server mode using TCP: \c tunnel_server_tcp()
+ * - Server mode using UDP or TCP: \c tunnel_server()
  */
diff --git a/doc/doxygen/doc_tunnel_state.h b/doc/doxygen/doc_tunnel_state.h
index 296e804..424f81e 100644
--- a/doc/doxygen/doc_tunnel_state.h
+++ b/doc/doxygen/doc_tunnel_state.h
@@ -117,10 +117,10 @@
  * tunnel_point_to_point() or \c tunnel_server().
  *
  * In server-mode, \c main() calls the \c tunnel_server() function, which
- * transfers control to \c tunnel_server_udp() or \c
- * tunnel_server_tcp() depending on the external transport protocol.
+ * drives the event loop for both the UDP and TCP external transport
+ * protocols.
  *
- * These functions receive the \c context created in \c main().  This
+ * This function receives the \c context created in \c main().  This
  * object has a special status in server-mode, as it does not represent an
  * active VPN tunnel, but does contain process-wide configuration
  * parameters.  In the source code, it is often stored in "top" variables.
@@ -130,11 +130,10 @@
  * CM_CHILD_UDP or \c CM_CHILD_TCP, depending on the external transport
  * protocol.
  *
- * Both \c tunnel_server_udp_single_threaded() and \c tunnel_server_tcp()
- * perform similar initialization.  In either case, a \c multi_context
- * structure is created, and it is initialized according to the
- * configuration stored in the top \c context by the \c multi_init() and
- * \c multi_top_init() functions.
+ * During initialization, \c tunnel_server() creates a \c multi_context
+ * structure, which is initialized according to the configuration stored
+ * in the top \c context by the \c multi_init() and \c multi_top_init()
+ * functions.
  *
  * @subsection tunnel_state_server_tunnels Creating and destroying VPN tunnels
  *
@@ -146,8 +145,7 @@
  *
  * @subsection tunnel_state_server_cleanup Final cleanup
  *
- * After the main event loop exits, both \c
- * tunnel_server_udp_single_threaded() and \c tunnel_server_tcp() perform
- * similar cleanup.  They call \c multi_uninit() followed by \c
- * multi_top_free() to clean up the \c multi_context structure.
+ * After the main event loop exits, \c tunnel_server() performs the
+ * cleanup.  It calls \c multi_uninit() followed by \c multi_top_free()
+ * to clean up the \c multi_context structure.
  */

-- 
To view, visit http://gerrit.openvpn.net/c/openvpn/+/1850?usp=email
To unsubscribe, or for help writing mail filters, visit http://gerrit.openvpn.net/settings?usp=email

Gerrit-MessageType: newchange
Gerrit-Project: openvpn
Gerrit-Branch: master
Gerrit-Change-Id: I57b4122b292f643ddedd91e81bf95fe2f5b2e03a
Gerrit-Change-Number: 1850
Gerrit-PatchSet: 1
Gerrit-Owner: razvanc <[email protected]>
Gerrit-Reviewer: plaisthos <[email protected]>
Gerrit-CC: openvpn-devel <[email protected]>
Gerrit-Attention: plaisthos <[email protected]>

_______________________________________________
Openvpn-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/openvpn-devel