From: William Lallemand <wlallemand@haproxy.com>
Date: Thu, 7 Dec 2023 17:02:29 +0000 (+0100)
Subject: CLEANUP: mworker/cli: add comments about pcli_find_and_exec_kw()
X-Git-Tag: v3.0-dev1~115
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=75a51dfc3f2f2d1bedbe8bc46340fdc677a7e6e9;p=thirdparty%2Fhaproxy.git

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 24c3950333..0bbc960a60 100644
--- 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)