From 33705736149a44d4886cb165b6d16b9e48ac21ed Mon Sep 17 00:00:00 2001 From: Vojtech Trefny Date: Mon, 8 Apr 2024 09:01:55 +0200 Subject: [PATCH] utils: Clarify usage of version in bd_utils_check_util_version --- src/utils/exec.c | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/src/utils/exec.c b/src/utils/exec.c index fd7257b9..982e9ca2 100644 --- a/src/utils/exec.c +++ b/src/utils/exec.c @@ -727,6 +727,10 @@ gint bd_utils_version_cmp (const gchar *ver_string1, const gchar *ver_string2, G * info or %NULL if only version is printed by "$ @util @version_arg" * @error: (out) (optional): place to store error (if any) * + * Note: Both supplied @version and parsed result using @version_regexp must be in format + * `X[.Y[.Z[.Z2[.Z3...[-R]]]]]` where all components are natural numbers, see + * %bd_utils_version_cmp for details. + * * Returns: whether the @util is available in a version >= @version or not * (@error is set in such case). */