summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBarney Gale <barney.gale@gmail.com>2024-11-05 18:43:43 (GMT)
committerGitHub <noreply@github.com>2024-11-05 18:43:43 (GMT)
commitff8349979c2ca4e442afc583e1217519611c6c48 (patch)
treed90e4b4c7b7d6db1eddcfaba309bba394d64dee2
parent8525c9375f25e6ec0c0b5dfcab464703f6e78082 (diff)
downloadcpython-ff8349979c2ca4e442afc583e1217519611c6c48.zip
cpython-ff8349979c2ca4e442afc583e1217519611c6c48.tar.gz
cpython-ff8349979c2ca4e442afc583e1217519611c6c48.tar.bz2
GH-124985: Document that `pathlib.Path.copy()` uses copy-on-write. (#125861)
-rw-r--r--Doc/library/pathlib.rst5
1 files changed, 5 insertions, 0 deletions
diff --git a/Doc/library/pathlib.rst b/Doc/library/pathlib.rst
index b6fb365..a42ac1f 100644
--- a/Doc/library/pathlib.rst
+++ b/Doc/library/pathlib.rst
@@ -1592,6 +1592,11 @@ Copying, moving and deleting
This argument has no effect when copying files on Windows (where
metadata is always preserved).
+ .. note::
+ Where supported by the operating system and file system, this method
+ performs a lightweight copy, where data blocks are only copied when
+ modified. This is known as copy-on-write.
+
.. versionadded:: 3.14