From e16f053aa7571669a76b13fba8b51ae842cffc42 Mon Sep 17 00:00:00 2001 From: Matthias Clasen Date: Sat, 8 Feb 2014 13:22:38 -0500 Subject: [PATCH] Remove tables from GFileAttribute docs --- gio/gfileattribute.c | 196 ++++++++++++++++----------------------------------- 1 file changed, 60 insertions(+), 136 deletions(-) diff --git a/gio/gfileattribute.c b/gio/gfileattribute.c index e09eba1..08cf3af 100644 --- a/gio/gfileattribute.c +++ b/gio/gfileattribute.c @@ -56,71 +56,62 @@ * and other possible implementation details (e.g., on a UNIX system, a file * attribute key will be registered for the user id for a given file). * - * - * - * GFileAttributes Default Namespaces - * - * NamspaceDescription - * - * - * "standard"The "Standard" namespace. General file - * information that any application may need should be put in this namespace. - * Examples include the file's name, type, and size. - * "etag"The [Entity Tag][gfile-etag] - * namespace. Currently, the only key in this namespace is "value", which - * contains the value of the current entity tag. - * "id"The "Identification" namespace. This - * namespace is used by file managers and applications that list directories - * to check for loops and to uniquely identify files. - * "access"The "Access" namespace. Used to check - * if a user has the proper privilidges to access files and perform - * file operations. Keys in this namespace are made to be generic - * and easily understood, e.g. the "can_read" key is %TRUE if - * the current user has permission to read the file. UNIX permissions and - * NTFS ACLs in Windows should be mapped to these values. - * "mountable"The "Mountable" namespace. Includes - * simple boolean keys for checking if a file or path supports mount operations, e.g. - * mount, unmount, eject. These are used for files of type %G_FILE_TYPE_MOUNTABLE. - * "time"The "Time" namespace. Includes file - * access, changed, created times. - * "unix"The "Unix" namespace. Includes UNIX-specific - * information and may not be available for all files. Examples include - * the UNIX "UID", "GID", etc. - * "dos"The "DOS" namespace. Includes DOS-specific - * information and may not be available for all files. Examples include - * "is_system" for checking if a file is marked as a system file, and "is_archive" - * for checking if a file is marked as an archive file. - * "owner"The "Owner" namespace. Includes information - * about who owns a file. May not be available for all file systems. Examples include - * "user" for getting the user name of the file owner. This information is often mapped from - * some backend specific data such as a unix UID. - * "thumbnail"The "Thumbnail" namespace. Includes - * information about file thumbnails and their location within the file system. Examples of - * keys in this namespace include "path" to get the location of a thumbnail, "failed" - * to check if thumbnailing of the file failed, and "is-valid" to check if the thumbnail is - * outdated. - * "filesystem"The "Filesystem" namespace. Gets information - * about the file system where a file is located, such as its type, how much - * space is left available, and the overall size of the file system. - * "gvfs"The "GVFS" namespace. Keys in this namespace - * contain information about the current GVFS backend in use. - * "xattr"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. - * "xattr-sys"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. - * "selinux"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. - * - * - *
- * + * ## Default Namespaces + * + * - `"standard"`: The "Standard" namespace. General file information that + * any application may need should be put in this namespace. Examples + * include the file's name, type, and size. + * - `"etag`: The [Entity Tag][gfile-etag] namespace. Currently, the only key + * in this namespace is "value", which contains the value of the current + * entity tag. + * - `"id"`: The "Identification" namespace. This namespace is used by file + * managers and applications that list directories to check for loops and + * to uniquely identify files. + * - `"access"`: The "Access" namespace. Used to check if a user has the + * proper privileges to access files and perform file operations. Keys in + * this namespace are made to be generic and easily understood, e.g. the + * "can_read" key is %TRUE if the current user has permission to read the + * file. UNIX permissions and NTFS ACLs in Windows should be mapped to + * these values. + * - `"mountable"`: The "Mountable" namespace. Includes simple boolean keys + * for checking if a file or path supports mount operations, e.g. mount, + * unmount, eject. These are used for files of type %G_FILE_TYPE_MOUNTABLE. + * - `"time"`: The "Time" namespace. Includes file access, changed, created + * times. + * - `"unix"`: The "Unix" namespace. Includes UNIX-specific information and + * may not be available for all files. Examples include the UNIX "UID", + * "GID", etc. + * - `"dos"`: The "DOS" namespace. Includes DOS-specific information and may + * not be available for all files. Examples include "is_system" for checking + * if a file is marked as a system file, and "is_archive" for checking if a + * file is marked as an archive file. + * - `"owner"`: The "Owner" namespace. Includes information about who owns a + * file. May not be available for all file systems. Examples include "user" + * for getting the user name of the file owner. This information is often + * mapped from some backend specific data such as a UNIX UID. + * - `"thumbnail"`: The "Thumbnail" namespace. Includes information about file + * thumbnails and their location within the file system. Examples of keys in + * this namespace include "path" to get the location of a thumbnail, "failed" + * to check if thumbnailing of the file failed, and "is-valid" to check if + * the thumbnail is outdated. + * - `"filesystem"`: The "Filesystem" namespace. Gets information about the + * file system where a file is located, such as its type, how much space is + * left available, and the overall size of the file system. + * - `"gvfs"`: The "GVFS" namespace. Keys in this namespace contain information + * about the current GVFS backend in use. + * - `"xattr"`: 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. + * - `"xattr-sys"`: 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. + * - `"selinux"`: 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. * * Please note that these are not all of the possible namespaces. * More namespaces can be added from GIO modules or by individual applications. @@ -129,77 +120,10 @@ * * - * - * GFileAttributes Built-in Keys and Value Types - * - * Enum ValueNamespace::KeyValue Type - * - * %G_FILE_ATTRIBUTE_STANDARD_TYPEstandard::typeuint32 (#GFileType) - * %G_FILE_ATTRIBUTE_STANDARD_IS_HIDDENstandard::is-hiddenboolean - * %G_FILE_ATTRIBUTE_STANDARD_IS_BACKUPstandard::is-backupboolean - * %G_FILE_ATTRIBUTE_STANDARD_IS_SYMLINKstandard::is-symlinkboolean - * %G_FILE_ATTRIBUTE_STANDARD_IS_VIRTUALstandard::is-virtualboolean - * %G_FILE_ATTRIBUTE_STANDARD_NAMEstandard::namebyte string - * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAMEstandard::display-namestring - * %G_FILE_ATTRIBUTE_STANDARD_EDIT_NAMEstandard::edit-namestring - * %G_FILE_ATTRIBUTE_STANDARD_ICONstandard::iconobject (#GIcon) - * %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPEstandard::content-typestring - * %G_FILE_ATTRIBUTE_STANDARD_FAST_CONTENT_TYPEstandard::fast-content-typestring - * %G_FILE_ATTRIBUTE_STANDARD_SIZEstandard::sizeuint64 - * %G_FILE_ATTRIBUTE_STANDARD_ALLOCATED_SIZEstandard::allocated-sizeuint64 - * %G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGETstandard::symlink-targetbyte string - * %G_FILE_ATTRIBUTE_STANDARD_TARGET_URIstandard::target-uristring - * %G_FILE_ATTRIBUTE_STANDARD_SORT_ORDERstandard::sort-orderint32 - * %G_FILE_ATTRIBUTE_ETAG_VALUEetag::valuestring - * %G_FILE_ATTRIBUTE_ID_FILEid::filestring - * %G_FILE_ATTRIBUTE_ID_FILESYSTEMid::filesystemstring - * %G_FILE_ATTRIBUTE_ACCESS_CAN_READaccess::can-readboolean - * %G_FILE_ATTRIBUTE_ACCESS_CAN_WRITEaccess::can-writeboolean - * %G_FILE_ATTRIBUTE_ACCESS_CAN_EXECUTEaccess::can-executeboolean - * %G_FILE_ATTRIBUTE_ACCESS_CAN_DELETEaccess::can-deleteboolean - * %G_FILE_ATTRIBUTE_ACCESS_CAN_TRASHaccess::can-trashboolean - * %G_FILE_ATTRIBUTE_ACCESS_CAN_RENAMEaccess::can-renameboolean - * %G_FILE_ATTRIBUTE_MOUNTABLE_CAN_MOUNTmountable::can-mountboolean - * %G_FILE_ATTRIBUTE_MOUNTABLE_CAN_UNMOUNTmountable::can-unmountboolean - * %G_FILE_ATTRIBUTE_MOUNTABLE_CAN_EJECTmountable::can-ejectboolean - * %G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICEmountable::unix-deviceuint32 - * %G_FILE_ATTRIBUTE_MOUNTABLE_UNIX_DEVICE_FILEmountable::unix-device-filestring - * %G_FILE_ATTRIBUTE_MOUNTABLE_HAL_UDImountable::hal-udistring - * %G_FILE_ATTRIBUTE_TIME_MODIFIEDtime::modifieduint64 - * %G_FILE_ATTRIBUTE_TIME_MODIFIED_USECtime::modified-usecuint32 - * %G_FILE_ATTRIBUTE_TIME_ACCESStime::accessuint64 - * %G_FILE_ATTRIBUTE_TIME_ACCESS_USECtime::access-usecuint32 - * %G_FILE_ATTRIBUTE_TIME_CHANGEDtime::changeduint64 - * %G_FILE_ATTRIBUTE_TIME_CHANGED_USECtime::changed-usecuint32 - * %G_FILE_ATTRIBUTE_TIME_CREATEDtime::createduint64 - * %G_FILE_ATTRIBUTE_TIME_CREATED_USECtime::created-usecuint32 - * %G_FILE_ATTRIBUTE_UNIX_DEVICEunix::deviceuint32 - * %G_FILE_ATTRIBUTE_UNIX_INODEunix::inodeuint64 - * %G_FILE_ATTRIBUTE_UNIX_MODEunix::modeuint32 - * %G_FILE_ATTRIBUTE_UNIX_NLINKunix::nlinkuint32 - * %G_FILE_ATTRIBUTE_UNIX_UIDunix::uiduint32 - * %G_FILE_ATTRIBUTE_UNIX_GIDunix::giduint32 - * %G_FILE_ATTRIBUTE_UNIX_RDEVunix::rdevuint32 - * %G_FILE_ATTRIBUTE_UNIX_BLOCK_SIZEunix::block-sizeuint32 - * %G_FILE_ATTRIBUTE_UNIX_BLOCKSunix::blocksuint64 - * %G_FILE_ATTRIBUTE_UNIX_IS_MOUNTPOINTunix::is-mountpointboolean - * %G_FILE_ATTRIBUTE_DOS_IS_ARCHIVEdos::is-archiveboolean - * %G_FILE_ATTRIBUTE_DOS_IS_SYSTEMdos::is-systemboolean - * %G_FILE_ATTRIBUTE_OWNER_USERowner::userstring - * %G_FILE_ATTRIBUTE_OWNER_USER_REALowner::user-realstring - * %G_FILE_ATTRIBUTE_OWNER_GROUPowner::groupstring - * %G_FILE_ATTRIBUTE_THUMBNAIL_PATHthumbnail::pathbytestring - * %G_FILE_ATTRIBUTE_THUMBNAILING_FAILEDthumbnail::failedboolean - * %G_FILE_ATTRIBUTE_THUMBNAIL_IS_VALIDthumbnail::is-validboolean - * %G_FILE_ATTRIBUTE_PREVIEW_ICONpreview::iconobject (#GIcon) - * %G_FILE_ATTRIBUTE_FILESYSTEM_SIZEfilesystem::sizeuint64 - * %G_FILE_ATTRIBUTE_FILESYSTEM_FREEfilesystem::freeuint64 - * %G_FILE_ATTRIBUTE_FILESYSTEM_USEDfilesystem::useduint64 - * %G_FILE_ATTRIBUTE_FILESYSTEM_TYPEfilesystem::typestring - * %G_FILE_ATTRIBUTE_FILESYSTEM_READONLYfilesystem::readonlyboolean - * %G_FILE_ATTRIBUTE_GVFS_BACKENDgvfs::backendstring - * %G_FILE_ATTRIBUTE_SELINUX_CONTEXTselinux::contextstring - *
+ * ## Default Keys + * + * For a list of the built-in keys and their types, see the + * [GFileInfo][GFileInfo] documentation. * * Note that there are no predefined keys in the "xattr" and "xattr-sys" * namespaces. Keys for the "xattr" namespace are constructed by stripping -- 2.7.4