Skip to content

Commit

Permalink
Expand docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
anodos325 committed Dec 2, 2024
1 parent 1a8f4e6 commit 9f408a4
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions src/middlewared/middlewared/api/v25_04_0/filesystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -132,26 +132,27 @@ class FilesystemDirEntry(BaseModel):
StatxEtype.OTHER,
]
size: int
""" Size in bytes of a plain file. """
""" Size in bytes of a plain file. This corresonds with stx_size. """
allocation_size: int
""" Allocated size of file. Calculated by multiplying stx_blocks by 512. """
mode: int
""" Entry's mode including file type information and file permission bits. """
""" Entry's mode including file type information and file permission bits. This corresponds with stx_mode. """
mount_id: int
""" The mount ID of the mount containing the entry. This corresponds to the number in first
field of /proc/self/mountinfo. """
field of /proc/self/mountinfo and stx_mnt_id. """
acl: bool
""" Specifies whether ACL is present on the entry. If this is the case then file permission
bits as reported in `mode` may not be representative of the actual permissions. """
uid: int
""" User ID of the entry's owner. """
""" User ID of the entry's owner. This corresponds with stx_uid. """
gid: int
""" Group ID of the entry's owner. """
""" Group ID of the entry's owner. This corresponds with stx_gid. """
is_mountpoint: bool
""" Specifies whether the entry is also the mountpoint of a filesystem. """
is_ctldir: bool
""" Specifies whether the entry is located within the ZFS ctldir (for example a snapshot). """
attributes: list[FILESYSTEM_STATX_ATTRS]
""" Extra file attribute indicators for entry as returned by statx. """
""" Extra file attribute indicators for entry as returned by statx. Expanded from stx_attributes. """
xattrs: list[NonEmptyString]
""" List of xattr names of extended attributes on file. """
zfs_attrs: list[FILESYSTEM_ZFS_ATTRS] | None
Expand Down

0 comments on commit 9f408a4

Please sign in to comment.