File::Copy: add a warning about flushing writes
authorDominic Hargreaves <dom@earth.li>
Sat, 30 Apr 2016 17:03:01 +0000 (18:03 +0100)
committerDominic Hargreaves <dom@earth.li>
Sat, 30 Apr 2016 17:03:23 +0000 (18:03 +0100)
Bug-Debian: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=494590

lib/File/Copy.pm

index 95fb4e1..0a6a81e 100644 (file)
@@ -489,6 +489,14 @@ it sets C<$!>, deletes the output file, and returns 0.
 All functions return 1 on success, 0 on failure.
 $! will be set if an error was encountered.
 
+=head1 NOTES
+
+Before calling copy() or move() on a filehandle, the caller should
+close or flush() the file to avoid writes being lost. Note that this
+is the case even for move(), because it may actually copy the file,
+depending on the OS-specific inplementation, and the underlying
+filesystem(s).
+
 =head1 AUTHOR
 
 File::Copy was written by Aaron Sherman I<E<lt>ajs@ajs.comE<gt>> in 1995,