You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cactus-dev@jakarta.apache.org by Christopher Lenz <cm...@gmx.de> on 2003/04/28 11:24:21 UTC

Package naming issues

Hi all,

in the perspective of a release "Real Soon Now"(tm), I'd like to voice a 
concern I have with some of the names used for packaging the Cactus 
artifacts.

First, the distros:

  jakarta-cactus-anttasks-TSTAMP.zip
  jakarta-cactus-framework-12-TSTAMP.zip
  jakarta-cactus-framework-13-TSTAMP.zip
  jakarta-cactus-integration-ant-12-TSTAMP.zip
  jakarta-cactus-integration-ant-13-TSTAMP.zip
  jakarta-cactus-integration-eclipse-runner-13-TSTAMP.zip
  jakarta-cactus-integration-eclipse-webapp-TSTAMP.zip

-> The names are horribly long:
    o Can we drop the "-integration" part?
    o Can we drop the "-framework" part?

-> The 'anttasks' should not be released/delivered, as they are only
    used internally by the Cactus build AFAIK. The name is misleading
    at best, as it is easily confused with the Ant integration.

-> It would (IMHO) be much nicer if there was a single package for the
    Eclipse plugins, but I also understand that's probably not easily
    possible.

Second, and more importantly, the jars:

   cactus-framework-VERSION.jar
   cactus-integration-ant-VERSION.jar
   etc.

-> Again, the names are too long:
    o Can we drop the "-integration" part?
    o Can we drop the "-framework" part?

-> A lot of the documentation (and also external documentation like
    books and articles) still refers to the old JAR names, i.e.
    cactus.jar and cactus-ant.jar. As I prefer the shorter variants
    anyway, I'd like to change the JAR names back. The 'framework' suffix
    makes Cactus sound more complicated as it really is.

BTW, I'm +1 to get a release out, and merging the Ant proposal branch 
afterwards.

-- 
Christopher Lenz
/=/ cmlenz at gmx.de


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


Re: Package naming issues

Posted by Christopher Lenz <cm...@gmx.de>.
Vincent Massol wrote:
> Hi Chris,
> 
>>-----Original Message-----
>>From: Christopher Lenz [mailto:cmlenz@gmx.de]
>>Sent: 28 April 2003 11:24
>>To: Cactus Developers List
>>Subject: Package naming issues
>>
>>Hi all,
>>
>>in the perspective of a release "Real Soon Now"(tm), I'd like to voice
> a
>>concern I have with some of the names used for packaging the Cactus
>>artifacts.
>>
>>First, the distros:
>>
>>  jakarta-cactus-anttasks-TSTAMP.zip
>>  jakarta-cactus-framework-12-TSTAMP.zip
>>  jakarta-cactus-framework-13-TSTAMP.zip
>>  jakarta-cactus-integration-ant-12-TSTAMP.zip
>>  jakarta-cactus-integration-ant-13-TSTAMP.zip
>>  jakarta-cactus-integration-eclipse-runner-13-TSTAMP.zip
>>  jakarta-cactus-integration-eclipse-webapp-TSTAMP.zip
>>
>>-> The names are horribly long:
>>    o Can we drop the "-integration" part?
>>    o Can we drop the "-framework" part?
> 
> Hum... I like the long name because they are more explicit. Why are long
> names bad? I mean if we had to type them I would understand...

I type them sometimes, when editing build files with vim ;-)

But it's not only about typing, it's also about readability. Short names 
are easier for humans to parse at a glance.

More importantly, when we voted on the front-naming, the option we 
agreed upon was:

   "No special name (e.g. Eclipse Plugin, StrutsTestCase Framework, etc),
    directory name in CVS: "integration",
    jakarta-cactus-plugin-eclipse-*.zip, etc"

For me, that means that the "integration" name appears as a directory 
name, and sometimes in documentation, but not in the names of the 
distributables.

>>-> The 'anttasks' should not be released/delivered, as they are only
>>    used internally by the Cactus build AFAIK. The name is misleading
>>    at best, as it is easily confused with the Ant integration.
> 
> Not completely true. The anttasks contains generic Ant task which can be
> used outside the context of Cactus. 

I understand that, but the 'anttasks' contains 3 tasks, one of which is 
available as a built-in Ant task, the two others being relatively 
simple. I don't think we need to deliver those. I really believe that 
offering a cactus-anttasks.zip and a cactus-ant.zip or 
cactus-integration-ant.zip is *very* confusing.

I'd really like to see the 'integration/ant' module as a 
migration/replacement of the former 'anttasks' module, and have that 
directory be pruned by CVS in the not so distant future.

[snip]
>>-> A lot of the documentation (and also external documentation like
>>    books and articles) still refers to the old JAR names, i.e.
>>    cactus.jar and cactus-ant.jar. As I prefer the shorter variants
>>    anyway, I'd like to change the JAR names back. The 'framework'
>>    suffix makes Cactus sound more complicated as it really is.
> 
> I don't think so. I believe that in the near future we'll have even more
> components and that we need clear naming demarcations. 
> 
> <OT> For example one of my vision for Cactus 2.0 is to separate the
> Cactus core framework from the different SPI implementations
> (HTTP/Servlet redirector, HTTP/Filter, HTTP/JSP, JMS/MDB, RMI/EJB, etc)
> and make these SPI implementations work as plugins. I would thus like to
> encourage advanced users and contributors to develop other combos (we
> need to find them a name). I'll stop here as it will lead us to far from
> the initial question... :-) </OT>

Okay, but we're not there yet. And in the spirit of XP, don't complicate 
things before they actually are complex :-)

One of the reasons I initiated this thread was that a lot of 
documentation is out that uses the names cactus.jar and cactus-ant.jar 
(among others), and we should have a very good reason to use different, 
longer names. I believe the old names were perfectly clear, personally.

>>BTW, I'm +1 to get a release out, and merging the Ant proposal branch
>>afterwards.
> 
> Actually, it's the opposite for me now... AS you've progressed very
> quickly, I'd like to incorporate your changes into the HEAD ASAP :-)

Doing that right now ;-)

-- 
Christopher Lenz
/=/ cmlenz at gmx.de


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


RE: Package naming issues

Posted by Vincent Massol <vm...@pivolis.com>.
Hi Chris,

> -----Original Message-----
> From: Christopher Lenz [mailto:cmlenz@gmx.de]
> Sent: 28 April 2003 11:24
> To: Cactus Developers List
> Subject: Package naming issues
> 
> Hi all,
> 
> in the perspective of a release "Real Soon Now"(tm), I'd like to voice
a
> concern I have with some of the names used for packaging the Cactus
> artifacts.
> 
> First, the distros:
> 
>   jakarta-cactus-anttasks-TSTAMP.zip
>   jakarta-cactus-framework-12-TSTAMP.zip
>   jakarta-cactus-framework-13-TSTAMP.zip
>   jakarta-cactus-integration-ant-12-TSTAMP.zip
>   jakarta-cactus-integration-ant-13-TSTAMP.zip
>   jakarta-cactus-integration-eclipse-runner-13-TSTAMP.zip
>   jakarta-cactus-integration-eclipse-webapp-TSTAMP.zip
> 
> -> The names are horribly long:
>     o Can we drop the "-integration" part?
>     o Can we drop the "-framework" part?

Hum... I like the long name because they are more explicit. Why are long
names bad? I mean if we had to type them I would understand...

> 
> -> The 'anttasks' should not be released/delivered, as they are only
>     used internally by the Cactus build AFAIK. The name is misleading
>     at best, as it is easily confused with the Ant integration.

Not completely true. The anttasks contains generic Ant task which can be
used outside the context of Cactus. 

> 
> -> It would (IMHO) be much nicer if there was a single package for the
>     Eclipse plugins, but I also understand that's probably not easily
>     possible.
> 
> Second, and more importantly, the jars:
> 
>    cactus-framework-VERSION.jar
>    cactus-integration-ant-VERSION.jar
>    etc.
> 
> -> Again, the names are too long:
>     o Can we drop the "-integration" part?
>     o Can we drop the "-framework" part?

Same answer as above.

> 
> -> A lot of the documentation (and also external documentation like
>     books and articles) still refers to the old JAR names, i.e.
>     cactus.jar and cactus-ant.jar. As I prefer the shorter variants
>     anyway, I'd like to change the JAR names back. The 'framework'
suffix
>     makes Cactus sound more complicated as it really is.

I don't think so. I believe that in the near future we'll have even more
components and that we need clear naming demarcations. 

<OT> For example one of my vision for Cactus 2.0 is to separate the
Cactus core framework from the different SPI implementations
(HTTP/Servlet redirector, HTTP/Filter, HTTP/JSP, JMS/MDB, RMI/EJB, etc)
and make these SPI implementations work as plugins. I would thus like to
encourage advanced users and contributors to develop other combos (we
need to find them a name). I'll stop here as it will lead us to far from
the initial question... :-) </OT>

> 
> BTW, I'm +1 to get a release out, and merging the Ant proposal branch
> afterwards.

Actually, it's the opposite for me now... AS you've progressed very
quickly, I'd like to incorporate your changes into the HEAD ASAP :-)

Thanks
-Vincent



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


Re: Package naming issues

Posted by Christopher Lenz <cm...@gmx.de>.
Julien Ruaux wrote:
> I agree with distrib and jar names being too long.
> As for the Eclipse plug-ins, I'd rather keep the 2 separated because the
> webapp plug-in is not related to Cactus and might be moved out (to
> sourceforge for example) later on.

Okay, understood.

I really have to get up to speed with the Eclipse plug-in again :-P

-chris

> -----Original Message-----
> From: Christopher Lenz [mailto:cmlenz@gmx.de] 
> Sent: Monday, April 28, 2003 11:24 AM
> To: Cactus Developers List
> Subject: Package naming issues
> 
> 
> Hi all,
> 
> in the perspective of a release "Real Soon Now"(tm), I'd like to voice a
> 
> concern I have with some of the names used for packaging the Cactus 
> artifacts.
> 
> First, the distros:
> 
>   jakarta-cactus-anttasks-TSTAMP.zip
>   jakarta-cactus-framework-12-TSTAMP.zip
>   jakarta-cactus-framework-13-TSTAMP.zip
>   jakarta-cactus-integration-ant-12-TSTAMP.zip
>   jakarta-cactus-integration-ant-13-TSTAMP.zip
>   jakarta-cactus-integration-eclipse-runner-13-TSTAMP.zip
>   jakarta-cactus-integration-eclipse-webapp-TSTAMP.zip
> 
> -> The names are horribly long:
>     o Can we drop the "-integration" part?
>     o Can we drop the "-framework" part?
> 
> -> The 'anttasks' should not be released/delivered, as they are only
>     used internally by the Cactus build AFAIK. The name is misleading
>     at best, as it is easily confused with the Ant integration.
> 
> -> It would (IMHO) be much nicer if there was a single package for the
>     Eclipse plugins, but I also understand that's probably not easily
>     possible.
> 
> Second, and more importantly, the jars:
> 
>    cactus-framework-VERSION.jar
>    cactus-integration-ant-VERSION.jar
>    etc.
> 
> -> Again, the names are too long:
>     o Can we drop the "-integration" part?
>     o Can we drop the "-framework" part?
> 
> -> A lot of the documentation (and also external documentation like
>     books and articles) still refers to the old JAR names, i.e.
>     cactus.jar and cactus-ant.jar. As I prefer the shorter variants
>     anyway, I'd like to change the JAR names back. The 'framework'
> suffix
>     makes Cactus sound more complicated as it really is.
> 
> BTW, I'm +1 to get a release out, and merging the Ant proposal branch 
> afterwards.
> 



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


RE: Package naming issues

Posted by Julien Ruaux <jr...@octo.com>.
I agree with distrib and jar names being too long.
As for the Eclipse plug-ins, I'd rather keep the 2 separated because the
webapp plug-in is not related to Cactus and might be moved out (to
sourceforge for example) later on.

Julien

-----Original Message-----
From: Christopher Lenz [mailto:cmlenz@gmx.de] 
Sent: Monday, April 28, 2003 11:24 AM
To: Cactus Developers List
Subject: Package naming issues


Hi all,

in the perspective of a release "Real Soon Now"(tm), I'd like to voice a

concern I have with some of the names used for packaging the Cactus 
artifacts.

First, the distros:

  jakarta-cactus-anttasks-TSTAMP.zip
  jakarta-cactus-framework-12-TSTAMP.zip
  jakarta-cactus-framework-13-TSTAMP.zip
  jakarta-cactus-integration-ant-12-TSTAMP.zip
  jakarta-cactus-integration-ant-13-TSTAMP.zip
  jakarta-cactus-integration-eclipse-runner-13-TSTAMP.zip
  jakarta-cactus-integration-eclipse-webapp-TSTAMP.zip

-> The names are horribly long:
    o Can we drop the "-integration" part?
    o Can we drop the "-framework" part?

-> The 'anttasks' should not be released/delivered, as they are only
    used internally by the Cactus build AFAIK. The name is misleading
    at best, as it is easily confused with the Ant integration.

-> It would (IMHO) be much nicer if there was a single package for the
    Eclipse plugins, but I also understand that's probably not easily
    possible.

Second, and more importantly, the jars:

   cactus-framework-VERSION.jar
   cactus-integration-ant-VERSION.jar
   etc.

-> Again, the names are too long:
    o Can we drop the "-integration" part?
    o Can we drop the "-framework" part?

-> A lot of the documentation (and also external documentation like
    books and articles) still refers to the old JAR names, i.e.
    cactus.jar and cactus-ant.jar. As I prefer the shorter variants
    anyway, I'd like to change the JAR names back. The 'framework'
suffix
    makes Cactus sound more complicated as it really is.

BTW, I'm +1 to get a release out, and merging the Ant proposal branch 
afterwards.

-- 
Christopher Lenz
/=/ cmlenz at gmx.de


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



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