DOC: sample: Add a comment in 'check_operator' to explain why 'vars_check_arg' should...

This extra comment ensure that we do not try to pass an 'err' argument
to 'vars_check_arg' otherwise some warnings will be raised if an
operator is given an integer directly in the configuration file.

diff --git a/src/sample.c b/src/sample.c
index bb7db28e797798e17f27b9f0f8e0bd360b78f65c..57cb7c6f826652c32b7cb5da8b9c65b1e45f4cc9 100644 (file)
--- a/src/sample.c
+++ b/src/sample.c
@@ -3155,7 +3155,10 @@ static int check_operator(struct arg *args, struct sample_conv *conv,
        const char *end;
        long long int i;
 
-       /* Try to decode a variable. */
+       /* Try to decode a variable. The 'err' variable is intentionnaly left
+        * NULL since the operators accept an integer as argument in which case
+        * vars_check_arg call will fail.
+        */
        if (vars_check_arg(&args[0], NULL))
                return 1;