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>
This commit is contained in:
Philip Withnall 2022-10-24 18:14:57 +01:00
parent 4c0ddb26bc
commit 35dee77ed8

View File

@ -5936,7 +5936,9 @@ g_variant_deep_copy (GVariant *value)
* marked as trusted and a new reference to it is returned. * 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 * 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 * It makes sense to call this function if you've received #GVariant
* data from untrusted sources and you want to ensure your serialized * data from untrusted sources and you want to ensure your serialized