From 978779044844f9ff793c10395443639cac964e31 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Wed, 25 Nov 2015 21:37:13 -0500 Subject: [PATCH] GApplication: improve docs Spell out which GVariant format strings to use for which commandline option types. I just wasted some time debugging this in an application. --- gio/gapplication.c | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/gio/gapplication.c b/gio/gapplication.c index f45786562..98649b1c5 100644 --- a/gio/gapplication.c +++ b/gio/gapplication.c @@ -658,6 +658,17 @@ add_packed_option (GApplication *application, * consumed, they will no longer be visible to the default handling * (which treats them as filenames to be opened). * + * It is important to use the proper GVariant format when retrieving + * the options with g_variant_dict_lookup(): + * - for %G_OPTION_ARG_NONE, use b + * - for %G_OPTION_ARG_STRING, use &s + * - for %G_OPTION_ARG_INT, use i + * - for %G_OPTION_ARG_INT64, use x + * - for %G_OPTION_ARG_DOUBLE, use d + * - for %G_OPTION_ARG_FILENAME, use ^ay + * - for %G_OPTION_ARG_STRING_ARRAY, use &as + * - for %G_OPTION_ARG_FILENAME_ARRAY, use ^aay + * * Since: 2.40 */ void