From: Glenn Adams <gadams@apache.org>
Date: Tue, 6 Mar 2012 00:07:13 +0000 (+0000)
Subject: update convention documentation regarding @author usage
X-Git-Tag: fop-1_1rc1old~101
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=43e37136e1c31da381739a55254fc2d4bb5ef102;p=xmlgraphics-fop.git

update convention documentation regarding @author usage

git-svn-id: https://svn.apache.org/repos/asf/xmlgraphics/fop/trunk@1297305 13f79535-47bb-0310-9956-ffa450edef68
---

diff --git a/src/documentation/content/xdocs/dev/conventions.xml b/src/documentation/content/xdocs/dev/conventions.xml
index e68c11a5e..4fd949fdd 100644
--- a/src/documentation/content/xdocs/dev/conventions.xml
+++ b/src/documentation/content/xdocs/dev/conventions.xml
@@ -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>