summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilip Withnall <pwithnall@endlessos.org>2022-10-24 18:14:57 +0100
committerMichael Catanzaro <mcatanzaro@redhat.com>2023-03-24 08:55:50 -0500
commit88bbf60b61e4aada5b8ebd7deb91fff1f25e60c2 (patch)
tree0a1b2452ccdbf763c7a3978ef3900087f7b7fdac
parent24ac75fab0b869fbf7e2cb970974ba59bc1a8a10 (diff)
downloadglib-88bbf60b61e4aada5b8ebd7deb91fff1f25e60c2.tar.gz
gvariant: Clarify the docs for g_variant_get_normal_form()
Document how non-normal parts of the `GVariant` are handled. Signed-off-by: Philip Withnall <pwithnall@endlessos.org>
-rw-r--r--glib/gvariant.c4
1 files changed, 3 insertions, 1 deletions
diff --git a/glib/gvariant.c b/glib/gvariant.c
index 3e1adffaa..2a6aaa1f4 100644
--- a/glib/gvariant.c
+++ b/glib/gvariant.c
@@ -5879,7 +5879,9 @@ g_variant_deep_copy (GVariant *value)
* marked as trusted and a new reference to it is returned.
*
* If @value is found not to be in normal form then a new trusted
- * #GVariant is created with the same value as @value.
+ * #GVariant is created with the same value as @value. The non-normal parts of
+ * @value will be replaced with default values which are guaranteed to be in
+ * normal form.
*
* It makes sense to call this function if you've received #GVariant
* data from untrusted sources and you want to ensure your serialised