luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-27 22:46:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

g_keyfile_settings_backend_new doc improvement

Browse Source
This commit is contained in:
Ryan Lortie 2010-06-24 02:21:58 -04:00
parent 123699465d
commit 887d9d83aa
1 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
gio/gkeyfilesettingsbackend.c
View File

@ -591,10 +591,10 @@ dir_changed (GFileMonitor *monitor,
* "toplevel", then settings the key "/apps/example/enabled" to a value * "toplevel", then settings the key "/apps/example/enabled" to a value
* of %TRUE will cause the following to appear in the keyfile: * of %TRUE will cause the following to appear in the keyfile:
* *
* <programlisting> * |[
* [toplevel] * [toplevel]
* foo=true * enabled=true
* </programlisting> * ]|
* *
* If @root_group is %NULL then it is not permitted to store keys * If @root_group is %NULL then it is not permitted to store keys
* directly below the @root_path. * directly below the @root_path.
@ -602,13 +602,13 @@ dir_changed (GFileMonitor *monitor,
* For keys not stored directly below @root_path (ie: in a sub-path), * For keys not stored directly below @root_path (ie: in a sub-path),
* the name of the subpath (with the final slash stripped) is used as * the name of the subpath (with the final slash stripped) is used as
* the name of the keyfile group. To continue the example, if * the name of the keyfile group. To continue the example, if
* were stored in "/apps/example/profiles/default/font-size" were set to * "/apps/example/profiles/default/font-size" were set to
* 12 then the following would appear in the keyfile: * 12 then the following would appear in the keyfile:
* *
* <programlisting> * |[
* [profiles/default] * [profiles/default]
* font-size=12 * font-size=12
* </programlisting> * ]|
* *
* The backend will refuse writes (and return writability as being * The backend will refuse writes (and return writability as being
* %FALSE) for keys outside of @root_path and, in the event that * %FALSE) for keys outside of @root_path and, in the event that
@ -616,6 +616,11 @@ dir_changed (GFileMonitor *monitor,
* Writes will also be refused if the backend detects that it has the * Writes will also be refused if the backend detects that it has the
* inability to rewrite the keyfile (ie: the containing directory is not * inability to rewrite the keyfile (ie: the containing directory is not
* writable). * writable).
*
* There is no checking done for your key namespace clashing with the
* syntax of the key file format. For example, if you have '[' or ']'
* characters in your path names or '=' in your key names you may be in
* trouble.
**/ **/
GSettingsBackend * GSettingsBackend *
g_keyfile_settings_backend_new (const gchar *filename, g_keyfile_settings_backend_new (const gchar *filename,