In perl.git, the branch blead has been updated <http://perl5.git.perl.org/perl.git/commitdiff/0d95c67f310e651be3b885bb56bfa0ed9498ef70?hp=bc031a7db12b65005ee269452348897e29a44e91>
- Log ----------------------------------------------------------------- commit 0d95c67f310e651be3b885bb56bfa0ed9498ef70 Author: Karl Williamson <k...@cpan.org> Date: Wed May 7 14:32:43 2014 -0600 Fix remaining too-long verbatim lines in perlxstut.pod M dist/ExtUtils-ParseXS/lib/perlxstut.pod M t/porting/known_pod_issues.dat commit b160fb0ed91bd57b13f01a9c10c60f8976debd18 Author: kafka <ka...@madrognon.net> Date: Wed May 7 15:38:34 2014 +0200 Bring a few lines in perlxstut.pod under 80 cols M AUTHORS M dist/ExtUtils-ParseXS/lib/perlxstut.pod M t/porting/known_pod_issues.dat ----------------------------------------------------------------------- Summary of changes: AUTHORS | 1 + dist/ExtUtils-ParseXS/lib/perlxstut.pod | 88 +++++++++++++++++---------------- t/porting/known_pod_issues.dat | 1 - 3 files changed, 47 insertions(+), 43 deletions(-) diff --git a/AUTHORS b/AUTHORS index dc5e8d0..2fb096e 100644 --- a/AUTHORS +++ b/AUTHORS @@ -641,6 +641,7 @@ John E. Malmberg <wb8...@qsl.net> Jörg Walter <jw...@cpan.org> José Pedro Oliveira <j...@di.uminho.pt> Ka-Ping Yee <kp...@aw.sgi.com> +kafka <ka...@madrognon.net> Kang-min Liu <gu...@gugod.org> Kaoru Maeda <ma...@src.ricoh.co.jp> Karen Etheridge <et...@cpan.org> diff --git a/dist/ExtUtils-ParseXS/lib/perlxstut.pod b/dist/ExtUtils-ParseXS/lib/perlxstut.pod index 381622e..a254688 100644 --- a/dist/ExtUtils-ParseXS/lib/perlxstut.pod +++ b/dist/ExtUtils-ParseXS/lib/perlxstut.pod @@ -51,8 +51,9 @@ in F<Makefile.PL> for this purpose: eval { require 5.007 } or die <<EOD; ############ - ### This module uses frobnication framework which is not available before - ### version 5.007 of Perl. Upgrade your Perl before installing Kara::Mba. + ### This module uses frobnication framework which is not available + ### before version 5.007 of Perl. Upgrade your Perl before + ### installing Kara::Mba. ############ EOD @@ -154,7 +155,8 @@ The file Mytest.pm should start with something like this: 1; __END__ - # Below is the stub of documentation for your module. You better edit it! + # Below is the stub of documentation for your module. You better + # edit it! The rest of the .pm file contains sample code for providing documentation for the extension. @@ -194,22 +196,22 @@ Now, running make will produce output that looks something like this (some long lines have been shortened for clarity and some extraneous lines have been deleted): - % make - cp lib/Mytest.pm blib/lib/Mytest.pm - perl xsubpp -typemap typemap Mytest.xs > Mytest.xsc && mv Mytest.xsc Mytest.c - Please specify prototyping behavior for Mytest.xs (see perlxs manual) - cc -c Mytest.c - Running Mkbootstrap for Mytest () - chmod 644 Mytest.bs - rm -f blib/arch/auto/Mytest/Mytest.so - cc -shared -L/usr/local/lib Mytest.o -o blib/arch/auto/Mytest/Mytest.so \ - \ - - chmod 755 blib/arch/auto/Mytest/Mytest.so - cp Mytest.bs blib/arch/auto/Mytest/Mytest.bs - chmod 644 blib/arch/auto/Mytest/Mytest.bs - Manifying blib/man3/Mytest.3pm - % + % make + cp lib/Mytest.pm blib/lib/Mytest.pm + perl xsubpp -typemap typemap Mytest.xs > Mytest.xsc && \ + mv Mytest.xsc Mytest.c + Please specify prototyping behavior for Mytest.xs (see perlxs manual) + cc -c Mytest.c + Running Mkbootstrap for Mytest () + chmod 644 Mytest.bs + rm -f blib/arch/auto/Mytest/Mytest.so + cc -shared -L/usr/local/lib Mytest.o -o blib/arch/auto/Mytest/Mytest.so + + chmod 755 blib/arch/auto/Mytest/Mytest.so + cp Mytest.bs blib/arch/auto/Mytest/Mytest.bs + chmod 644 blib/arch/auto/Mytest/Mytest.bs + Manifying blib/man3/Mytest.3pm + % You can safely ignore the line about "prototyping behavior" - it is explained in L<perlxs/"The PROTOTYPES: Keyword">. @@ -270,8 +272,9 @@ when the test is correct, "not ok" when it is not. ######################### - # Insert your test code below, the Test::More module is use()ed here so read - # its man page ( perldoc Test::More ) for help writing this test script. + # Insert your test code below, the Test::More module is use()ed here + # so read its man page ( perldoc Test::More ) for help writing this + # test script. is(&Mytest::is_even(0), 1); is(&Mytest::is_even(1), 0); @@ -280,13 +283,13 @@ when the test is correct, "not ok" when it is not. We will be calling the test script through the command "C<make test>". You should see output that looks something like this: - %make test - PERL_DL_NONLAZY=1 /usr/bin/perl "-MExtUtils::Command::MM" "-e" - "test_harness(0, 'blib/lib', 'blib/arch')" t/*.t - t/Mytest....ok - All tests successful. - Files=1, Tests=4, 0 wallclock secs ( 0.03 cusr + 0.00 csys = 0.03 CPU) - % + %make test + PERL_DL_NONLAZY=1 /usr/bin/perl "-MExtUtils::Command::MM" "-e" + "test_harness(0, 'blib/lib', 'blib/arch')" t/*.t + t/Mytest....ok + All tests successful. + Files=1, Tests=4, 0 wallclock secs ( 0.03 cusr + 0.00 csys = 0.03 CPU) + % =head2 What has gone on? @@ -650,8 +653,8 @@ and add the following lines to the end of the script: equality, but rather that the difference between the expected and actual result is below a certain amount (called epsilon) which is 0.01 in this case) -Run "C<make test>" and all should be well. There are some warnings on missing tests -for the Mytest2::mylib extension, but you can ignore them. +Run "C<make test>" and all should be well. There are some warnings on missing +tests for the Mytest2::mylib extension, but you can ignore them. =head2 What has happened here? @@ -862,11 +865,12 @@ For example, consider: char &a char * b -The first Perl argument to this function would be treated as a char and assigned -to the variable a, and its address would be passed into the function foo. -The second Perl argument would be treated as a string pointer and assigned to the -variable b. The I<value> of b would be passed into the function foo. The -actual call to the function foo that B<xsubpp> generates would look like this: +The first Perl argument to this function would be treated as a char and +assigned to the variable a, and its address would be passed into the function +foo. The second Perl argument would be treated as a string pointer and assigned +to the variable b. The I<value> of b would be passed into the function foo. +The actual call to the function foo that B<xsubpp> generates would look like +this: foo(&a, b); @@ -1175,18 +1179,18 @@ true, which indicates that paths is a valid reference. (Simply checking C<SvROK> won't trigger FETCH on a tied variable.) It then verifies that the object referenced by paths is an array, using C<SvRV> to dereference paths, and C<SvTYPE> to discover its type. As an added test, -it checks that the array referenced by paths is non-empty, using the C<av_top_index> -function (which returns -1 if the array is empty). The XSRETURN_UNDEF macro -is used to abort the XSUB and return the undefined value whenever all three of -these conditions are not met. +it checks that the array referenced by paths is non-empty, using the +C<av_top_index> function (which returns -1 if the array is empty). The +XSRETURN_UNDEF macro is used to abort the XSUB and return the undefined value +whenever all three of these conditions are not met. =item * We manipulate several arrays in this XSUB. Note that an array is represented internally by an AV* pointer. The functions and macros for manipulating -arrays are similar to the functions in Perl: C<av_top_index> returns the highest -index in an AV*, much like $#array; C<av_fetch> fetches a single scalar value -from an array, given its index; C<av_push> pushes a scalar value onto the +arrays are similar to the functions in Perl: C<av_top_index> returns the +highest index in an AV*, much like $#array; C<av_fetch> fetches a single scalar +value from an array, given its index; C<av_push> pushes a scalar value onto the end of the array, automatically extending the array as necessary. Specifically, we read pathnames one at a time from the input array, and diff --git a/t/porting/known_pod_issues.dat b/t/porting/known_pod_issues.dat index 91ecb88..d36f97b 100644 --- a/t/porting/known_pod_issues.dat +++ b/t/porting/known_pod_issues.dat @@ -198,7 +198,6 @@ YAML YAML::Syck YAML::Tiny dist/data-dumper/dumper.pm ? Should you be using L<...> instead of 1 -dist/extutils-parsexs/lib/perlxstut.pod Verbatim line length including indents exceeds 79 by 9 dist/math-bigint/lib/math/bigint.pm Verbatim line length including indents exceeds 79 by 71 dist/math-bigrat/lib/math/bigrat.pm Verbatim line length including indents exceeds 79 by 7 dist/module-corelist/lib/module/corelist.pod Verbatim line length including indents exceeds 79 by 4 -- Perl5 Master Repository