From b6740aa1f67fea4d9a0bfc2c4f9ffb8f1edcf4da Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Loi=CC=88c=20Correnson?= <loic.correnson@cea.fr>
Date: Mon, 10 Feb 2020 16:09:55 +0100
Subject: [PATCH] [server] doc on start/run

---
 src/plugins/server/main.mli | 9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/src/plugins/server/main.mli b/src/plugins/server/main.mli
index 4c4da8678f1..acd7ef46c6b 100644
--- a/src/plugins/server/main.mli
+++ b/src/plugins/server/main.mli
@@ -83,10 +83,15 @@ val create :
   fetch:(unit -> 'a message option) ->
   unit -> 'a server
 
-(** Run the server forever. *)
+(** Run the server forever.
+    The function will not return until the server is shut down. *)
 val run : 'a server -> unit
 
-(** Start the server in background. *)
+(** Start the server in background.
+    The function returns immediately
+    after installing a daemon that accepts GET requests received by
+    the server on calls to `Db.yield()`.
+*)
 val start : 'a server -> unit
 
 (** Stop the server if it is running in background. *)
-- 
GitLab