CLEANUP: mworker/cli: add comments about pcli_find_and_exec_kw()

Add a comment about the pcli_find_and_exec_kw().

diff --git a/src/cli.c b/src/cli.c
index 24c395033357dc9e53dfeffbf6e4905407e1a764..0bbc960a6026f200ccf8dce3f5a3a94775b25739 100644 (file)
--- a/src/cli.c
+++ b/src/cli.c
@@ -2453,8 +2453,13 @@ static int pcli_prefix_to_pid(const char *prefix)
        return -1;
 }
 
-/* Return::
- *  >= 0 : number of words to escape
+/*
+ * pcli_find_and_exec_kw() parses a command for the master CLI.  It looks for a
+ * prefix or a command that is handled directly by the proxy and never sent to
+ * a worker.
+ *
+ * Return:
+ *  >= 0 : number of words that were parsed and need to be skipped
  *  = -1 : error
  */
 int pcli_find_and_exec_kw(struct stream *s, char **args, int argl, char **errmsg, int *next_pid)