Author: paultcochrane Date: Sat Mar 17 15:54:50 2007 New Revision: 17581 Modified: trunk/docs/pdds/pdd07_codingstd.pod
Log: [docs] Gleaned as much info as possible from docs/submissions.pod, http://www.parrotcode.org/source.html and t/distro/file_metadata.t on the topic of subversion properties. Modified: trunk/docs/pdds/pdd07_codingstd.pod ============================================================================== --- trunk/docs/pdds/pdd07_codingstd.pod (original) +++ trunk/docs/pdds/pdd07_codingstd.pod Sat Mar 17 15:54:50 2007 @@ -442,7 +442,78 @@ You could hoist the C<int i;> outside the test, but then you'd have an C<i> that's visible after it's used, which is confusing at best. +=head2 Subversion properties +=head3 svn:ignore + +(from F<docs/submissions.pod>) + +Sometimes new files will be created in the configuration and build process of +Parrot. These files should not show up when checking the distribution with + + svn status + +or + + perl tools/dev/manicheck.pl + +The list of these ignore files can be set up with: + + svn propedit svn:ignore <PATH> + +In order to keep the two different checks synchronized, +the MANIFEST and MANIFEST.SKIP file should be regenerated with: + + perl tools/dev/mk_manifest_and_skip.pl + +=head3 svn:keywords + +The C<svn:keywords> property should be set to + + Author Date Id Revision + +on each(?) file. Do this with the command: + + svn propset svn:keywords "Author Date Id Revision" <filename> + +That the files needing this property is set is checked by +F<t/distro/file_metadata.t>. + +=head3 svn:eol-style + +The C<svn:eol-style> property makes sure that whenever a file is checked out +of subversion that it has the correct end-of-line characters appropriate for +the given platform. Therefore, B<most> files should have their +C<svn:eol-style> property set to C<native>. However, this is B<not> true +for B<all> files. Some input files to tests (such as the C<*.input> and +C<*.output> files for pir tests) B<need> to have C<LF> as their +C<svn:eol-style> property. The current list of such files is described in +F<t/distro/file_metadata.t>. + +Set the C<svn:eol-style> property to C<native> with the command: + + svn propset svn:eol-sytle "native" <filename> + +Set the C<svn:eol-style> property to C<LF> with the command: + + svn propset svn:eol-sytle "LF" <filename> + +That the files needing this property is set is checked by +F<t/distro/file_metadata.t>. + +=head3 svn:mime-type + +(Adapted from L<http://www.parrotcode.org/source.html>) + +The C<svn:mime-type> property should be set to C<text-plain> for all test +files. For instance, one can set up the use of I<auto-props> within +subversion so that this is set for you automatically. To do so, add the +following to your F<~/.subversion/config>: + + [miscellany] + enable-auto-props = yes + [auto-props] + *.t = svn:mime-type=text/plain =head2 CHIP HAS EDITED THIS FAR INTO THE FILE
