You are viewing a plain text version of this content. The canonical link for it is here.
Posted to doxia-dev@maven.apache.org by Vincent Siveton <vi...@gmail.com> on 2007/08/03 14:29:34 UTC
Doxia core clean up
Hi,
Several utility classes in Doxia are few used or unused.
org.apache.maven.doxia.util.StringUtil (used only in
XmlWriterXdocSink, which is not maintained)
org.apache.maven.doxia.util.FileUtil (used only in DocBookSink)
org.apache.maven.doxia.util.WrappedException (unused)
I propose to remove them and to use Plexus-utils instead of. It would
be a part of DOXIA-56.
Also, I propose to rename the following package
org.apache.maven.doxia.site.module.manager
to
org.apache.maven.doxia.module.manager
WDYT?
Vincent
Re: Doxia core clean up
Posted by Dennis Lundberg <de...@apache.org>.
Vincent Siveton wrote:
> Hi,
>
> 2007/8/3, Dennis Lundberg <de...@apache.org>:
>> Vincent Siveton wrote:
>>> Hi,
>>>
>>> Several utility classes in Doxia are few used or unused.
>>> org.apache.maven.doxia.util.StringUtil (used only in
>>> XmlWriterXdocSink, which is not maintained)
>>> org.apache.maven.doxia.util.FileUtil (used only in DocBookSink)
>>> org.apache.maven.doxia.util.WrappedException (unused)
>>>
>>> I propose to remove them and to use Plexus-utils instead of. It would
>>> be a part of DOXIA-56.
>> Sounds good to me.
>>
>>> Also, I propose to rename the following package
>>> org.apache.maven.doxia.site.module.manager
>>> to
>>> org.apache.maven.doxia.module.manager
>> What would be the benefit of that move? The JavaDoc says that it is a
>> hook for doxia site tools, so the package "site" makes sense to me.
>> Perhaps change it to org.apache.maven.doxia.sitetools.module.manager
>> instead?
>
> Typo, I would say o.a.m.doxia.module.SITE.manager. As you said, site
> makes sense.
>
> By convention, all modules use o.a.m.d.module.XXX as package name, and
> several of them implements SiteModule. IMHO the site package should be
> in the module package because it is module specific.
>
> Thoughts?
Yes, that is good.
>
> Vincent
>
>
>>> WDYT?
>>>
>>> Vincent
>>
>> --
>> Dennis Lundberg
>>
--
Dennis Lundberg
Re: Doxia core clean up
Posted by Vincent Siveton <vi...@gmail.com>.
Hi,
2007/8/3, Dennis Lundberg <de...@apache.org>:
> Vincent Siveton wrote:
> > Hi,
> >
> > Several utility classes in Doxia are few used or unused.
> > org.apache.maven.doxia.util.StringUtil (used only in
> > XmlWriterXdocSink, which is not maintained)
> > org.apache.maven.doxia.util.FileUtil (used only in DocBookSink)
> > org.apache.maven.doxia.util.WrappedException (unused)
> >
> > I propose to remove them and to use Plexus-utils instead of. It would
> > be a part of DOXIA-56.
>
> Sounds good to me.
>
> > Also, I propose to rename the following package
> > org.apache.maven.doxia.site.module.manager
> > to
> > org.apache.maven.doxia.module.manager
>
> What would be the benefit of that move? The JavaDoc says that it is a
> hook for doxia site tools, so the package "site" makes sense to me.
> Perhaps change it to org.apache.maven.doxia.sitetools.module.manager
> instead?
Typo, I would say o.a.m.doxia.module.SITE.manager. As you said, site
makes sense.
By convention, all modules use o.a.m.d.module.XXX as package name, and
several of them implements SiteModule. IMHO the site package should be
in the module package because it is module specific.
Thoughts?
Vincent
> > WDYT?
> >
> > Vincent
>
>
> --
> Dennis Lundberg
>
Re: Doxia core clean up
Posted by Dennis Lundberg <de...@apache.org>.
Vincent Siveton wrote:
> Hi,
>
> Several utility classes in Doxia are few used or unused.
> org.apache.maven.doxia.util.StringUtil (used only in
> XmlWriterXdocSink, which is not maintained)
> org.apache.maven.doxia.util.FileUtil (used only in DocBookSink)
> org.apache.maven.doxia.util.WrappedException (unused)
>
> I propose to remove them and to use Plexus-utils instead of. It would
> be a part of DOXIA-56.
Sounds good to me.
> Also, I propose to rename the following package
> org.apache.maven.doxia.site.module.manager
> to
> org.apache.maven.doxia.module.manager
What would be the benefit of that move? The JavaDoc says that it is a
hook for doxia site tools, so the package "site" makes sense to me.
Perhaps change it to org.apache.maven.doxia.sitetools.module.manager
instead?
> WDYT?
>
> Vincent
--
Dennis Lundberg
Re: Doxia core clean up
Posted by Vincent Siveton <vi...@gmail.com>.
Jason,
Any comments?
Cheers,
Vincent
2007/8/3, Vincent Siveton <vi...@gmail.com>:
> Hi,
>
> 2007/8/3, Jason van Zyl <ja...@maven.org>:
> > +1
> >
> > What about the other changes you were going to make? Are we going to
> > leave the names as "Parser" and not "Markup".
>
> If I understand you as well, you recommend to put all constants
> defined in Markup interfaces in AbstractParser, AbstractTextParser and
> AbstractXmlParser and other XXXParser.
>
> My only point is that XXXSink should uses XXXParser.CONSTANTS inside. Thoughts?
>
> Cheers,
>
> Vincent
>
> > And did you get anywhere using the single Plexus JAR?
> >
> > On 3 Aug 07, at 8:29 AM 3 Aug 07, Vincent Siveton wrote:
> >
> > > Hi,
> > >
> > > Several utility classes in Doxia are few used or unused.
> > > org.apache.maven.doxia.util.StringUtil (used only in
> > > XmlWriterXdocSink, which is not maintained)
> > > org.apache.maven.doxia.util.FileUtil (used only in DocBookSink)
> > > org.apache.maven.doxia.util.WrappedException (unused)
> > >
> > > I propose to remove them and to use Plexus-utils instead of. It would
> > > be a part of DOXIA-56.
> > >
> > > Also, I propose to rename the following package
> > > org.apache.maven.doxia.site.module.manager
> > > to
> > > org.apache.maven.doxia.module.manager
> > >
> > > WDYT?
> > >
> > > Vincent
> >
> > Thanks,
> >
> > Jason
> >
> > ----------------------------------------------------------
> > Jason van Zyl
> > Founder and PMC Chair, Apache Maven
> > jason at sonatype dot com
> > ----------------------------------------------------------
> >
> >
> >
> >
>
Re: Doxia core clean up
Posted by Vincent Siveton <vi...@gmail.com>.
Hi,
2007/8/3, Jason van Zyl <ja...@maven.org>:
> +1
>
> What about the other changes you were going to make? Are we going to
> leave the names as "Parser" and not "Markup".
If I understand you as well, you recommend to put all constants
defined in Markup interfaces in AbstractParser, AbstractTextParser and
AbstractXmlParser and other XXXParser.
My only point is that XXXSink should uses XXXParser.CONSTANTS inside. Thoughts?
Cheers,
Vincent
> And did you get anywhere using the single Plexus JAR?
>
> On 3 Aug 07, at 8:29 AM 3 Aug 07, Vincent Siveton wrote:
>
> > Hi,
> >
> > Several utility classes in Doxia are few used or unused.
> > org.apache.maven.doxia.util.StringUtil (used only in
> > XmlWriterXdocSink, which is not maintained)
> > org.apache.maven.doxia.util.FileUtil (used only in DocBookSink)
> > org.apache.maven.doxia.util.WrappedException (unused)
> >
> > I propose to remove them and to use Plexus-utils instead of. It would
> > be a part of DOXIA-56.
> >
> > Also, I propose to rename the following package
> > org.apache.maven.doxia.site.module.manager
> > to
> > org.apache.maven.doxia.module.manager
> >
> > WDYT?
> >
> > Vincent
>
> Thanks,
>
> Jason
>
> ----------------------------------------------------------
> Jason van Zyl
> Founder and PMC Chair, Apache Maven
> jason at sonatype dot com
> ----------------------------------------------------------
>
>
>
>
Re: Doxia core clean up
Posted by Jason van Zyl <ja...@maven.org>.
+1
What about the other changes you were going to make? Are we going to
leave the names as "Parser" and not "Markup".
And did you get anywhere using the single Plexus JAR?
On 3 Aug 07, at 8:29 AM 3 Aug 07, Vincent Siveton wrote:
> Hi,
>
> Several utility classes in Doxia are few used or unused.
> org.apache.maven.doxia.util.StringUtil (used only in
> XmlWriterXdocSink, which is not maintained)
> org.apache.maven.doxia.util.FileUtil (used only in DocBookSink)
> org.apache.maven.doxia.util.WrappedException (unused)
>
> I propose to remove them and to use Plexus-utils instead of. It would
> be a part of DOXIA-56.
>
> Also, I propose to rename the following package
> org.apache.maven.doxia.site.module.manager
> to
> org.apache.maven.doxia.module.manager
>
> WDYT?
>
> Vincent
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder and PMC Chair, Apache Maven
jason at sonatype dot com
----------------------------------------------------------
Re: Doxia core clean up
Posted by Brett Porter <br...@apache.org>.
Maybe just move them to the main maven space?
- Brett
On 16/08/2007, at 12:00 AM, Lukas Theussl wrote:
> Is there a reason for why these pages are not visible publicly? Not
> that it matters much, just curious...
>
> -Lukas
>
>
> Jason van Zyl wrote:
>> Hi,
>> I set up a space for you:
>> http://docs.codehaus.org/display/DOXIA/Home
>> And I put a little proposal in the wiki:
>> http://docs.codehaus.org/display/DOXIA/Doxia+Utility+Code+Cleanup
>> It took a few seconds, but I think this is a way better way to
>> record proposals for posterity and to track votes. I personally
>> dislike trying to track through mailing lists to find the votes.
>> They should be recorded in one place.
>>
Re: Doxia core clean up
Posted by Lukas Theussl <lt...@apache.org>.
Is there a reason for why these pages are not visible publicly? Not that
it matters much, just curious...
-Lukas
Jason van Zyl wrote:
> Hi,
>
> I set up a space for you:
>
> http://docs.codehaus.org/display/DOXIA/Home
>
> And I put a little proposal in the wiki:
>
> http://docs.codehaus.org/display/DOXIA/Doxia+Utility+Code+Cleanup
>
> It took a few seconds, but I think this is a way better way to record
> proposals for posterity and to track votes. I personally dislike trying
> to track through mailing lists to find the votes. They should be
> recorded in one place.
>
>
Re: Doxia core clean up
Posted by Jason van Zyl <ja...@maven.org>.
Hi,
I set up a space for you:
http://docs.codehaus.org/display/DOXIA/Home
And I put a little proposal in the wiki:
http://docs.codehaus.org/display/DOXIA/Doxia+Utility+Code+Cleanup
It took a few seconds, but I think this is a way better way to record
proposals for posterity and to track votes. I personally dislike
trying to track through mailing lists to find the votes. They should
be recorded in one place.
On 3 Aug 07, at 8:29 AM 3 Aug 07, Vincent Siveton wrote:
> Hi,
>
> Several utility classes in Doxia are few used or unused.
> org.apache.maven.doxia.util.StringUtil (used only in
> XmlWriterXdocSink, which is not maintained)
> org.apache.maven.doxia.util.FileUtil (used only in DocBookSink)
> org.apache.maven.doxia.util.WrappedException (unused)
>
> I propose to remove them and to use Plexus-utils instead of. It would
> be a part of DOXIA-56.
>
> Also, I propose to rename the following package
> org.apache.maven.doxia.site.module.manager
> to
> org.apache.maven.doxia.module.manager
>
> WDYT?
>
> Vincent
Thanks,
Jason
----------------------------------------------------------
Jason van Zyl
Founder and PMC Chair, Apache Maven
jason at sonatype dot com
----------------------------------------------------------