doc UPDATE clarify how to start the server for tests

CESNET · May 21, 2024 · 9c5f344 · 9c5f344
1 parent 3b52f0a
commit 9c5f344
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/CMakeLists.txt b/lib/CMakeLists.txt
@@ -33,6 +33,9 @@ if(NETOPEER2_LIB_TESTS)
 "/**
   * @brief Start netopeer2-server for all the test clients.
   *
+  * After the server is started, this function MUST return meaning a child
+  * process or something similar needs to be created.
+  *
   * Function implementation NEEDS TO BE PROVIDED.
   *
   * @param[in] pidfile_path Path to the server PID file.