]> source.dussan.org Git - xmlgraphics-fop.git/commitdiff
update convention documentation regarding @author usage
authorGlenn Adams <gadams@apache.org>
Tue, 6 Mar 2012 00:07:13 +0000 (00:07 +0000)
committerGlenn Adams <gadams@apache.org>
Tue, 6 Mar 2012 00:07:13 +0000 (00:07 +0000)
git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1297305 13f79535-47bb-0310-9956-ffa450edef68

src/documentation/content/xdocs/dev/conventions.xml

index e68c11a5e3db946ff8cc87d311da97919cfc98bd..4fd949fdddbd43a8789d3d5e18631990e8a4b412 100644 (file)
@@ -102,12 +102,10 @@ In general, other languages must not be used, except in translated documentation
             <td>checkstyle</td>
           </tr>
           <tr>
-            <td>Personal attribution in the source code, such as @author tags and attribution comments should not be used.
-Excepted from this general rule are potentially confusing or wide-ranging changes.
-If such changes prove useful over time, the related comments should be removed.</td>
-            <td>Personal attribution tends to clutter the code.
-The relevant historical information that might be useful for problem-solving is tracked in the code repository.</td>
-            <td>Not enforced. Anyone is free to remove such comments.</td>
+            <td>By <link href="http://mail-archives.apache.org/mod_mbox/jakarta-jmeter-dev/200402.mbox/%3C4039F65E.7020406@atg.com%3E">ASF policy</link>, @author tags are officially discouraged.
+However it is permissible to indicate the original author(s) of an entire file or package in a comment provided it follows the copyright and license header.</td>
+            <td>Attribution of subsequent contributions are recorded by the SVN commit history logs, so should not be included.</td>
+            <td>checkstyle</td>
           </tr>
         </table>
         <p>For developers that dislike these conventions, one workaround is to develop using their own style, then use a formatting tool like <link href="http://astyle.sourceforge.net/">astyle</link> (Artistic Style) before committing.</p>