commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Gary Gregory <GGreg...@seagullsoftware.com>
Subject Re: [VFS] @since markers missing
Date Mon, 15 Nov 2010 01:32:39 GMT
On Nov 14, 2010, at 17:20, "sebb" <sebbaz@gmail.com> wrote:

> On 15 November 2010 01:04, Ralph Goers <ralph.goers@dslextreme.com> wrote:
>> Checkstyle in VFS verifies that author tags are present as that is the default setting.
I don't see a checkstyle setting to enforce that they are not present.  However, I believe
it can enforce that it match a fixed expression.
>> 
>> As part of cleaning up the checkstyle results I've added @author tags wherever they
were missing with
>> @author <a href="http://commons.apache.org/vfs/team-list.html">Commons VFS
team</a>
>> 
>> I copied this pattern from Commons Configuration as all modules are tagged this way.
> 
> I don't think author tags should be _required_ because it should be
> obvious that ASF code is written by the ASF community.

I agree with all of your msg. I like the idea of author tags because it allows automated tool
to look at source code and gather said tags. But I do not know of folks who actually do this.


GG 
> 
> See also below.
> 
>> I have not changed modules that had existing author tags but it should be easy to
do that by changing the checkstyle rule.
>> 
>> Ralph
>> 
>> On Nov 14, 2010, at 4:39 PM, Gary Gregory wrote:
>> 
>>> On Nov 14, 2010, at 16:28, "James Carman" <james@carmanconsulting.com>
wrote:
>>> 
>>>> "author tags are officially discouraged"
>>>> 
>>>> The board decided long ago that @author tags were discouraged.  Let's
>>>> just remove them.  If you want to credit someone, add their name to
>>>> the pom.xml file as a contributor.
>>> 
> 
> AIUI the board was referring to individual author names, as code is
> written by the community.
> Also any individual author tags are soon out of date.
> 
>>> Yes I remember that but I thought it was also suggested that all author tags
be "Apache Software Foundation" instead.
> 
> Using ASF or Commons or some other appropriate collective name seems
> fine to me, as it expresses that the code is written by the community.
> Also does not get out of date so easily.
> 
>>> GG
>>>> 
>>>> On Sun, Nov 14, 2010 at 7:05 PM, Gary Gregory
>>>> <GGregory@seagullsoftware.com> wrote:
>>>>> On Nov 14, 2010, at 5:09, "sebb" <sebbaz@gmail.com> wrote:
>>>>> 
>>>>>> Just noticed that there are no @since markers for any of the additions
>>>>>> to the code made since 1.0.
>>>>>> 
>>>>>> I think these are important, and should be present.
>>>>>> 
>>>>>> I'm happy to add them to the code-base.
>>>>> 
>>>>> +1. How about @author tags with ASF as the author for any files that
are sans  tag?
>>>>> 
>>>>> GG
>>>>>> 
>>>>>> ---------------------------------------------------------------------
>>>>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>>>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>>>> 
>>>>> 
>>>>> ---------------------------------------------------------------------
>>>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>>> 
>>>>> 
>>>> 
>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>>> For additional commands, e-mail: dev-help@commons.apache.org
>>>> 
>>> 
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>>> For additional commands, e-mail: dev-help@commons.apache.org
>>> 
>> 
>> 
>> ---------------------------------------------------------------------
>> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
>> For additional commands, e-mail: dev-help@commons.apache.org
>> 
>> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@commons.apache.org
> For additional commands, e-mail: dev-help@commons.apache.org
> 

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


Mime
View raw message