You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@directory.apache.org by Felix Knecht <fe...@otego.com> on 2010/06/06 11:40:19 UTC
Javadocs / Header / Svn tags
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
In Coding standards [1] we say that we don't want to have names in the
hader. I agree, but IMO wouldn't it be nice to no ate least how old the
code is? I suggest to a a seconed line indication the revision and the
date of the last commit (some files already have this header) -->
@author <a href="mailto:dev@directory.apache.org">Apache Directory
Project</a>
@version $Rev: 951845 $, $Date: 2010-06-06 11:13:46 +0200 (Sun, 06 Jun
2010) $
Any objections?
If not I'll start to fix this and add the needed svn properties to the
files (svn propset svn:keywords "Rev Revision Date" *).
Regards
Felix
[1] https://cwiki.apache.org/DIRxDEV/coding-standards.html
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.15 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iEYEARECAAYFAkwLbQMACgkQ2lZVCB08qHGj3gCgwZoLGoaw19FXYPMwsBS0Ad80
A2sAoJRQ45tWs/29FnVZJwrpS3RLqguk
=gtbo
-----END PGP SIGNATURE-----
Re: Javadocs / Header / Svn tags
Posted by Emmanuel Lecharny <el...@gmail.com>.
On 6/6/10 2:03 PM, Felix Knecht wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> On 06/06/10 13:42, Emmanuel Lecharny wrote:
>
>> On 6/6/10 1:32 PM, Felix Knecht wrote:
>>
>>> -----BEGIN PGP SIGNED MESSAGE-----
>>> Hash: SHA1
>>>
>>>
>>>
>>>> Why pollute the headers with such redondant informations ?
>>>>
>>>>
>>> You're right.
>>>
>>>
>>>
>>>> I mean, this is really only useful to developper, and even on any decent
>>>> IDE, you can ask for the file history with the name of the last
>>>> modified, the last modification date, the log etc...
>>>>
>>>>
>>> In this case I'll clean up the other files.
>>>
>>>
>> Do we have a lot of them ?
>>
> Probably yes, the pattern is in the codetemplates.xml we recommend I
> think
> (https://cwiki.apache.org/DIRxDEV/coding-standards.data/codetemplates.xml):
>
> /**
> * ${todo} ${type_name}.
> *
> * @author<a href="mailto:dev@directory.apache.org">Apache Directory
> Project</a>
> * @version $$Rev$$, $$Date$$
> */
>
Let's get rid of that, then ...
Unless someone had a very valid reason to keep them ?
--
Regards,
Cordialement,
Emmanuel Lécharny
www.nextury.com
Re: Javadocs / Header / Svn tags
Posted by Felix Knecht <fe...@apache.org>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
On 06/06/10 13:42, Emmanuel Lecharny wrote:
> On 6/6/10 1:32 PM, Felix Knecht wrote:
>> -----BEGIN PGP SIGNED MESSAGE-----
>> Hash: SHA1
>>
>>
>>> Why pollute the headers with such redondant informations ?
>>>
>> You're right.
>>
>>
>>> I mean, this is really only useful to developper, and even on any decent
>>> IDE, you can ask for the file history with the name of the last
>>> modified, the last modification date, the log etc...
>>>
>> In this case I'll clean up the other files.
>>
> Do we have a lot of them ?
Probably yes, the pattern is in the codetemplates.xml we recommend I
think
(https://cwiki.apache.org/DIRxDEV/coding-standards.data/codetemplates.xml):
/**
* ${todo} ${type_name}.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory
Project</a>
* @version $$Rev$$, $$Date$$
*/
> We already went through this process (removing all the spurious tags in
> header) back 4 years ago, it's definitively a never ending story :/
>
> Thanks Felix !--
>
> Regards,
> Cordialement,
> Emmanuel Lécharny
> www.nextury.com
>
>
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.15 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iEYEARECAAYFAkwLjoAACgkQ2lZVCB08qHGrgACdGGbVAiv2h2iCBpmEdMqvHb7W
xIMAnjjBtnYV72iHUtwVdq+NKM0iCwOG
=hYOO
-----END PGP SIGNATURE-----
Re: Javadocs / Header / Svn tags
Posted by Emmanuel Lecharny <el...@gmail.com>.
On 6/6/10 1:32 PM, Felix Knecht wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
>
>> Why pollute the headers with such redondant informations ?
>>
> You're right.
>
>
>> I mean, this is really only useful to developper, and even on any decent
>> IDE, you can ask for the file history with the name of the last
>> modified, the last modification date, the log etc...
>>
> In this case I'll clean up the other files.
>
Do we have a lot of them ?
We already went through this process (removing all the spurious tags in
header) back 4 years ago, it's definitively a never ending story :/
Thanks Felix !--
Regards,
Cordialement,
Emmanuel Lécharny
www.nextury.com
Re: Javadocs / Header / Svn tags
Posted by Felix Knecht <fe...@apache.org>.
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
> Why pollute the headers with such redondant informations ?
You're right.
> I mean, this is really only useful to developper, and even on any decent
> IDE, you can ask for the file history with the name of the last
> modified, the last modification date, the log etc...
In this case I'll clean up the other files.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v2.0.15 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iEYEARECAAYFAkwLhzoACgkQ2lZVCB08qHEp4QCgoDkV6c/rDO9fGhYQI4OqrOX8
AnQAnjapXCjOZtZghFyvurBxqe52TdyU
=1vEM
-----END PGP SIGNATURE-----
Re: Javadocs / Header / Svn tags
Posted by Emmanuel Lecharny <el...@gmail.com>.
On 6/6/10 11:40 AM, Felix Knecht wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> In Coding standards [1] we say that we don't want to have names in the
> hader. I agree, but IMO wouldn't it be nice to no ate least how old the
> code is? I suggest to a a seconed line indication the revision and the
> date of the last commit (some files already have this header) -->
>
> @author<a href="mailto:dev@directory.apache.org">Apache Directory
> Project</a>
> @version $Rev: 951845 $, $Date: 2010-06-06 11:13:46 +0200 (Sun, 06 Jun
> 2010) $
>
> Any objections?
>
No need for that IMO. Such information is already present on the web, if
needed :
http://svn.apache.org/viewvc/directory/shared/trunk/asn1/src/main/java/org/apache/directory/shared/asn1/AbstractAsn1Object.java?view=log
Why pollute the headers with such redondant informations ?
I mean, this is really only useful to developper, and even on any decent
IDE, you can ask for the file history with the name of the last
modified, the last modification date, the log etc...
--
Regards,
Cordialement,
Emmanuel Lécharny
www.nextury.com