# New Ticket Created by James Keenan # Please include the string: [perl #52054] # in the subject line of all future correspondence about this issue. # <URL: http://rt.perl.org/rt3/Ticket/Display.html?id=52054 >
Parrot Design Documents (PDDs) are found in docs/pdds/ and docs/pdds/ draft/. All PDDs are supposed to conform to coding standards per docs/pdds/pdd00_pdd.pod. As of r26528 today, we now have a coding standards test which identifies where particular PDDs fail to live up to the standards (cf. http://rt.perl.org/rt3/Ticket/Display.html? id=40653). As you might expect, quite a few of the PDDs don't live up to the standards, which means that this new file, t/codingstd/pdd_format.t, fails. (It will only pass when all PDDs meet the standard.) So we have a cage-cleaning opportunity here -- an opportunity particularly for anyone who has not yet contributed to the Parrot project, as the only skill you need to fix this is a little Perl 5 and a little knowledge of POD. See the attachment for PDD formatting errors. kid51
t/codingstd/pdd_format...... # Failed test ' # pdd00_pdd.pod lacks 'head1' SYNOPSIS section # # pdd03_calling_conventions.pod has 3 lines > 78 chars: 96 144 148 # pdd03_calling_conventions.pod lacks 'head1' IMPLEMENTATION section # pdd03_calling_conventions.pod lacks 'head1' SYNOPSIS section # # pdd07_codingstd.pod has 21 lines > 78 chars: 118 588 593 601 602 603 612 617 623 637 669 672 678 736 747 797 850 852 896 960 961 # pdd07_codingstd.pod lacks 'head1' SYNOPSIS section # # pdd09_gc.pod has 31 lines > 78 chars: 39 56 58 111 119 126 167 169 170 171 200 201 241 259 267 283 311 348 380 388 438 441 502 508 538 593 595 597 599 601 603 # pdd09_gc.pod lacks 'head1' SYNOPSIS section # # pdd13_bytecode.pod has 3 lines > 78 chars: 57 89 102 # pdd13_bytecode.pod lacks 'head1' SYNOPSIS section # # pdd15_objects.pod has 24 lines > 78 chars: 52 73 137 143 336 374 548 761 983 993 1042 1043 1065 1066 1119 1153 1261 1271 1282 1283 1327 1362 1379 1380 # pdd15_objects.pod lacks 'head1' SYNOPSIS section # # pdd17_pmc.pod has 23 lines > 78 chars: 83 87 170 181 251 254 257 332 465 529 658 1164 1213 1229 1280 1281 1368 1382 1545 1608 1633 1661 1841 # pdd17_pmc.pod lacks 'head1' SYNOPSIS section # # pdd18_security.pod has 15 lines > 78 chars: 24 28 35 45 67 71 72 143 157 171 177 188 192 200 206 # pdd18_security.pod lacks 'head1' SYNOPSIS section # # pdd20_lexical_vars.pod has 2 lines > 78 chars: 65 323 # pdd20_lexical_vars.pod lacks 'head1' IMPLEMENTATION section # # pdd21_namespaces.pod has 2 lines > 78 chars: 484 528 # pdd21_namespaces.pod lacks 'head1' ABSTRACT section # pdd21_namespaces.pod lacks 'head1' SYNOPSIS section # # pdd22_io.pod lacks 'head1' SYNOPSIS section # # pdd23_exceptions.pod has 2 lines > 78 chars: 67 138 # pdd23_exceptions.pod lacks 'head1' SYNOPSIS section # # pdd24_events.pod has 8 lines > 78 chars: 90 193 205 261 275 283 328 369 # pdd24_events.pod lacks 'head1' SYNOPSIS section # # pdd25_concurrency.pod has 14 lines > 78 chars: 226 235 245 248 335 337 340 346 414 417 420 423 426 432 # pdd25_concurrency.pod lacks 'head1' SYNOPSIS section # # pdd26_ast.pod lacks 'head1' SYNOPSIS section # pdd26_ast.pod lacks 'head1' REFERENCES section # # pdd27_multiple_dispatch.pod lacks 'head1' SYNOPSIS section # # draft/pdd01_overview.pod has 4 lines > 78 chars: 76 83 86 151 # draft/pdd01_overview.pod lacks 'head1' IMPLEMENTATION section # draft/pdd01_overview.pod lacks 'head1' SYNOPSIS section # draft/pdd01_overview.pod lacks 'head1' REFERENCES section # # draft/pdd04_datatypes.pod has 10 lines > 78 chars: 35 65 66 88 105 143 149 156 195 641 # draft/pdd04_datatypes.pod lacks 'head1' SYNOPSIS section # # draft/pdd05_opfunc.pod has 2 lines > 78 chars: 68 152 # draft/pdd05_opfunc.pod lacks 'head1' SYNOPSIS section # # draft/pdd06_pasm.pod has 38 lines > 78 chars: 14 15 31 36 41 42 46 47 52 64 87 113 154 155 162 176 239 263 409 415 416 418 497 506 567 780 831 845 864 903 916 950 951 973 1024 1111 1257 1278 # draft/pdd06_pasm.pod lacks 'head1' SYNOPSIS section # # draft/pdd08_keys.pod has 7 lines > 78 chars: 53 113 114 117 143 151 187 # draft/pdd08_keys.pod lacks 'head1' SYNOPSIS section # draft/pdd08_keys.pod lacks 'head1' REFERENCES section # # draft/pdd10_embedding.pod has 5 lines > 78 chars: 145 154 203 207 217 # draft/pdd10_embedding.pod lacks 'head1' SYNOPSIS section # # draft/pdd11_extending.pod has 13 lines > 78 chars: 11 16 17 18 20 28 31 32 40 110 142 174 286 # draft/pdd11_extending.pod lacks 'head1' IMPLEMENTATION section # draft/pdd11_extending.pod lacks 'head1' SYNOPSIS section # # draft/pdd14_bignum.pod has 12 lines > 78 chars: 81 106 183 235 250 252 256 257 298 299 304 400 # draft/pdd14_bignum.pod lacks 'head1' SYNOPSIS section # # draft/pdd16_native_call.pod has 3 lines > 78 chars: 64 172 177 # draft/pdd16_native_call.pod lacks 'head1' IMPLEMENTATION section # draft/pdd16_native_call.pod lacks 'head1' SYNOPSIS section # # draft/pdd19_pir.pod has 25 lines > 78 chars: 56 92 108 261 352 534 538 554 638 663 668 707 751 761 762 785 789 790 802 804 829 950 975 976 1036 # draft/pdd19_pir.pod lacks 'head1' IMPLEMENTATION section # draft/pdd19_pir.pod lacks 'head1' SYNOPSIS section # # draft/pdd28_character_sets.pod has 1 lines > 78 chars: 191 # draft/pdd28_character_sets.pod lacks 'head1' SYNOPSIS section # # ' # at t/codingstd/pdd_format.t line 43. # Looks like you failed 1 test of 1. Dubious, test returned 1 (wstat 256, 0x100) Failed 1/1 subtests Test Summary Report ------------------- t/codingstd/pdd_format.t (Wstat: 256 Tests: 1 Failed: 1) Failed test: 1 Non-zero exit status: 1 Files=1, Tests=1, 18 wallclock secs ( 0.04 usr 0.02 sys + 13.54 cusr 0.73 csys = 14.33 CPU) Result: FAIL
