Browse Source

file(CREATE_LINK): Document `COPY_ON_ERROR` behavior on directories

Issue: #27294
Alex Overchenko 1 week ago
parent
commit
657e9be724
1 changed files with 3 additions and 1 deletions
  1. 3 1
      Help/command/file.rst

+ 3 - 1
Help/command/file.rst

@@ -616,7 +616,9 @@ Filesystem
   emitted.
 
   Specifying ``COPY_ON_ERROR`` enables copying the file as a fallback if
-  creating the link fails.  It can be useful for handling situations such as
+  creating the link fails.  If the source is a directory, the destination
+  directory will be created if it does not exist, but no files will be copied
+  the from source one.  It can be useful for handling situations such as
   ``<original>`` and ``<linkname>`` being on different drives or mount points,
   which would make them unable to support a hard link.