Author: paultcochrane Date: Mon Jan 8 12:45:33 2007 New Revision: 16498 Modified: trunk/docs/pdds/pdd07_codingstd.pod
Changes in other areas also in this revision: Modified: trunk/ (props changed) Log: [pdd] Added a section explaining files to be considered exempt from the coding standards tests. Modified: trunk/docs/pdds/pdd07_codingstd.pod ============================================================================== --- trunk/docs/pdds/pdd07_codingstd.pod (original) +++ trunk/docs/pdds/pdd07_codingstd.pod Mon Jan 8 12:45:33 2007 @@ -909,6 +909,20 @@ may want to code for speed first, then tweak to reclaim some space while not affecting performance. +=head1 EXEMPTIONS + +Not all files can strictly fall under these guidelines as they are +automatically generated by other tools, or are external files included in +the Parrot repository for convenience. Such files include the C header and +source files automatically generated by (f)lex and yacc/bison, and some of +the Perl modules under the C<lib/> directory. + +To exempt a file (or directory of files) from checking by the coding +standards tests, one must edit the appropriate exemption list within +C<lib/Parrot/Distribution.pm> (in either of the methods C<is_c_exemption()> +or C<is_perl_exemption()>). One can use wildcards in the list to exempt, +for example, all files under a given directory. + =head1 REFERENCES
