summaryrefslogtreecommitdiffstats
path: root/Doc/library
diff options
context:
space:
mode:
authorMatthieu Caneill <matthieucan@users.noreply.github.com>2023-07-22 15:58:06 (GMT)
committerGitHub <noreply@github.com>2023-07-22 15:58:06 (GMT)
commit6e5f2235f3754307292c7d8d3698958136b5e311 (patch)
tree50dec2433138248d8c288eb3d773fa6a20749679 /Doc/library
parent149748ea4f552e6fe43a1d6d69bd65910a7c4813 (diff)
downloadcpython-6e5f2235f3754307292c7d8d3698958136b5e311.zip
cpython-6e5f2235f3754307292c7d8d3698958136b5e311.tar.gz
cpython-6e5f2235f3754307292c7d8d3698958136b5e311.tar.bz2
gh-83006: Document behavior of `shutil.disk_usage` for non-mounted filesystems on Unix (#107031)
Diffstat (limited to 'Doc/library')
-rw-r--r--Doc/library/shutil.rst6
1 files changed, 6 insertions, 0 deletions
diff --git a/Doc/library/shutil.rst b/Doc/library/shutil.rst
index 5bd80b1..7699d22 100644
--- a/Doc/library/shutil.rst
+++ b/Doc/library/shutil.rst
@@ -399,6 +399,12 @@ Directory and files operations
total, used and free space, in bytes. *path* may be a file or a
directory.
+ .. note::
+
+ On Unix filesystems, *path* must point to a path within a **mounted**
+ filesystem partition. On those platforms, CPython doesn't attempt to
+ retrieve disk usage information from non-mounted filesystems.
+
.. versionadded:: 3.3
.. versionchanged:: 3.8