You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@cayenne.apache.org by Kevin Menard <km...@servprise.com> on 2008/02/06 23:48:03 UTC
Disabling javadoc generation
Would anyone object to the disabling of javadoc building by default? The
javadoc generation seems to dominate every other phase in my building and
accounts for 50% of the total time to build. Moreover, most of the time I'm
not even going to use that javadoc because I'm building to test something.
Obviously, I'd still push it through for any released artifacts, but it
strikes me as being unnecessarily time consuming in everyday use.
If no one objects, I'll dig into how to do this in maven, as I'm not even
sure how to control it quite yet.
Thanks,
Kevin
Re: Disabling javadoc generation
Posted by Aristedes Maniatis <ar...@ish.com.au>.
On 07/02/2008, at 9:09 PM, Andrus Adamchik wrote:
> This comes down to separation of the code modules by Java
> version ... You don't want separate javadocs for Java 1.5 and 1.6.
> Also, why is that a problem for CI - the build happens
> automatically, so it doesn't matter if it is (reasonably) slow.
Actually that javadoc script is running on people.a.o so I wanted to
keep the load down. But given what you just said, it is much easier to
leave it as is and really the time taken is not excessive at all.
Ari
-------------------------->
ish
http://www.ish.com.au
Level 1, 30 Wilson Street Newtown 2042 Australia
phone +61 2 9550 5001 fax +61 2 9550 4001
GPG fingerprint CBFB 84B4 738D 4E87 5E5C 5EFA EF6A 7D2E 3E49 102A
Re: Disabling javadoc generation
Posted by Andrus Adamchik <an...@objectstyle.org>.
On Feb 7, 2008, at 11:40 AM, Aristedes Maniatis wrote:
> I still have a script running which generates nightly javadoc for
> the web site, but it goes through the opposite hurdle: it needs to
> perform a full install in order to create a source jar which can be
> used to create the javadocs. If the javadocs were just created from
> the source itself that step might not be needed.
This comes down to separation of the code modules by Java version ...
You don't want separate javadocs for Java 1.5 and 1.6. Also, why is
that a problem for CI - the build happens automatically, so it doesn't
matter if it is (reasonably) slow.
Andrus
Re: Disabling javadoc generation
Posted by Aristedes Maniatis <ar...@ish.com.au>.
I still have a script running which generates nightly javadoc for the
web site, but it goes through the opposite hurdle: it needs to perform
a full install in order to create a source jar which can be used to
create the javadocs. If the javadocs were just created from the source
itself that step might not be needed.
Kevin, if you are tinkering with the build script maybe you could
figure how that ties together. I'm growing to hate it less, but maven
still makes my head hurt.
Also I notice we have 24 javadoc errors [1] which might be because the
javadoc maven target doesn't reference the right packages. I mean,
while you are there :-)
While I think of it, should I add a link to the nightly build [2] to
our site?
Ari
[1] http://hudson.zones.apache.org/hudson/job/Cayenne-trunk/org.apache.cayenne.docs$cayenne-doc/25/consoleText
[2] http://hudson.zones.apache.org/hudson/job/Cayenne-trunk/org.apache.cayenne$cayenne-server/lastSuccessfulBuild/artifact/org.apache.cayenne/cayenne-server/3.0-SNAPSHOT/cayenne-server-3.0-SNAPSHOT-sources.jar
On 07/02/2008, at 8:21 PM, Andrus Adamchik wrote:
> Yeah, javadocs creation is slow. Still IMO it should be included in
> "mvn install" from the root dir. But note that it is generated as a
> part of the docs module, so you don't have to include it when
> building *code*. E.g. you can build from "cayenne/framework"
> directory, and this will produce runtime jars, but skip the docs.
>
> Andrus
>
>
> On Feb 7, 2008, at 12:48 AM, Kevin Menard wrote:
>
>> Would anyone object to the disabling of javadoc building by
>> default? The
>> javadoc generation seems to dominate every other phase in my
>> building and
>> accounts for 50% of the total time to build. Moreover, most of the
>> time I'm
>> not even going to use that javadoc because I'm building to test
>> something.
>>
>> Obviously, I'd still push it through for any released artifacts,
>> but it
>> strikes me as being unnecessarily time consuming in everyday use.
>>
>> If no one objects, I'll dig into how to do this in maven, as I'm
>> not even
>> sure how to control it quite yet.
>>
>> Thanks,
>> Kevin
>>
>>
>
-------------------------->
ish
http://www.ish.com.au
Level 1, 30 Wilson Street Newtown 2042 Australia
phone +61 2 9550 5001 fax +61 2 9550 4001
GPG fingerprint CBFB 84B4 738D 4E87 5E5C 5EFA EF6A 7D2E 3E49 102A
Re: Disabling javadoc generation
Posted by Andrus Adamchik <an...@objectstyle.org>.
Yeah, javadocs creation is slow. Still IMO it should be included in
"mvn install" from the root dir. But note that it is generated as a
part of the docs module, so you don't have to include it when building
*code*. E.g. you can build from "cayenne/framework" directory, and
this will produce runtime jars, but skip the docs.
Andrus
On Feb 7, 2008, at 12:48 AM, Kevin Menard wrote:
> Would anyone object to the disabling of javadoc building by
> default? The
> javadoc generation seems to dominate every other phase in my
> building and
> accounts for 50% of the total time to build. Moreover, most of the
> time I'm
> not even going to use that javadoc because I'm building to test
> something.
>
> Obviously, I'd still push it through for any released artifacts, but
> it
> strikes me as being unnecessarily time consuming in everyday use.
>
> If no one objects, I'll dig into how to do this in maven, as I'm not
> even
> sure how to control it quite yet.
>
> Thanks,
> Kevin
>
>