Improve docs

svn path=/trunk/; revision=7704

diff --git a/ChangeLog b/ChangeLog
index 4f84849..da731ed 100644 (file)
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2008-11-28  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/gkeyfile.c: Refer to @locale parameters as locale identifier
+       in docs.
+
+2008-11-28  Matthias Clasen  <mclasen@redhat.com>
+
        Bug 557603 – carbon check output misplaced
 
        * configure.in: Call AC_PROG_CPP early to avoid it messing up

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 0adf39b..2e8e139 100644 (file)
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,5 +1,10 @@
 @008-11-28  Matthias Clasen  <mclasen@redhat.com>
 
+       * glib/tmpl/keyfile.sgml: Explain locale identifiers in
+       more detail
+
+@008-11-28  Matthias Clasen  <mclasen@redhat.com>
+
        Bug 562549 – g_byte_array_free should tell how free data
 
        * glib/tmpl/arrays_byte.sgml: Improve docs, proposed by

diff --git a/docs/reference/glib/tmpl/keyfile.sgml b/docs/reference/glib/tmpl/keyfile.sgml
index bcc0371..18ce443 100644 (file)
--- a/docs/reference/glib/tmpl/keyfile.sgml
+++ b/docs/reference/glib/tmpl/keyfile.sgml
@@ -34,8 +34,9 @@ Name=Key File Example\tthis value shows\nescaping
 # localized strings are stored in multiple key-value pairs
 Welcome=Hello
 Welcome[de]=Hallo
-Welcome[fr]=Bonjour
+Welcome[fr_FR]=Bonjour
 Welcome[it]=Ciao
+Welcome[be@latin]=Hello
 
 [Another Group]
 
@@ -58,7 +59,9 @@ the end of the file. Each key-value pair must be contained in a group.
 <para>
 Key-value pairs generally have the form <literal>key=value</literal>, 
 with the exception of localized strings, which have the form 
-<literal>key[locale]=value</literal>. Space before and after the 
+<literal>key[locale]=value</literal>, with a locale identifier of the form
+<literal>lang_COUNTRY@MODIFIER</literal> where <literal>COUNTRY</literal> and 
+<literal>MODIFIER</literal> are optional. Space before and after the 
 '=' character are ignored. Newline, tab, carriage return and backslash 
 characters in value are escaped as \n, \t, \r, and \\, respectively. 
 To preserve leading spaces in values, these can also be escaped as \s.

diff --git a/glib/gkeyfile.c b/glib/gkeyfile.c
index 4558e15..d49a17d 100644 (file)
--- a/glib/gkeyfile.c
+++ b/glib/gkeyfile.c
@@ -1589,7 +1589,7 @@ g_key_file_set_string_list (GKeyFile            *key_file,
  * @key_file: a #GKeyFile
  * @group_name: a group name
  * @key: a key
- * @locale: a locale
+ * @locale: a locale identifier
  * @string: a string
  *
  * Associates a string value for @key and @locale under @group_name.  
@@ -1625,7 +1625,7 @@ extern GSList *_g_compute_locale_variants (const gchar *locale);
  * @key_file: a #GKeyFile
  * @group_name: a group name
  * @key: a key
- * @locale: a locale or %NULL
+ * @locale: a locale identifier or %NULL
  * @error: return location for a #GError, or %NULL
  *
  * Returns the value associated with @key under @group_name
@@ -1721,7 +1721,7 @@ g_key_file_get_locale_string (GKeyFile     *key_file,
  * @key_file: a #GKeyFile
  * @group_name: a group name
  * @key: a key
- * @locale: a locale
+ * @locale: a locale identifier or %NULL
  * @length: return location for the number of returned strings or %NULL
  * @error: return location for a #GError or %NULL
  *
@@ -1796,7 +1796,7 @@ g_key_file_get_locale_string_list (GKeyFile     *key_file,
  * @key_file: a #GKeyFile
  * @group_name: a group name
  * @key: a key
- * @locale: a locale
+ * @locale: a locale identifier
  * @list: a %NULL-terminated array of locale string values
  * @length: the length of @list
  *