[glib/new-gsettings] document key name restrictions
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/new-gsettings] document key name restrictions
- Date: Fri, 16 Apr 2010 05:13:55 +0000 (UTC)
commit efbc932b30efe81fff2e6ba85b54187fddb503b2
Author: Matthias Clasen <mclasen redhat com>
Date: Fri Apr 16 01:11:57 2010 -0400
document key name restrictions
gio/gsettings.c | 10 +++++++---
1 files changed, 7 insertions(+), 3 deletions(-)
---
diff --git a/gio/gsettings.c b/gio/gsettings.c
index 1020ae8..80bb87b 100644
--- a/gio/gsettings.c
+++ b/gio/gsettings.c
@@ -43,7 +43,11 @@
*
* Unlike other configuration systems (like GConf), GSettings does not
* restrict keys to basic types like strings and numbers. GSettings stores
- * values as #GVariant, and allows any #GVariantType for keys.
+ * values as #GVariant, and allows any #GVariantType for keys. Key names
+ * are restricted to lowercase characters, numbers and '-'. Furthermore,
+ * the names must begin with a lowercase character, must not end
+ * with a '-', and must not contain consecutive dashes. Key names can
+ * be up to 32 characters long.
*
* Similar to GConf, the default values in GSettings schemas can be
* localized, but the localized values are stored in gettext catalogs
@@ -98,8 +102,8 @@
* ]|
*/
-/* XXX talk about key and schema naming conventions,
- * explain child settings
+/* TODO:
+ * Talk about schema naming conventions, explain child settings
*/
struct _GSettingsPrivate
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]