doc patch: File::Copy pod Synopsis section

[Zsbán Ambrus]

Attached patch based on blead changes the pod of File::Copy so that
the Synopsis section more clearly demonstrates whether the order of
arguments for the copy and move functions is source-dest or
dest-source.

Please verify that I've used the correct order. The stakes are high:
if we put the wrong order in the docs, people might end up silently
overwriting useful files. If you've checked, please apply.

Thanks,

Ambrus

[Zsban Ambrus]

# New Ticket Created by Zsban Ambrus
# Please include the string: [perl #118177]
# in the subject line of all future correspondence about this issue.
# <URL: https://rt.perl.org:443/rt3/Ticket/Display.html?id=118177 >


This is a bug report for perl from amb...@math.bme.hu,
generated with the help of perlbug 1.39 running under perl 5.16.3.


-----------------------------------------------------------------
[Please describe your issue here]

[Please do not change anything below this line]
-----------------------------------------------------------------
---
Flags:
category=docs
severity=low
---
Site configuration information for perl 5.16.3:

Configured by ambrus at Sun May 12 14:36:09 CEST 2013.

Summary of my perl5 (revision 5 version 16 subversion 3) configuration:

Platform:
osname=linux, osvers=2.6.37, archname=x86_64-linux
uname='linux king 2.6.37 #6 smp sun mar 13 20:15:05 cet 2011
x86_64 gnulinux '
config_args='-der'
hint=previous, useposix=true, d_sigaction=define
useithreads=undef, usemultiplicity=undef
useperlio=define, d_sfio=undef, uselargefiles=define, usesocks=undef
use64bitint=define, use64bitall=define, uselongdouble=undef
usemymalloc=n, bincompat5005=undef
Compiler:
cc='cc', ccflags ='-fno-strict-aliasing -pipe -fstack-protector
-I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64',
optimize='-O2',
cppflags='-fno-strict-aliasing -pipe -fstack-protector
-I/usr/local/include -fno-strict-aliasing -pipe -fstack-protector
-I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64
-fno-strict-aliasing -pipe -fstack-protector -I/usr/local/include
-D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64'
ccversion='', gccversion='4.7.1', gccosandvers=''
intsize=4, longsize=8, ptrsize=8, doublesize=8, byteorder=12345678
d_longlong=define, longlongsize=8, d_longdbl=define, longdblsize=16
ivtype='long', ivsize=8, nvtype='double', nvsize=8, Off_t='off_t',
lseeksize=8
alignbytes=8, prototype=define
Linker and Libraries:
ld='cc', ldflags =' -fstack-protector -L/usr/local/lib'
libpth=/usr/local/lib /lib/../lib /usr/lib/../lib /lib /usr/lib
/lib64 /usr/lib64 /usr/local/lib64
libs=-lnsl -ldl -lm -lcrypt -lutil -lc
perllibs=-lnsl -ldl -lm -lcrypt -lutil -lc
libc=/lib/libc-2.11.3.so, so=so, useshrplib=false, libperl=libperl.a
gnulibc_version='2.11.3'
Dynamic Linking:
dlsrc=dl_dlopen.xs, dlext=so, d_dlsymun=undef, ccdlflags='-Wl,-E'
cccdlflags='-fPIC', lddlflags='-shared -O2 -L/usr/local/lib
-fstack-protector'

Locally applied patches:


---
@INC for perl 5.16.3:
/usr/local/perl5.16/lib/perl5/site_perl/5.16.3/x86_64-linux
/usr/local/perl5.16/lib/perl5/site_perl/5.16.3
/usr/local/perl5.16/lib/perl5/5.16.3/x86_64-linux
/usr/local/perl5.16/lib/perl5/5.16.3
/usr/local/perl5.16/lib/perl5/site_perl/5.16.1
/usr/local/perl5.16/lib/perl5/site_perl/5.16.1/x86_64-linux
/usr/local/perl5.16/lib/perl5/site_perl
.

---
Environment for perl 5.16.3:
HOME=/home/ambrus
LANG (unset)
LANGUAGE (unset)
LC_CTYPE=hu_HU
LD_LIBRARY_PATH=/home/ambrus/local/lib/
LOGDIR (unset)
PATH=/home/ambrus/local/bin:/usr/local/bin:/usr/bin:/bin:/usr/bin/X11:/usr/games
PERL_BADLANG (unset)
SHELL=/usr/local/bin/bash

[James E Keenan via RT]

On Sat May 25 12:30:05 2013, b_jonas wrote:
> This is a bug report for perl from amb...@math.bme.hu,
> generated with the help of perlbug 1.39 running under perl 5.16.3.
>
>
> -----------------------------------------------------------------
> [Please describe your issue here]
>
>
> Attached patch based on blead changes the pod of File::Copy so that
> the Synopsis section more clearly demonstrates whether the order of
> arguments for the copy and move functions is source-dest or
> dest-source.
>
> Please verify that I've used the correct order. The stakes are high:
> if we put the wrong order in the docs, people might end up silently
> overwriting useful files. If you've checked, please apply.
>

These changes are +1 by me. But since you have correctly identified the
stakes involved, I'll let other people weigh in.

Thank you very much.
Jim Keenan


---
via perlbug: queue: perl5 status: new
https://rt.perl.org:443/rt3/Ticket/Display.html?id=118177

[Aaron Crane via RT]

Resolving as requested.

--
Aaron Crane ** http://aaroncrane.co.uk/