You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avalon.apache.org by Leo Simons <le...@apache.org> on 2002/11/22 23:18:36 UTC
[proposal] drop @author tags from source files
Hi all,
I saw a suggestion come by in that it might be a good idea to remove
author tags from source files as it will help eliminate any community
issues that arise from ego conflicts and/or 'personal playground'
problems. Removing the tags sounds like a very pragmatic way of helping
to remove any perception of code ownership.
The only disadvantage I could see arising from this is that it might
become more difficult to figure out who you need to talk to about a
piece of code you're looking at. I think the solution to that is simple:
indicate the software was authored by the avalon people, and reference
avalon-dev. Whoever wrote that code should be around on avalon-dev :D
As to credit where credit is due....we have a list of contributors for
that, and one can always look at the cvs commits.
Hence I propose we do a global replace of
@author Some Person
(...)
@author Other Person
to
@author <a href="mailto:avalon-dev@jakarta.apache.org">Apache Avalon
Development Team</a>
Here's a +1 from me.
cheers,
- Leo Simons
I'm learning regexp at the moment but I've so far not succeeded at
writing the perl snippet that should accomplish the above so it'd be
cool if some perl guru out there were to help a little? (if not my +1
indicates I will spend an afternoon or two figuring out how to do this I
guess :D)
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Stephen McConnell <mc...@apache.org>.
Leo Simons wrote:
>Hi all,
>
>I saw a suggestion come by in that it might be a good idea to remove
>author tags from source files as it will help eliminate any community
>issues that arise from ego conflicts and/or 'personal playground'
>problems. Removing the tags sounds like a very pragmatic way of helping
>to remove any perception of code ownership.
>
>The only disadvantage I could see arising from this is that it might
>become more difficult to figure out who you need to talk to about a
>piece of code you're looking at. I think the solution to that is simple:
>indicate the software was authored by the avalon people, and reference
>avalon-dev. Whoever wrote that code should be around on avalon-dev :D
>
>As to credit where credit is due....we have a list of contributors for
>that, and one can always look at the cvs commits.
>
>Hence I propose we do a global replace of
>
>@author Some Person
>(...)
>@author Other Person
>
>to
>
>@author <a href="mailto:avalon-dev@jakarta.apache.org">Apache Avalon
>Development Team</a>
>
>Here's a +1 from me.
>
+1 ... if you or someone else does it :-)
(I'm busy writting unit tests for the type manager - good excuse, ehh)
>
>cheers,
>
>- Leo Simons
>
>I'm learning regexp at the moment but I've so far not succeeded at
>writing the perl snippet that should accomplish the above so it'd be
>cool if some perl guru out there were to help a little? (if not my +1
>indicates I will spend an afternoon or two figuring out how to do this I
>guess :D)
>
>
>--
>To unsubscribe, e-mail: <ma...@jakarta.apache.org>
>For additional commands, e-mail: <ma...@jakarta.apache.org>
>
>
>
>
>
--
Stephen J. McConnell
OSM SARL
digital products for a global economy
mailto:mcconnell@osm.net
http://www.osm.net
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by David Weitzman <da...@optonline.net>.
Leo Simons wrote
> Thanks for your help David!
>
> unfortunately, I'm quite stubborn in matters like this when I can't
> figure it out so I had already patched things (I used the swiss army
> knife for java peeps, aka Ant :D). Sorry for not making this clearer and
> wasting your time.
Not a problem. My time can't be wasted--or at least it can't be wasted more
than I already waste it. I enjoy implementing clear-cut programming tasks.
It wasn't quite a Topcoder question, but it refreshed some of my perl memory
(although I'm still waiting until Perl 6 comes out and fixes some of the
language atrocities that have been commited).
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Leo Simons <le...@apache.org>.
Thanks for your help David!
unfortunately, I'm quite stubborn in matters like this when I can't
figure it out so I had already patched things (I used the swiss army
knife for java peeps, aka Ant :D). Sorry for not making this clearer and
wasting your time.
I did try your script and got it working (I also found out my perl
install was somewhat broken ;).
cheers,
- Leo
On Sat, 2002-11-23 at 16:05, David Weitzman wrote:
> Leo Simons wrote:
> >
> > I'm learning regexp at the moment but I've so far not succeeded at
> > writing the perl snippet that should accomplish the above so it'd be
> > cool if some perl guru out there were to help a little? (if not my +1
> > indicates I will spend an afternoon or two figuring out how to do this I
> > guess :D)
> >
>
> I am by no means a Perl guru, but I read Programming Perl a year or two ago.
> I wrote a little script in Perl and tested it briefly (although Java would
> have worked just as well). It doesn't add @author to files that don't have
> them (if such a file exists), but it does replace any existing authors with
> "Apache Avalon Development Team". I'd send a diff, but it's about 115k of
> wasted bandwidth, plus you might have more fun executing it yourself (with
> modifications or whatever).
>
> The script recurses into subdirectories, looking for files that end in
> .java. When it finds java, it copies the contents into a temporary file.
> While it copies, it replaces the first occurance of @author with a user
> specified author and ignores all the other @authors as they come up.
>
> It sticks a \r\n onto the end of the changed line by default -- depending on
> your OS you may want to change that.
>
> David Weitzman
> ----
>
> --
> To unsubscribe, e-mail: <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by David Weitzman <da...@optonline.net>.
Leo Simons wrote:
>
> I'm learning regexp at the moment but I've so far not succeeded at
> writing the perl snippet that should accomplish the above so it'd be
> cool if some perl guru out there were to help a little? (if not my +1
> indicates I will spend an afternoon or two figuring out how to do this I
> guess :D)
>
I am by no means a Perl guru, but I read Programming Perl a year or two ago.
I wrote a little script in Perl and tested it briefly (although Java would
have worked just as well). It doesn't add @author to files that don't have
them (if such a file exists), but it does replace any existing authors with
"Apache Avalon Development Team". I'd send a diff, but it's about 115k of
wasted bandwidth, plus you might have more fun executing it yourself (with
modifications or whatever).
The script recurses into subdirectories, looking for files that end in
.java. When it finds java, it copies the contents into a temporary file.
While it copies, it replaces the first occurance of @author with a user
specified author and ignores all the other @authors as they come up.
It sticks a \r\n onto the end of the changed line by default -- depending on
your OS you may want to change that.
David Weitzman
Re: [proposal] drop @author tags from source files
Posted by David Weitzman <da...@optonline.net>.
Clemens Marschner wrote:
> I think this one-liner should have done the trick:
>
> find . -name '*.java' | xargs perl -pi.bak -e 'BEGIN { $newAuthor = "<a
> href=mailto:avalon-dev@jakarta.apache.org>Apache Avalon Development
> Team</a>"; $a="\@
> author"; } s/$a.*$/$a $newAuthor/g if (m/$a/ && (++$c == 1));'
Lowly Windows people like me can't use fun stuff like xargs :(. I'm still
waiting to find an old computer I can reformat and hijack, though....
I suppose in the event of a true emergency, I could always just log on to a
shell account at Sourceforge, checkout avalon, convert the files, run diff,
delete the leftover checked out files, and email or scp the diff somewhere
useful.
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Clemens Marschner <cm...@lanlab.de>.
I think this one-liner should have done the trick:
find . -name '*.java' | xargs perl -pi.bak -e 'BEGIN { $newAuthor = "<a
href=mailto:avalon-dev@jakarta.apache.org>Apache Avalon Development
Team</a>"; $a="\@
author"; } s/$a.*$/$a $newAuthor/g if (m/$a/ && (++$c == 1));'
it finds all docs ending with .java in all subdirectories of '.' and appends
the names (via xargs) to perl. perl opens each file and loops through it,
always printing out the current line after each loop (-p). -i renames each
file to .bak and prints the results back to the original file. The last "if"
takes care that only the first occurence is replaced (although i don't see
why others shouldn't).
Sometimes Perl can be more efficient than Java.....
Clemens
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Stefano Mazzocchi <st...@apache.org>.
Peter Donald wrote:
> +1 to remove them from framework which is where the real problem lies.
>
> For the rest I would prefer to leave as-is until we migrate all the stuff out.
> At that point it may be a good idea to re-address the issue with remaining
> code.
+1
--
Stefano Mazzocchi <st...@apache.org>
--------------------------------------------------------------------
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Leif Mortenson <le...@tanukisoftware.com>.
Peter Donald wrote:
>+1 to remove them from framework which is where the real problem lies.
>
+1 for framework. But having the authors has been valuable over time
for knowing who to
talk to within the team.
>For the rest I would prefer to leave as-is until we migrate all the stuff out.
>At that point it may be a good idea to re-address the issue with remaining
>code.
>
>On Sat, 23 Nov 2002 09:18, Leo Simons wrote:
>
>
>>Hi all,
>>
>>I saw a suggestion come by in that it might be a good idea to remove
>>author tags from source files as it will help eliminate any community
>>issues that arise from ego conflicts and/or 'personal playground'
>>problems. Removing the tags sounds like a very pragmatic way of helping
>>to remove any perception of code ownership.
>>
>>The only disadvantage I could see arising from this is that it might
>>become more difficult to figure out who you need to talk to about a
>>piece of code you're looking at. I think the solution to that is simple:
>>indicate the software was authored by the avalon people, and reference
>>avalon-dev. Whoever wrote that code should be around on avalon-dev :D
>>
>>As to credit where credit is due....we have a list of contributors for
>>that, and one can always look at the cvs commits.
>>
>>Hence I propose we do a global replace of
>>
>>@author Some Person
>>(...)
>>@author Other Person
>>
>>to
>>
>>@author <a href="mailto:avalon-dev@jakarta.apache.org">Apache Avalon
>>Development Team</a>
>>
>>Here's a +1 from me.
>>
>>cheers,
>>
>>- Leo Simons
>>
>>I'm learning regexp at the moment but I've so far not succeeded at
>>writing the perl snippet that should accomplish the above so it'd be
>>cool if some perl guru out there were to help a little? (if not my +1
>>indicates I will spend an afternoon or two figuring out how to do this I
>>guess :D)
>>
>>
>
>
>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Peter Donald <pe...@apache.org>.
+1 to remove them from framework which is where the real problem lies.
For the rest I would prefer to leave as-is until we migrate all the stuff out.
At that point it may be a good idea to re-address the issue with remaining
code.
On Sat, 23 Nov 2002 09:18, Leo Simons wrote:
> Hi all,
>
> I saw a suggestion come by in that it might be a good idea to remove
> author tags from source files as it will help eliminate any community
> issues that arise from ego conflicts and/or 'personal playground'
> problems. Removing the tags sounds like a very pragmatic way of helping
> to remove any perception of code ownership.
>
> The only disadvantage I could see arising from this is that it might
> become more difficult to figure out who you need to talk to about a
> piece of code you're looking at. I think the solution to that is simple:
> indicate the software was authored by the avalon people, and reference
> avalon-dev. Whoever wrote that code should be around on avalon-dev :D
>
> As to credit where credit is due....we have a list of contributors for
> that, and one can always look at the cvs commits.
>
> Hence I propose we do a global replace of
>
> @author Some Person
> (...)
> @author Other Person
>
> to
>
> @author <a href="mailto:avalon-dev@jakarta.apache.org">Apache Avalon
> Development Team</a>
>
> Here's a +1 from me.
>
> cheers,
>
> - Leo Simons
>
> I'm learning regexp at the moment but I've so far not succeeded at
> writing the perl snippet that should accomplish the above so it'd be
> cool if some perl guru out there were to help a little? (if not my +1
> indicates I will spend an afternoon or two figuring out how to do this I
> guess :D)
--
Cheers,
Peter Donald
-------------------------------------------------------
To fight and conquer in all your battles is not supreme
excellence; supreme excellence consists in breaking the
enemy's resistance without fighting. - Sun Tzu, 300 B.C.
-------------------------------------------------------
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Joerg Buchberger <po...@joerg-buchberger.de>.
Oops - sorry!!
Delete, delete, delete!
Due to some stupid mistake the footer of my previous
posting included the signature of Francis VIVAT, who has
nothing whatsoever to do with my posting.
Please excuse.
Joerg.
Joerg Buchberger schrieb am 25.11.2002:
>Greg Stein schrieb am 25.11.2002:
>>(...)
>>Seriously, if you find an author tag, will you mail that
>>person directly,
>>or will you just mail avalon-dev anyways?
>>
>>If some John Doe out there with a copy of the code in hand
>>sees that tag,
>>then who do you think they will mail? Just how big do you
>>want your
>>inbox? :-)
>>(...)
>
>if I comprehend some of the above lines, then that might
>very well translate to something like the following:
>
>/**
>* (... ,-)
>*
>* @author <a
>href="mailto:avalon-dev@jakarta.apache.org">avalon-dev@jaka
>r
>ta.apache.org</a>
>*
>*/
>
>
>
>FYI, I never ever contributed anything to this community.
>Yet, I couldn't help but post this one.
>Many thanks to all who are or ever were part of the avalon
>community!
>You offer great things.
>
>Yours, Joe User, i.e. Joerg.
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Joerg Buchberger <po...@joerg-buchberger.de>.
Greg Stein schrieb am 25.11.2002:
>(...)
>Seriously, if you find an author tag, will you mail that
>person directly,
>or will you just mail avalon-dev anyways?
>
>If some John Doe out there with a copy of the code in hand
>sees that tag,
>then who do you think they will mail? Just how big do you
>want your
>inbox? :-)
>(...)
if I comprehend some of the above lines, then that might
very well translate to something like the following:
/**
* (... ,-)
*
* @author <a
href="mailto:avalon-dev@jakarta.apache.org">avalon-dev@jakar
ta.apache.org</a>
*
*/
FYI, I never ever contributed anything to this community.
Yet, I couldn't help but post this one.
Many thanks to all who are or ever were part of the avalon
community!
You offer great things.
Yours, Joe User, i.e. Joerg.
\)|(/
. (o o)
. /-----------------ooO----(_)----Ooo-----------------\
.(_| Francis VIVAT |
. | CETP-CNRS |
. | 10-12, avenue de l'Europe 78140 Velizy |
. | Tel : +33 1 3925 4780 |
. | Fax : +33 1 3925 4922 |_
. | E-Mail : francis.vivat@cetp.ipsl.fr | )
. \---------------------------------------------------/
. (_) (_)
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Nicola Ken Barozzi <ni...@apache.org>.
Greg Stein wrote:
> In article <3D...@apache.org>, "Nicola Ken Barozzi"
> <ni...@apache.org> wrote:
>
>>...
>>I would like to add, that maybe we should allow for author tags for
>>stuff submitted by external developers. I don't yet know if it's a good
>>idea, please let me know what you think.
>
>
> Actually, that is probably worse than just leaving all the tags in. The
> code is built and managed by the Avalon PMC. The PMC has to be fully and
> entirely responsible. Inserting people's names (*especially* those of
> external developers) into the code is detrimental to that goal.
Point accepted. Since I really didn't have a strong opinion on this one,
I hope you don't mind if I grab yours ;-)
--
Nicola Ken Barozzi nicolaken@apache.org
- verba volant, scripta manent -
(discussions get forgotten, just code remains)
---------------------------------------------------------------------
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Greg Stein <gs...@lyra.org>.
In article <3D...@apache.org>, "Nicola Ken Barozzi"
<ni...@apache.org> wrote:
>...
> I would like to add, that maybe we should allow for author tags for
> stuff submitted by external developers. I don't yet know if it's a good
> idea, please let me know what you think.
Actually, that is probably worse than just leaving all the tags in. The
code is built and managed by the Avalon PMC. The PMC has to be fully and
entirely responsible. Inserting people's names (*especially* those of
external developers) into the code is detrimental to that goal.
In HTTPD and APR, we list contributors in a CHANGES file (for example, see
http://cvs.apache.org/viewcvs.cgi/httpd-2.0/CHANGES?rev=HEAD). Those
people also get their name in the commit message, by listed their
name/email in the "Submitted by:" field.
In Subversion, we acknowledge external contributors only in the commit
messages. Our CHANGES file is a summary rather than as detailed as that of
HTTPD/APR.
IMO, @author tags have little real purpose. In httpd, we've explicitly
disallowed names in the code (well, maybe not *written* but it is
certainly explicit in the culture; a commit with an author-tag like thing
will quickly be reviewed with a reply of "not acceptable"). But despite
the lack of author tags, each of the committers *knows* who knows the
various areas the best. I don't need a tag to know who to ask. I simply
know them because I'm familiar with what they've done. If I'm not familiar
with who originally wrote some piece or is currently most intimate with
it, and I need to know, then I've already answered my own question: I'm
not familiar enough with the code and should discuss it on the list before
whacking on it.
Seriously, if you find an author tag, will you mail that person directly,
or will you just mail avalon-dev anyways?
If some John Doe out there with a copy of the code in hand sees that tag,
then who do you think they will mail? Just how big do you want your
inbox? :-)
Then there is that whole thing about subverting the notion that the PMC
wrote the code rather than individuals. I think this is the weakest
argument of the lot, but it is one that the ASF itself would want to make.
And note: when I say "the PMC writes/manages the code", that is because
they *really* should/do, and that is why it is important to have it
comprised of the active committers.
Cheers,
-g
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: [proposal] drop @author tags from source files
Posted by Nicola Ken Barozzi <ni...@apache.org>.
- copying incubator general, because this basically ends a discussion I
had about author tags with a real-life example -
Leo Simons wrote:
> Hi all,
>
> I saw a suggestion come by in that it might be a good idea to remove
> author tags from source files as it will help eliminate any community
> issues that arise from ego conflicts and/or 'personal playground'
> problems. Removing the tags sounds like a very pragmatic way of helping
> to remove any perception of code ownership.
There has been a thread over this thing on incubaror general some weeks
ago, and I was trying to say that it's important that we give credit.
It was replied that hey, you have credit in the project pages, in the
commit messages, no need for author tags...
Now, I have started to understand that having author tags has a downside
in projects that have problems. And that giving credit is most important
for people that are *outside* of the project, not inside.
> The only disadvantage I could see arising from this is that it might
> become more difficult to figure out who you need to talk to about a
> piece of code you're looking at. I think the solution to that is simple:
> indicate the software was authored by the avalon people, and reference
> avalon-dev. Whoever wrote that code should be around on avalon-dev :D
CVS commits have all the info needed.
> As to credit where credit is due....we have a list of contributors for
> that, and one can always look at the cvs commits.
Exactly :-)
> Hence I propose we do a global replace of
>
> @author Some Person
> (...)
> @author Other Person
>
> to
>
> @author <a href="mailto:avalon-dev@jakarta.apache.org">Apache Avalon
> Development Team</a>
>
> Here's a +1 from me.
+1
I would like to add, that maybe we should allow for author tags for
stuff submitted by external developers. I don't yet know if it's a good
idea, please let me know what you think.
Thanks.
> cheers,
>
> - Leo Simons
>
> I'm learning regexp at the moment but I've so far not succeeded at
> writing the perl snippet that should accomplish the above so it'd be
> cool if some perl guru out there were to help a little? (if not my +1
> indicates I will spend an afternoon or two figuring out how to do this I
> guess :D)
>
>
> --
> To unsubscribe, e-mail: <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>
>
>
>
--
Nicola Ken Barozzi nicolaken@apache.org
- verba volant, scripta manent -
(discussions get forgotten, just code remains)
---------------------------------------------------------------------
Re: [proposal] drop @author tags from source files
Posted by Nicola Ken Barozzi <ni...@apache.org>.
- copying incubator general, because this basically ends a discussion I
had about author tags with a real-life example -
Leo Simons wrote:
> Hi all,
>
> I saw a suggestion come by in that it might be a good idea to remove
> author tags from source files as it will help eliminate any community
> issues that arise from ego conflicts and/or 'personal playground'
> problems. Removing the tags sounds like a very pragmatic way of helping
> to remove any perception of code ownership.
There has been a thread over this thing on incubaror general some weeks
ago, and I was trying to say that it's important that we give credit.
It was replied that hey, you have credit in the project pages, in the
commit messages, no need for author tags...
Now, I have started to understand that having author tags has a downside
in projects that have problems. And that giving credit is most important
for people that are *outside* of the project, not inside.
> The only disadvantage I could see arising from this is that it might
> become more difficult to figure out who you need to talk to about a
> piece of code you're looking at. I think the solution to that is simple:
> indicate the software was authored by the avalon people, and reference
> avalon-dev. Whoever wrote that code should be around on avalon-dev :D
CVS commits have all the info needed.
> As to credit where credit is due....we have a list of contributors for
> that, and one can always look at the cvs commits.
Exactly :-)
> Hence I propose we do a global replace of
>
> @author Some Person
> (...)
> @author Other Person
>
> to
>
> @author <a href="mailto:avalon-dev@jakarta.apache.org">Apache Avalon
> Development Team</a>
>
> Here's a +1 from me.
+1
I would like to add, that maybe we should allow for author tags for
stuff submitted by external developers. I don't yet know if it's a good
idea, please let me know what you think.
Thanks.
> cheers,
>
> - Leo Simons
>
> I'm learning regexp at the moment but I've so far not succeeded at
> writing the perl snippet that should accomplish the above so it'd be
> cool if some perl guru out there were to help a little? (if not my +1
> indicates I will spend an afternoon or two figuring out how to do this I
> guess :D)
>
>
> --
> To unsubscribe, e-mail: <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>
>
>
>
--
Nicola Ken Barozzi nicolaken@apache.org
- verba volant, scripta manent -
(discussions get forgotten, just code remains)
---------------------------------------------------------------------
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>