From d5ba3ceadbb622bc0b7c95c886391699dca51cf4 Mon Sep 17 00:00:00 2001 From: Steve Hancock Date: Sat, 29 Jan 2022 07:56:43 -0800 Subject: [PATCH] update docs for -eos --- lib/Perl/Tidy.pod | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/lib/Perl/Tidy.pod b/lib/Perl/Tidy.pod index aaaf72a3..28128c97 100644 --- a/lib/Perl/Tidy.pod +++ b/lib/Perl/Tidy.pod @@ -83,6 +83,19 @@ filenames may be specified in the @ARGV array or B parameter. If the B parameter is given, it will be used to define the file or memory location to receive output of perltidy. +If the destination is a string or array reference, and it contains encoded +characters, then by default it will NOT be encoded by Perl::Tidy. + +This default is not always convenient, particularly if the calling program did +not do the decoding, and can be changed by including the B<-eos> or +B<--encode-output-strings> flag described in the B manual. When this +flag is set, and if Perl::Tidy decoded a string, then it will encode the string +before returning. For some background information see the discussion at github +for perltidy issue git #83 at +L. + +This B<-eos> parameter was added after perltidy version 20211029.05. + =item stderr The B parameter allows the calling program to redirect the stream that -- 2.39.5