From: Lennart Poettering <lennart@poettering.net>
Date: Tue, 18 Jun 2024 09:43:58 +0000 (+0200)
Subject: sd-json.h: reword SD_JSON_WARNING/SD_JSON_DEBUG comments
X-Git-Tag: v257-rc1~1095^2~2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=90cfb61c71dd3b26f9c6e8113bd25c4a3fee400d;p=thirdparty%2Fsystemd.git

sd-json.h: reword SD_JSON_WARNING/SD_JSON_DEBUG comments

Even though we don't export json_log() in the public API, let's
officially make the SD_JSON_WARNING/SD_JSON_DEBUG that control its
effect in the public API.

After all, for our own dispatcher functions they have a nice effect, and
they are trivially reimplemented in user code independently.

(We might eventually consider exporting json_log() as public API, but
this is quite involved, given its use of macros/inline functions and
iternal logging API).

This mostly just swaps around the bit flags and cleans up comments.
---

diff --git a/src/systemd/sd-json.h b/src/systemd/sd-json.h
index db37821f3ae..5c6ca18951d 100644
--- a/src/systemd/sd-json.h
+++ b/src/systemd/sd-json.h
@@ -269,23 +269,20 @@ typedef int (*sd_json_build_callback_t)(sd_json_variant **ret, const char *name,
 int sd_json_build(sd_json_variant **ret, ...);
 int sd_json_buildv(sd_json_variant **ret, va_list ap);
 
-/* A bitmask of flags used by the dispatch logic. Note that this is a combined bit mask, that is generated from the bit
- * mask originally passed into json_dispatch(), the individual bitmask associated with the static sd_json_dispatch callout
- * entry, as well the bitmask specified for json_log() calls */
+/* A bitmask of flags used by the dispatch logic. Note that this is a combined bit mask, that is generated
+ * from the bit mask originally passed into sd_json_dispatch() and the individual bitmask associated with the
+ * static sd_json_dispatch_field callout entry */
 typedef enum sd_json_dispatch_flags_t {
-        /* The following three may be set in sd_json_dispatch's .flags field or the json_dispatch() flags parameter  */
         SD_JSON_PERMISSIVE       = 1 << 0, /* Shall parsing errors be considered fatal for this field or object? */
         SD_JSON_MANDATORY        = 1 << 1, /* Should existence of this property be mandatory? */
-        SD_JSON_LOG              = 1 << 2, /* Should the parser log about errors? */
-        SD_JSON_STRICT           = 1 << 3, /* Use slightly stricter validation than usually (means different things for different dispatchers, for example: don't accept "unsafe" strings in json_dispatch_string() + json_dispatch_string()) */
-        SD_JSON_RELAX            = 1 << 4, /* Use slightly more relaxed validation than usually (similar, for example: relaxed user name checking in json_dispatch_user_group_name()) */
-        SD_JSON_ALLOW_EXTENSIONS = 1 << 5, /* Subset of JSON_PERMISSIVE: allow additional fields, but no other permissive handling */
-        SD_JSON_NULLABLE         = 1 << 6, /* Allow both specified type and null for this field */
-        SD_JSON_REFUSE_NULL      = 1 << 7, /* Never allow null, even if type is otherwise not specified */
-
-        /* The following two may be passed into log_json() in addition to those above */
-        SD_JSON_DEBUG            = 1 << 8, /* Indicates that this log message is a debug message */
-        SD_JSON_WARNING          = 1 << 9  /* Indicates that this log message is a warning message */
+        SD_JSON_LOG              = 1 << 2, /* Should the dispatcher log about errors? */
+        SD_JSON_DEBUG            = 1 << 3, /* When logging about errors use LOG_DEBUG log level at most */
+        SD_JSON_WARNING          = 1 << 4, /* When logging about errors use LOG_WARNING log level at most */
+        SD_JSON_STRICT           = 1 << 5, /* Use slightly stricter validation than usually (means different things for different dispatchers, for example: don't accept "unsafe" strings in json_dispatch_string() + json_dispatch_strv()) */
+        SD_JSON_RELAX            = 1 << 6, /* Use slightly more relaxed validation than usually (similar, for example: relaxed user name checking in json_dispatch_user_group_name()) */
+        SD_JSON_ALLOW_EXTENSIONS = 1 << 7, /* Subset of JSON_PERMISSIVE: allow additional fields, but no other permissive handling */
+        SD_JSON_NULLABLE         = 1 << 8, /* Allow both specified type and null for this field */
+        SD_JSON_REFUSE_NULL      = 1 << 9  /* Never allow null, even if type is otherwise not specified */
 } sd_json_dispatch_flags_t;
 
 typedef int (*sd_json_dispatch_callback_t)(const char *name, sd_json_variant *variant, sd_json_dispatch_flags_t flags, void *userdata);