Skip to content
This repository has been archived by the owner on Jun 1, 2023. It is now read-only.

Commit

Permalink
Fix various pod errors.
Browse files Browse the repository at this point in the history
Mostly these are too long verbatim lines.

# Conflicts:
#	README.symbian
#	dist/Module-CoreList/lib/Module/CoreList/Utils.pm
#	dist/Storable/Storable.pm
#	lib/ExtUtils/Embed.pm
#	t/porting/known_pod_issues.dat
  • Loading branch information
khwilliamson authored and Reini Urban committed Jun 3, 2016
1 parent 505724a commit ce036c3
Show file tree
Hide file tree
Showing 36 changed files with 1,012 additions and 888 deletions.
6 changes: 4 additions & 2 deletions Porting/expand-macro.pl
Expand Up @@ -138,12 +138,14 @@ =head1 NAME
=head1 SYNOPSIS
expand-macro.pl [options] [ < macro-name | macro-expression | - > [headers] ]
expand-macro.pl [options]
[ < macro-name | macro-expression | - > [headers] ]
options:
-f use 'indent' to format output
-F <tool> use <tool> to format output (instead of -f)
-e erase try.[ic] instead of failing when they're present (errdetect)
-e erase try.[ic] instead of failing when they're present
(errdetect)
-k keep them after generating (for handy inspection)
-v verbose
-I <indent-opts> passed into indent
Expand Down
3 changes: 2 additions & 1 deletion Porting/todo.pod
Expand Up @@ -550,7 +550,8 @@ none of the above (nor sprintf(), vsprintf(), or *SHUDDER* gets())
ever creep back to libperl.a.

nm libperl.a | ./miniperl -alne '$o = $F[0] if /:$/;
print "$o $F[1]" if $F[0] eq "U" && $F[1] =~ /^(?:strn?c(?:at|py)|v?sprintf|gets)$/'
print "$o $F[1]" if $F[0] eq "U" && $F[1]
=~ /^(?:strn?c(?:at|py)|v?sprintf|gets)$/'

Note, of course, that this will only tell whether B<your> platform
is using those naughty interfaces.
Expand Down
68 changes: 41 additions & 27 deletions README.cygwin
Expand Up @@ -83,7 +83,8 @@ binaries to be stripped, you can either add a B<-s> option when Configure
prompts you,

Any additional ld flags (NOT including libraries)? [none] -s
Any special flags to pass to g++ to create a dynamically loaded library?
Any special flags to pass to g++ to create a dynamically loaded
library?
[none] -s
Any special flags to pass to gcc to use dynamic linking? [none] -s

Expand Down Expand Up @@ -211,12 +212,13 @@ You may see some messages during Configure that seem suspicious.
Win9x does not correctly report C<EOF> with a non-blocking read on a
closed pipe. You will see the following messages:

But it also returns -1 to signal EOF, so be careful!
WARNING: you can't distinguish between EOF and no data!
But it also returns -1 to signal EOF, so be careful!
WARNING: you can't distinguish between EOF and no data!

*** WHOA THERE!!! ***
The recommended value for $d_eofnblk on this machine was "define"!
Keep the recommended value? [y]
*** WHOA THERE!!! ***
The recommended value for $d_eofnblk on this machine was
"define"!
Keep the recommended value? [y]

At least for consistency with WinNT, you should keep the recommended
value.
Expand Down Expand Up @@ -407,14 +409,15 @@ Using C<fork()> or C<system()> out to another perl after loading multiple dlls
may result on a DLL baseaddress conflict. The internal cygwin error
looks like like the following:

0 [main] perl 8916 child_info_fork::abort: data segment start: parent
(0xC1A000) != child(0xA6A000)
0 [main] perl 8916 child_info_fork::abort: data segment start:
parent (0xC1A000) != child(0xA6A000)

or:

183 [main] perl 3588 C:\cygwin\bin\perl.exe: *** fatal error - unable to remap
C:\cygwin\bin\cygsvn_subr-1-0.dll to same address as parent(0x6FB30000) != 0x6FE60000
46 [main] perl 3488 fork: child 3588 - died waiting for dll loading, errno11
183 [main] perl 3588 C:\cygwin\bin\perl.exe: *** fatal error -
unable to remap C:\cygwin\bin\cygsvn_subr-1-0.dll to same address
as parent(0x6FB30000) != 0x6FE60000 46 [main] perl 3488 fork: child
3588 - died waiting for dll loading, errno11

See L<http://cygwin.com/faq/faq-nochunks.html#faq.using.fixing-fork-failures>
It helps if not too many DLLs are loaded in memory so the available address space is larger,
Expand Down Expand Up @@ -569,11 +572,11 @@ be kept as clean as possible.
ext/Compress-Raw-Zlib/README ext/Compress-Zlib/Changes
ext/DB_File/Changes ext/Encode/Changes ext/Sys-Syslog/Changes
ext/Win32API-File/Changes
lib/ExtUtils/CBuilder/Changes lib/ExtUtils/Changes lib/ExtUtils/NOTES
lib/ExtUtils/PATCHING lib/ExtUtils/README
lib/ExtUtils/CBuilder/Changes lib/ExtUtils/Changes
lib/ExtUtils/NOTES lib/ExtUtils/PATCHING lib/ExtUtils/README
lib/Net/Ping/Changes lib/Test/Harness/Changes
lib/Term/ANSIColor/ChangeLog lib/Term/ANSIColor/README README.symbian
symbian/TODO
lib/Term/ANSIColor/ChangeLog lib/Term/ANSIColor/README
README.symbian symbian/TODO

=item Build, Configure, Make, Install

Expand Down Expand Up @@ -602,29 +605,34 @@ be kept as clean as possible.
=item Tests

t/io/fs.t - no file mode checks if not ntsec
skip rename() check when not check_case:relaxed
skip rename() check when not
check_case:relaxed
t/io/tell.t - binmode
t/lib/cygwin.t - builtin cygwin function tests
t/op/groups.t - basegroup has ID = 0
t/op/magic.t - $^X/symlink WORKAROUND, s/.exe//
t/op/stat.t - no /dev, skip Win32 ftCreationTime quirk
(cache manager sometimes preserves ctime of file
previously created and deleted), no -u (setuid)
(cache manager sometimes preserves ctime of
file previously created and deleted), no -u
(setuid)
t/op/taint.t - can't use empty path under Cygwin Perl
t/op/time.t - no tzset()

=item Compiled Perl Source

EXTERN.h - __declspec(dllimport)
XSUB.h - __declspec(dllexport)
cygwin/cygwin.c - os_extras (getcwd, spawn, and several Cygwin:: functions)
cygwin/cygwin.c - os_extras (getcwd, spawn, and several
Cygwin:: functions)
perl.c - os_extras, -i.bak
perl.h - binmode
doio.c - win9x can not rename a file when it is open
pp_sys.c - do not define h_errno, init _pwent_struct.pw_comment
pp_sys.c - do not define h_errno, init
_pwent_struct.pw_comment
util.c - use setenv
util.h - PERL_FILE_IS_ABSOLUTE macro
pp.c - Comment about Posix vs IEEE math under Cygwin
pp.c - Comment about Posix vs IEEE math under
Cygwin
perlio.c - CR/LF mode
perliol.c - Comment about EXTCONST under Cygwin

Expand All @@ -634,10 +642,12 @@ be kept as clean as possible.
- Can't install via CPAN shell under Cygwin
ext/Compress-Raw-Zlib/zlib-src/zutil.h
- Cygwin is Unix-like and has vsnprintf
ext/Errno/Errno_pm.PL - Special handling for Win32 Perl under Cygwin
ext/Errno/Errno_pm.PL - Special handling for Win32 Perl under
Cygwin
ext/POSIX/POSIX.xs - tzname defined externally
ext/SDBM_File/sdbm/pair.c
- EXTCONST needs to be redefined from EXTERN.h
- EXTCONST needs to be redefined from
EXTERN.h
ext/SDBM_File/sdbm/sdbm.c
- binary open
ext/Sys/Syslog/Syslog.xs
Expand All @@ -651,21 +661,24 @@ be kept as clean as possible.
ext/Win32/Makefile.PL - Use various libraries under Cygwin
ext/Win32/Win32.xs - Child dir and child env under Cygwin
ext/Win32API-File/File.xs
- _open_osfhandle not implemented under Cygwin
- _open_osfhandle not implemented under
Cygwin
ext/Win32CORE/Win32CORE.c
- __declspec(dllexport)

=item Perl Modules/Scripts

ext/B/t/OptreeCheck.pm - Comment about stderr/stdout order under Cygwin
ext/B/t/OptreeCheck.pm - Comment about stderr/stdout order under
Cygwin
ext/Digest-SHA/bin/shasum
- Use binary mode under Cygwin
ext/Sys/Syslog/win32/Win32.pm
- Convert paths to Windows paths
ext/Time-HiRes/HiRes.pm
- Comment about various timers not available
ext/Win32API-File/File.pm
- _open_osfhandle not implemented under Cygwin
- _open_osfhandle not implemented under
Cygwin
ext/Win32CORE/Win32CORE.pm
- History of Win32CORE under Cygwin
lib/Cwd.pm - hook to internal Cwd::cwd
Expand All @@ -681,7 +694,8 @@ be kept as clean as possible.
lib/ExtUtils/MM_Cygwin.pm
- canonpath, cflags, manifypods, perl_archive
lib/File/Fetch.pm - Comment about quotes using a Cygwin example
lib/File/Find.pm - on remote drives stat() always sets st_nlink to 1
lib/File/Find.pm - on remote drives stat() always sets
st_nlink to 1
lib/File/Spec/Cygwin.pm - case_tolerant
lib/File/Spec/Unix.pm - preserve //unc
lib/File/Spec/Win32.pm - References a message on cygwin.com
Expand Down
20 changes: 14 additions & 6 deletions README.hpux
Expand Up @@ -40,17 +40,21 @@ on /cdrom), issue this command:

# swlist -s /cdrom perl
# perl D.5.8.8.B 5.8.8 Perl Programming Language
perl.Perl5-32 D.5.8.8.B 32-bit 5.8.8 Perl Programming Language with Extensions
perl.Perl5-64 D.5.8.8.B 64-bit 5.8.8 Perl Programming Language with Extensions
perl.Perl5-32 D.5.8.8.B 32-bit 5.8.8 Perl Programming Language
with Extensions
perl.Perl5-64 D.5.8.8.B 64-bit 5.8.8 Perl Programming Language
with Extensions

To see what is installed on your system:

# swlist -R perl
# perl E.5.8.8.J Perl Programming Language
# perl.Perl5-32 E.5.8.8.J 32-bit Perl Programming Language with Extensions
# perl.Perl5-32 E.5.8.8.J 32-bit Perl Programming Language
with Extensions
perl.Perl5-32.PERL-MAN E.5.8.8.J 32-bit Perl Man Pages for IA
perl.Perl5-32.PERL-RUN E.5.8.8.J 32-bit Perl Binaries for IA
# perl.Perl5-64 E.5.8.8.J 64-bit Perl Programming Language with Extensions
# perl.Perl5-64 E.5.8.8.J 64-bit Perl Programming Language
with Extensions
perl.Perl5-64.PERL-MAN E.5.8.8.J 64-bit Perl Man Pages for IA
perl.Perl5-64.PERL-RUN E.5.8.8.J 64-bit Perl Binaries for IA

Expand Down Expand Up @@ -666,8 +670,12 @@ best fix is to patch the header to match:
The following compilation warnings may happen in HP-UX releases
earlier than 11.31 but are harmless:

cc: "/usr/include/sys/socket.h", line 535: warning 562: Redeclaration of "sendfile" with a different storage class specifier: "sendfile" will have internal linkage.
cc: "/usr/include/sys/socket.h", line 536: warning 562: Redeclaration of "sendpath" with a different storage class specifier: "sendpath" will have internal linkage.
cc: "/usr/include/sys/socket.h", line 535: warning 562:
Redeclaration of "sendfile" with a different storage class
specifier: "sendfile" will have internal linkage.
cc: "/usr/include/sys/socket.h", line 536: warning 562:
Redeclaration of "sendpath" with a different storage class
specifier: "sendpath" will have internal linkage.

They seem to be caused by broken system header files, and also other
open source projects are seeing them. The following HP-UX patches
Expand Down
5 changes: 3 additions & 2 deletions README.hurd
Expand Up @@ -28,12 +28,13 @@ information.
Here are the statistics for Perl 5.005_62 on my system:

Failed Test Status Wstat Total Fail Failed List of failed
-------------------------------------------------------------------------
-----------------------------------------------------------------------
lib/anydbm.t 12 1 8.33% 12
pragma/warnings 333 1 0.30% 215

8 tests and 24 subtests skipped.
Failed 2/229 test scripts, 99.13% okay. 2/10850 subtests failed, 99.98% okay.
Failed 2/229 test scripts, 99.13% okay. 2/10850 subtests failed,
99.98% okay.

There are quite a few systems out there that do worse!

Expand Down
9 changes: 5 additions & 4 deletions README.irix
Expand Up @@ -106,21 +106,22 @@ Ignore them: in IRIX 5.3 there is no way to quieten ld about this.
During compilation you will see this warning from toke.c:

uopt: Warning: Perl_yylex: this procedure not optimized because it
exceeds size threshold; to optimize this procedure, use -Olimit option
with value >= 4252.
exceeds size threshold; to optimize this procedure, use -Olimit
option with value >= 4252.

Ignore the warning.

In IRIX 5.3 and with Perl 5.8.1 (Perl 5.8.0 didn't compile in IRIX 5.3)
the following failures are known.

Failed Test Stat Wstat Total Fail Failed List of Failed
--------------------------------------------------------------------------
-----------------------------------------------------------------------
../ext/List/Util/t/shuffle.t 0 139 ?? ?? % ??
../lib/Math/Trig.t 255 65280 29 12 41.38% 24-29
../lib/sort.t 0 138 119 72 60.50% 48-119
56 tests and 474 subtests skipped.
Failed 3/811 test scripts, 99.63% okay. 78/75813 subtests failed, 99.90% okay.
Failed 3/811 test scripts, 99.63% okay. 78/75813 subtests failed,
99.90% okay.

They are suspected to be compiler errors (at least the shuffle.t
failure is known from some IRIX 6 setups) and math library errors
Expand Down
13 changes: 7 additions & 6 deletions README.macosx
Expand Up @@ -63,7 +63,7 @@ on a file server and used by many Macs.

First, export the path to the SDK into the build environment:

export SDK=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.8.sdk
export SDK=/Applications/Xcode.app/Contents/Developer/Platforms/MacOSX.platform/Developer/SDKs/MacOSX10.8.sdk

Please make sure the SDK version (i.e. the numbers right before '.sdk')
matches your system's (in this case, Mac OS X 10.8 "Mountain Lion"), as it is
Expand Down Expand Up @@ -100,11 +100,12 @@ Mac OS X 10.5 "Leopard" and above do not require the 'u' variant.
In addition to the compiler flags used to select the SDK, also add the flags
for creating a universal binary:

./Configure -Accflags="-arch i686 -arch ppc -nostdinc -B$SDK/usr/include/gcc \
-B$SDK/usr/lib/gcc -isystem$SDK/usr/include \
-F$SDK/System/Library/Frameworks" \
-Aldflags="-arch i686 -arch ppc -Wl,-syslibroot,$SDK" \
-de
./Configure -Accflags="-arch i686 -arch ppc -nostdinc \
-B$SDK/usr/include/gcc \
-B$SDK/usr/lib/gcc -isystem$SDK/usr/include \
-F$SDK/System/Library/Frameworks" \
-Aldflags="-arch i686 -arch ppc -Wl,-syslibroot,$SDK" \
-de

Keep in mind that these compiler and linker settings will also be used when
building CPAN modules. For XS modules to be compiled as a universal binary, any
Expand Down
12 changes: 8 additions & 4 deletions README.netware
Expand Up @@ -151,11 +151,13 @@ Run the following command at the command prompt:

Example:

perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread -Ic:\perl\5.6.1\lib MakeFile.pl
perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread \
-Ic:\perl\5.6.1\lib MakeFile.pl

or

perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread -Ic:\perl\5.8.0\lib MakeFile.pl
perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread \
-Ic:\perl\5.8.0\lib MakeFile.pl

=item *

Expand All @@ -174,12 +176,14 @@ typing I<nmake install>, will copy the files onto the NetWare server.

Example: You can execute the following on the command prompt.

perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread -Ic:\perl\5.6.1\lib MakeFile.pl
perl -Ic:/perl/5.6.1/lib/NetWare-x86-multi-thread \
-Ic:\perl\5.6.1\lib MakeFile.pl
INSTALLSITELIB=i:\perl\lib

or

perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread -Ic:\perl\5.8.0\lib MakeFile.pl
perl -Ic:/perl/5.8.0/lib/NetWare-x86-multi-thread \
-Ic:\perl\5.8.0\lib MakeFile.pl
INSTALLSITELIB=i:\perl\lib

=item *
Expand Down

0 comments on commit ce036c3

Please sign in to comment.