Documentation additions

svn path=/trunk/; revision=6247

diff --git a/gio/ChangeLog b/gio/ChangeLog
index 0faed7a..7ad775b 100644 (file)
--- a/gio/ChangeLog
+++ b/gio/ChangeLog
@@ -1,3 +1,10 @@
+2008-01-06  Matthias Clasen  <mclasen@redhat.com>
+
+       * gdesktopappinfo.c: Fix a docs typo.
+
+       * gfileattribute.c: Add information about extended attributes
+       to the documentation.  (#505058)
+
 2008-01-04  Alexander Larsson  <alexl@redhat.com>
 
         * gio-marshal.list:

diff --git a/gio/gdesktopappinfo.c b/gio/gdesktopappinfo.c
index 33bfa91..1f04ef4 100644 (file)
--- a/gio/gdesktopappinfo.c
+++ b/gio/gdesktopappinfo.c
@@ -1740,7 +1740,7 @@ get_apps_from_dir (GHashTable *apps,
  * on this system.
  * 
  * For desktop files, this includes applications that have 
- * <literal>NoDisplay=true</liberal> set or are excluded from 
+ * <literal>NoDisplay=true</literal> set or are excluded from 
  * display by means of <literal>OnlyShowIn</literal> or
  * <literal>NotShowIn</literal>. See g_app_info_should_show().
  * The returned list does not include applications which have

diff --git a/gio/gfileattribute.c b/gio/gfileattribute.c
index 07b284f..cb6677b 100644 (file)
--- a/gio/gfileattribute.c
+++ b/gio/gfileattribute.c
@@ -106,6 +106,19 @@
  * space is left available, and the overall size of the file system.</entry></row>
  * <row><entry>"gvfs"</entry><entry>The "GVFS" namespace. Keys in this namespace
  * contain information about the current GVFS backend in use. </entry></row>
+ * <row><entry>"xattr"</entry><entry>The "xattr" namespace. Gets information 
+ * about extended user attributes. See attr(5). The "user." prefix of the
+ * extended user attribute name is stripped away when constructing keys in
+ * this namespace, e.g. "xattr::mime_type" for the extended attribute with 
+ * the name "user.mime_type". Note that this information is only available
+ * if GLib has been built with extended attribute support.</entry></row>
+ * <row><entry>"xattr-sys"</entry><entry>The "xattr-sys" namespace. 
+ * Gets information about extended attributes which are not user-specific. 
+ * See attr(5). Note that this information is only available if GLib
+ * has been built with extended attribute support.</entry></row>
+ * <row><entry>"selinux"</entry><entry>The "SELinux" namespace. Includes
+ * information about the SELinux context of files. Note that this information
+ * is only available if GLib has been built with SELinux support.</entry></row>
  * </tbody>
  * </tgroup>
  * </table>
@@ -182,8 +195,17 @@
  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_TYPE</entry><entry>filesystem::type</entry><entry>string</entry></row>
  * <row><entry>%G_FILE_ATTRIBUTE_FILESYSTEM_READONLY</entry><entry>filesystem::readonly</entry><entry>boolean</entry></row>
  * <row><entry>%G_FILE_ATTRIBUTE_GVFS_BACKEND</entry><entry>gvfs::backend</entry><entry>string</entry></row>
+ * <row><entry>%G_FILE_ATTRIBUTE_SELINUX_CONTEXT</entry><entry>selinux::context</entry><entry>string</entry></row>
  * </tbody></tgroup></table></para>
  *  
+ * Note that there are no predefined keys in the "xattr" and "xattr-sys" 
+ * namespaces. Keys for the "xattr" namespace are constructed by stripping
+ * away the "user." prefix from the extended user attribute, and prepending
+ * "xattr::". Keys for the "xattr-sys" namespace are constructed by 
+ * concatenating "xattr-sys::" with the extended attribute name. All extended
+ * attribute values are returned as hex-encoded strings in which bytes outside
+ * the ASCII range are encoded as hexadecimal escape sequences of the form
+ * \x<replaceable>nn</replaceable>.
  **/ 
 
 /*

diff --git a/gio/gfileinfo.h b/gio/gfileinfo.h
index 5840197..8ca93de 100644 (file)
--- a/gio/gfileinfo.h
+++ b/gio/gfileinfo.h
@@ -658,7 +658,8 @@ typedef enum {
 
 /**
  * G_FILE_ATTRIBUTE_FILESYSTEM_READONLY:
- * * A key in the "filesystem" namespace for checking if the file system 
+ *
+ * A key in the "filesystem" namespace for checking if the file system 
  * is read only. Is set to %TRUE if the file system is read only. 
  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_BOOLEAN.
  **/