svn commit: r814975 - /forrest/trunk/site-author/content/xdocs/tasks.xml

Author: crossley
Date: Tue Sep 15 03:01:58 2009
New Revision: 814975

URL: http://svn.apache.org/viewvc?rev=814975&view=rev
Log:
Improve the documentation about "Subversion Monitoring", svn:eol-style line endings, and "tidy-xml".
Issue: FOR-124 and FOR-644

Modified:
    forrest/trunk/site-author/content/xdocs/tasks.xml

Modified: forrest/trunk/site-author/content/xdocs/tasks.xml
URL: http://svn.apache.org/viewvc/forrest/trunk/site-author/content/xdocs/tasks.xml?rev=814975&r1=814974&r2=814975&view=diff
==============================================================================
--- forrest/trunk/site-author/content/xdocs/tasks.xml (original)
+++ forrest/trunk/site-author/content/xdocs/tasks.xml Tue Sep 15 03:01:58 2009
@@ -168,22 +168,42 @@
       <section id="subversion-monitoring">
         <title>Subversion Monitoring</title>
         <p>
-          Ensure that svn:eol-style settings are "native" for all text files.
+          The issue of whitespace is important in projects which have developers
+          on both Windows and UNIX-based operating systems. The unnecessary
+          differences obscure the real changes and so make it difficult for
+          people to be aware.
         </p>
         <p>
-          Ensure no line-endings issues.
+          Ensure that svn:eol-style settings are "native" for all text files.
+          Encourage people to properly
+          <a href="http://www.apache.org/dev/version-control.html#https-svn-config">configure</a>
+          their SVN client.
+          Detect such issues using a script like
+          <a href="https://svn.apache.org/repos/private/committers/tools/report_svn_text.pl">committers/tools/report_svn_text.pl</a>
+          See also some tips in
+          <a href="https://issues.apache.org/jira/browse/FOR-124">FOR-124</a>.
         </p>
         <p>
-          Regularly run xml-tidy. (Not yet ready.)
+          Ensure no line-endings issues. This is coupled with the abovementioned
+          "svn:eol-style" issue.
+          Detect such issues using a script like
+          <a href="https://svn.apache.org/repos/private/committers/tools/find_carriage_returns.sh">committers/tools/find_carriage_returns.sh</a>
+        </p>
+        <p>
+          Regularly tidy the whitespace in xml files.
+          See the script
+          <a href="http://svn.apache.org/repos/asf/forrest/trunk/etc/tidy-xml.pl">$FORREST_HOME/etc/tidy-xml.pl</a>
+          and the
+          <a href="http://svn.apache.org/repos/asf/forrest/trunk/etc/tidy-config.txt">$FORREST_HOME/etc/tidy-config.txt</a> configuration file.
+          This is best done as part of the release process, when everyone should
+          have already committed any outstanding changes. With such an operation,
+          there is a high chance of conflicts.
+          See also some tips in
+          <a href="https://issues.apache.org/jira/browse/FOR-644">FOR-644</a>.
         </p>
         <p>
           Regularly run java-tidy. (Not yet ready.)
         </p>
-        <p>
-          There are already some Perl scripts and other tools in the
-          "<a href="https://svn.apache.org/repos/private/committers">committers</a>"
-          SVN in the "tools" directory.
-        </p>
       </section>
       <section id="legal-monitoring">
         <title>Legal Monitoring</title>
@@ -202,6 +222,8 @@
           <a href="https://issues.apache.org/jira/browse/FOR-855">FOR-855</a>
           and
           <a href="https://issues.apache.org/jira/browse/FOR-123">FOR-123</a>.
+          Also see $FORREST_HOME/etc/relicense.txt and
+          $FORREST_HOME/etc/relicense-avoid.txt files.
         </p>
         <p>
           Regularly ensure that there are appropriate matching licenses to