tomcat-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From sebb <seb...@gmail.com>
Subject Re: [PROPOSAL] Remove SVN keywords from JavaDoc
Date Wed, 22 Jul 2009 12:01:04 GMT
On 07/07/2009, Mark Thomas <markt@apache.org> wrote:
> Konstantin Kolinko wrote:
>  > As was written early in this my thread:
>  > http://www.nabble.com/Coding-Guidelines%2C-encodings%2C-keywords-td23662661.html
>  > (http://markmail.org/thread/d6dsgrsfvnuzclt7)
>  >
>  > there are problems with Subversion $Date$ keyword:
>  > 1. It uses localized names for the month and the day of the week
>  > 2. It writes those localized strings using UTF-8, while our sources
>  > are ISO-8859-1
>  > 3. The time that is printed is in local timezone
>  >
>  > There are two possible solutions (besides ignoring the issue):
>  > a) Use $Id:$ keyword instead
>  > b) Remove the keyword
>  >
>  > For the java sources, I propose the simpler one of the above:
>  >
>  > I propose to remove *all* SVN keywords from our *.java sources, where they are
>  > used in JavaDoc comments.
>  > That includes the following four keywords: Author Date Id Revision
>  >
>  > As it is a documentation change, I won't propose a patch, but go C-T-R.
>  >
>  > What are your opinions?
>  > If there are any objections to such a change, please write so.
>
>
> I'm happy getting rid of all of them. The only times I have used them
>  there have been equally quick, equally effective ways of finding out the
>  information I was after (usually Tomcat version).

+1

Apart from encoding issues, any SVN keywords that can vary between
users (e.g. Header, Date) are a nuisance when comparing source files
(e.g. tag checkout against source archive) as they generate spurious
differences.

>  Mark
>
>
>
>  ---------------------------------------------------------------------
>  To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
>  For additional commands, e-mail: dev-help@tomcat.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org


Mime
View raw message