This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Devel-PPPort: Fix up pod
authorKarl Williamson <khw@cpan.org>
Fri, 27 Oct 2017 16:40:42 +0000 (10:40 -0600)
committerKarl Williamson <khw@cpan.org>
Fri, 27 Oct 2017 16:43:27 +0000 (10:43 -0600)
Now that this module is in dist, podcheck runs, and found problems,
which this commit fixes.

dist/Devel-PPPort/HACKERS
dist/Devel-PPPort/devel/buildperl.pl
t/porting/known_pod_issues.dat

index c5fe0ed..4f35404 100644 (file)
@@ -45,16 +45,16 @@ a C file is generated by F<parts/apicheck.pl> that is compiled
 and linked with C<Devel::PPPort>. This C file has the purpose of
 using each of the public API functions/macros once.
 
-The required information is derived from C<parts/embed.fnc> (just
-a copy of bleadperl's C<embed.fnc>), C<parts/apidoc.fnc> (which
+The required information is derived from F<parts/embed.fnc> (just
+a copy of bleadperl's F<embed.fnc>), F<parts/apidoc.fnc> (which
 is generated by F<devel/mkapidoc.sh> and simply collects the rest
 of the apidoc entries spread over the Perl source code) and
-C<parts/ppport.fnc> (which lists all API provided purely by
+F<parts/ppport.fnc> (which lists all API provided purely by
 Devel::PPPort).
-The generated C file C<apicheck.c> is currently about 500k in size
+The generated C file F<apicheck.c> is currently about 500k in size
 and takes quite a while to compile.
 
-Usually, C<apicheck.c> won't compile with older perls. And even if
+Usually, F<apicheck.c> won't compile with older perls. And even if
 it compiles, there's still a good chance of the dynamic linker
 failing at C<make test> time. But that's on purpose!
 
@@ -73,16 +73,16 @@ and the dynamic linker is happy. (Actually, this process may generate
 false positives, so by default each API call is checked once more
 afterwards.)
 
-Running C<devel/mktodo> takes about an hour, depending of course
+Running F<devel/mktodo> takes about an hour, depending of course
 on the machine you're running it on. If you run it with
 the C<--nocheck> option, it won't recheck the API calls that failed
 in the compilation stage and it'll take significantly less time.
 Running with C<--nocheck> should usually be safe.
 
-When running C<devel/mktodo> with the C<--base> option, it will
+When running F<devel/mktodo> with the C<--base> option, it will
 generate the I<baseline> todo files by disabling all functionality
 provided by C<Devel::PPPort>. These are required for implementing
-the C<--compat-version> option of the C<ppport.h> script. The
+the C<--compat-version> option of the F<ppport.h> script. The
 baseline todo files hold the information about which version of
 Perl lacks a certain part of the API.
 
@@ -166,7 +166,7 @@ F<PPPort.pm>, the XS code in F<RealPPPort.xs> and various test files
 in F<t/>.
 
 All of these files could be generated on the fly while building
-C<Devel::PPPort>, but not having the tests in C<t/> will confuse
+C<Devel::PPPort>, but not having the tests in F<t/> will confuse
 TEST/harness in the core. Not having F<PPPort.pm> will be bad for
 viewing the docs on C<search.cpan.org>. So unfortunately, it's
 unavoidable to put some redundancy into the package.
@@ -320,6 +320,6 @@ modify it under the same terms as Perl itself.
 
 =head1 SEE ALSO
 
-See L<ppport.h> and L<devel/regenerate>.
+See F<ppport.h> and F<devel/regenerate>.
 
 =cut
index 916ed8f..72c1929 100644 (file)
@@ -536,7 +536,8 @@ buildperl.pl - build/install perl distributions
                               [default: /tmp/perl/build/<config>]
 
   --prefix=directory          use this installation prefix [EXPAND]
-                              [default: /tmp/perl/install/<config>/<perl>]
+                              [default:
+                              /tmp/perl/install/<config>/<perl>]
 
   --config=configuration      build this configuration [MULTI]
                               [default: all possible configurations]
@@ -544,16 +545,19 @@ buildperl.pl - build/install perl distributions
   --perl=version              build this version of perl [MULTI]
                               [default: all possible versions]
 
-  --force                     rebuild and install already installed versions
+  --force                     rebuild and install already installed
+                              versions
 
   --test                      run test suite after building
 
   --noinstall                 don't install after building
 
-  --patch                     only patch the perl source in the current directory
+  --patch                     only patch the perl source in the current
+                              directory
 
-  --oneshot                   build from the perl source in the current directory
-                              (extra arguments are passed to Configure)
+  --oneshot                   build from the perl source in the current
+                              directory (extra arguments are passed to
+                              Configure)
 
   options tagged with [MULTI] can be given multiple times
 
@@ -587,7 +591,8 @@ and don't install them, run:
 To build and install a single version of perl with special configuration
 options, use:
 
-  buildperl.pl --perl=5.6.0 --prefix=/opt/p560ld --oneshot -- -des -Duselongdouble
+  buildperl.pl --perl=5.6.0 --prefix=/opt/p560ld --oneshot -- -des \
+                                                   -Duselongdouble
 
 =head1 COPYRIGHT
 
index 214b7a3..7545ccf 100644 (file)
@@ -330,9 +330,6 @@ YAML::Syck
 YAML::Tiny
 dist/data-dumper/changes       Verbatim line length including indents exceeds 79 by    1
 dist/data-dumper/dumper.pm     ? Should you be using L<...> instead of 1
-dist/devel-ppport/devel/buildperl.pl   Verbatim line length including indents exceeds 79 by    5
-dist/devel-ppport/hackers      ? Should you be using F<...> or maybe L<...> instead of 5
-dist/devel-ppport/hackers      Apparent broken link    1
 dist/devel-ppport/parts/inc/ppphdoc    Unknown directive: =dontwarn    1
 dist/devel-ppport/parts/inc/ppphdoc    Unknown directive: =implementation      1
 dist/devel-ppport/parts/inc/ppphdoc    Unknown directive: =provides    1