summaryrefslogtreecommitdiffstats
path: root/src/corelib/io/qstorageinfo.cpp
diff options
context:
space:
mode:
authorAhmad Samir <a.samirh78@gmail.com>2023-03-27 19:44:04 +0200
committerAhmad Samir <a.samirh78@gmail.com>2023-04-08 13:21:39 +0200
commit595112ea501849d2449e870835c5be97fc4b774b (patch)
treeeae1f4e0c2bd435abd68d5deccea056a65326524 /src/corelib/io/qstorageinfo.cpp
parentb58606ed851e21b64b72c8f86926d5e5adb56ec7 (diff)
QStorageInfo: mention bind mounts and btrfs subvolumes in API docs
Sepcifically in the subvolume() method's docs. Change-Id: Ib14492f8366bf00a6a4ab399ff8ad20009be5886 Reviewed-by: Thiago Macieira <thiago.macieira@intel.com> Reviewed-by: hjk <hjk@qt.io>
Diffstat (limited to 'src/corelib/io/qstorageinfo.cpp')
-rw-r--r--src/corelib/io/qstorageinfo.cpp7
1 files changed, 4 insertions, 3 deletions
diff --git a/src/corelib/io/qstorageinfo.cpp b/src/corelib/io/qstorageinfo.cpp
index 25b11103b9..2a12c2cd85 100644
--- a/src/corelib/io/qstorageinfo.cpp
+++ b/src/corelib/io/qstorageinfo.cpp
@@ -241,9 +241,10 @@ QByteArray QStorageInfo::device() const
Returns the subvolume name for this volume.
Some filesystem types allow multiple subvolumes inside one device, which
- may be mounted in different paths. If the subvolume could be detected, it
- is returned here. The format of the subvolume name is specific to each
- filesystem type.
+ may be mounted in different paths (e.g. 'bind' mounts on Unix, or Btrfs
+ filesystem subvolumes). If the subvolume could be detected, its name is
+ returned by this function. The format of the subvolume name is specific
+ to each filesystem type.
If this volume was not mounted from a subvolume of a larger filesystem or
if the subvolume could not be detected, this function returns an empty byte