journald: add comment explaining journal rate limit return codes

This is not obvious, hence let's add a comment.

diff --git a/src/journal/journald-rate-limit.c b/src/journal/journald-rate-limit.c
index f48639cf58c23960ce593e968493a0058adc811c..a3404222e0c007d0887102a303c490024c64d272 100644 (file)
--- a/src/journal/journald-rate-limit.c
+++ b/src/journal/journald-rate-limit.c
@@ -216,6 +216,13 @@ int journal_rate_limit_test(JournalRateLimit *r, const char *id, int priority, u
 
         assert(id);
 
+        /* Returns:
+         *
+         * 0     → the log message shall be suppressed,
+         * 1 + n → the log message shall be permitted, and n messages were dropped from the peer before
+         * < 0   → error
+         */
+
         if (!r)
                 return 1;