This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Tie::File - Document use of binmode on filehandles
authorRichard Leach <richardleach@users.noreply.github.com>
Fri, 7 Feb 2020 22:01:25 +0000 (22:01 +0000)
committerTodd Rinaldo <toddr@cpan.org>
Tue, 11 Feb 2020 03:53:00 +0000 (21:53 -0600)
Documentation fix for #17497, where the user passed a filehandle in, but the lack of binmode meant that the :crlf layer on Windows caused problems when the file was later used on Linux.

dist/Tie-File/lib/Tie/File.pm

index b2ded8a..8247893 100644 (file)
@@ -2319,6 +2319,11 @@ internally.  If you passed it a filehandle as above, you "own" the
 filehandle, and are responsible for closing it after you have untied
 the @array.
 
+Tie::File calls C<binmode> on filehandles that it opens internally, 
+but not on filehandles passed in by the user. For consistency,
+especially if using the tied files cross-platform, you may wish to
+call C<binmode> on the filehandle prior to tying the file. 
+
 =head1 Deferred Writing
 
 (This is an advanced feature.  Skip this section on first reading.)