From 1ee35cb6380d3d8469976b3a31c0d2d1ff99f11d Mon Sep 17 00:00:00 2001 From: Thomas Haller Date: Mon, 27 Feb 2023 15:50:44 +0100 Subject: [PATCH] cloud-setup/trivial: fix gtkdoc comment for nmcs_utils_poll() @probe_start_fcn is not called the first time synchronously. Fix the comment. While at it, reword a bit. --- src/nm-cloud-setup/nm-cloud-setup-utils.c | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/src/nm-cloud-setup/nm-cloud-setup-utils.c b/src/nm-cloud-setup/nm-cloud-setup-utils.c index cb8e9f559c..bdbea7ec73 100644 --- a/src/nm-cloud-setup/nm-cloud-setup-utils.c +++ b/src/nm-cloud-setup/nm-cloud-setup-utils.c @@ -304,14 +304,15 @@ _poll_cancelled_cb(GObject *object, gpointer user_data) * @poll_timeout_ms: if >= 0, then this is the overall timeout for how long we poll. * When this timeout expires, the request completes with failure (and error set). * @ratelimit_timeout_ms: if > 0, we ratelimit the starts from one prope_start_fcn - * call to the next. + * call to the next. We will wait at least this time between two consecutive polls. * @sleep_timeout_ms: if > 0, then we wait after a probe finished this timeout * before the next. Together with @ratelimit_timeout_ms this determines how - * frequently we probe. - * @probe_start_fcn: used to start a (asynchronous) probe. A probe must be completed - * by calling the provided callback. While a probe is in progress, we will not - * start another. This function is already invoked the first time synchronously, - * during nmcs_utils_poll(). + * frequently we probe. We will wait at least this time between the end of the + * previous poll and the next one. + * @probe_start_fcn: used to start a (asynchronous) probe. A probe must be + * completed by calling the provided callback. While a probe is in progress, we + * will not start another. The function is called the first time on an idle + * handler, afterwards it gets called again on each timeout for polling. * @probe_finish_fcn: will be called from the callback of @probe_start_fcn. If the * function returns %TRUE (polling done) or an error, polling stops. Otherwise, * another poll will be started.