[glib: 1/2] gfileinfo: Clarify the documentation for G_FILE_ATTRIBUTE_UNIX_MODE

[Iain Lane <iainl src gnome org>]

commit f793319b17d1c0303068cf2f22cc7044c114c63a
Author: Philip Withnall <withnall endlessm com>
Date:   Thu Nov 21 11:24:08 2019 +0000

    gfileinfo: Clarify the documentation for G_FILE_ATTRIBUTE_UNIX_MODE
    
    It’s not just the mode, it’s also the file type.
    
    Signed-off-by: Philip Withnall <withnall endlessm com>
    
    Helps: #1934

 gio/gfileinfo.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)
---
diff --git a/gio/gfileinfo.h b/gio/gfileinfo.h
index 1629a2edb..d2459517d 100644
--- a/gio/gfileinfo.h
+++ b/gio/gfileinfo.h
@@ -578,8 +578,10 @@ typedef struct _GFileInfoClass   GFileInfoClass;
  * G_FILE_ATTRIBUTE_UNIX_MODE:
  *
  * A key in the "unix" namespace for getting the mode of the file
- * (e.g. whether the file is a regular file, symlink, etc). See lstat()
- * documentation. This attribute is only available for UNIX file systems.
+ * (e.g. whether the file is a regular file, symlink, etc). See the
+ * documentation for `lstat()`: this attribute is equivalent to the `st_mode`
+ * member of `struct stat`, and includes both the file type and permissions.
+ * This attribute is only available for UNIX file systems.
  * Corresponding #GFileAttributeType is %G_FILE_ATTRIBUTE_TYPE_UINT32.
  **/
 #define G_FILE_ATTRIBUTE_UNIX_MODE "unix::mode"                   /* uint32 */