javadoc problem with default-jdk

Le Wed, 05 Aug 2009 15:52:34 +0200,
Matthias Klose <doko.TakeThisOut@ubuntu.com> a écrit :

> On 05.08.2009 17:00, Picca Frédéric-Emmanuel wrote:
> > hello as I am working on my remotetea package, I build it using the
> > pbuilder.
> >
> > and it seems that depending on default-jdk is not enought to produce
> > good documentation with javadoc. Indeed it do not find the
> > documentation for standard classes of java.
> >
> > what must I add as build dependency to produce the right
> > documentation ?
>
> the java docs built form OpenJDK can be found in openjdk-6-doc. But
> instead of directly depending on this package, we should create a
> default-jdk-doc package and make sure that generated references don't
> refer to the openjdk-6-doc directory.

ok for the standard documentation but what about all the javadoc api
provided by the java packages with a -doc.

if my package provide some javadoc documentation it should be
accessible to other packages during there build process.

How can we deal with this.

did I missed something.

This is just to have all javadoc api consistant for all java packages.

Frederic


--
To UNSUBSCRIBE, email to debian-java-REQUEST.TakeThisOut@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster.TakeThisOut@lists.debian.org

On Wed, Aug 05, 2009 at 06:26:44PM +0200, Picca Frédéric-Emmanuel wrote:
> Le Wed, 05 Aug 2009 15:52:34 +0200,
> Matthias Klose <doko.TakeThisOut@ubuntu.com> a écrit :
>
> > On 05.08.2009 17:00, Picca Frédéric-Emmanuel wrote:
> > > hello as I am working on my remotetea package, I build it using the
> > > pbuilder.
> > >
> > > and it seems that depending on default-jdk is not enought to produce
> > > good documentation with javadoc. Indeed it do not find the
> > > documentation for standard classes of java.
> > >
> > > what must I add as build dependency to produce the right
> > > documentation ?
> >
> > the java docs built form OpenJDK can be found in openjdk-6-doc. But
> > instead of directly depending on this package, we should create a
> > default-jdk-doc package and make sure that generated references don't
> > refer to the openjdk-6-doc directory.
>
> ok for the standard documentation but what about all the javadoc api
> provided by the java packages with a -doc.
>
> if my package provide some javadoc documentation it should be
> accessible to other packages during there build process.
>
> How can we deal with this.
>
> did I missed something.
>
> This is just to have all javadoc api consistant for all java packages.

Always put it into /usr/share/doc/<doc package>/api.


Cheers,
Michael


--
To UNSUBSCRIBE, email to debian-java-REQUEST.TakeThisOut@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster.TakeThisOut@lists.debian.org

On 05.08.2009 18:26, Picca Frédéric-Emmanuel wrote:
>

Le Wed, 05 Aug 2009 15:52:34 +0200,
> Matthias Klose<doko DeleteThis @ubuntu.com> a écrit :
>
>> On 05.08.2009 17:00, Picca Frédéric-Emmanuel wrote:
>>> hello as I am working on my remotetea package, I build it using the
>>> pbuilder.
>>>
>>> and it seems that depending on default-jdk is not enought to produce
>>> good documentation with javadoc. Indeed it do not find the
>>> documentation for standard classes of java.
>>>
>>> what must I add as build dependency to produce the right
>>> documentation ?
>>
>> the java docs built form OpenJDK can be found in openjdk-6-doc. But
>> instead of directly depending on this package, we should create a
>> default-jdk-doc package and make sure that generated references don't
>> refer to the openjdk-6-doc directory.
>
> ok for the standard documentation but what about all the javadoc api
> provided by the java packages with a -doc.
>
> if my package provide some javadoc documentation it should be
> accessible to other packages during there build process.
>
> How can we deal with this.
>
> did I missed something.
>
> This is just to have all javadoc api consistant for all java packages.

we discussed this at Debconf. You generally don't want to have a libfoo-java,
which includes the api docs, depend on any other -apidoc packages. It's clear
that the generated docs will point to some non-existing local URLs in this case.
The alternative would be to always have a separate libfoo-java-apidoc package.
For now you maybe have to build-depend on every -doc package explicitely.


--
To UNSUBSCRIBE, email to debian-java-REQUEST DeleteThis @lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster DeleteThis @lists.debian.org

On 05.08.2009 20:02, Michael Koch wrote:
> On Wed, Aug 05, 2009 at 06:26:44PM +0200, Picca Frédéric-Emmanuel wrote:
>> Le Wed, 05 Aug 2009 15:52:34 +0200,
>> Matthias Klose<doko RemoveThis @ubuntu.com> a écrit :
>>
>>> On 05.08.2009 17:00, Picca Frédéric-Emmanuel wrote:
>>>> hello as I am working on my remotetea package, I build it using the
>>>> pbuilder.
>>>>
>>>> and it seems that depending on default-jdk is not enought to produce
>>>> good documentation with javadoc. Indeed it do not find the
>>>> documentation for standard classes of java.
>>>>
>>>> what must I add as build dependency to produce the right
>>>> documentation ?
>>>
>>> the java docs built form OpenJDK can be found in openjdk-6-doc. But
>>> instead of directly depending on this package, we should create a
>>> default-jdk-doc package and make sure that generated references don't
>>> refer to the openjdk-6-doc directory.
>>
>> ok for the standard documentation but what about all the javadoc api
>> provided by the java packages with a -doc.
>>
>> if my package provide some javadoc documentation it should be
>> accessible to other packages during there build process.
>>
>> How can we deal with this.
>>
>> did I missed something.
>>
>> This is just to have all javadoc api consistant for all java packages.
>
> Always put it into /usr/share/doc/<doc package>/api.

No, this looks wrong, because you cannot enforce this for packages where the
docs are shipped in the same package. You should use /usr/share/doc/<lib
package>/api, and maybe add a directory /usr/share/doc/<doc package> with an api
symlink to /usr/share/doc/<lib package>/api, if the docs are in a separate package.


--
To UNSUBSCRIBE, email to debian-java-REQUEST RemoveThis @lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster RemoveThis @lists.debian.org

On Wed, Aug 05, 2009 at 06:05:11PM +0200, Matthias Klose wrote:
> >Always put it into /usr/share/doc/<doc package>/api.
>
> No, this looks wrong, because you cannot enforce this for packages
> where the docs are shipped in the same package. You should use
> /usr/share/doc/<lib package>/api, and maybe add a directory
> /usr/share/doc/<doc package> with an api symlink to
> /usr/share/doc/<lib package>/api, if the docs are in a separate
> package.

What I meant was "doc package" == "package that contains the docs.
Which can be anything like "checkstyle" if you want to refer to javadocs
of checkstyle.


Cheers,
Michael


--
To UNSUBSCRIBE, email to debian-java-REQUEST DeleteThis @lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster DeleteThis @lists.debian.org

Matthias, I have just uploaded a new version of maven-debian-helper. It
uses Maven to build packages, and supports now the generation of Javadoc
packages. There is also a utility, mh_make, which given a Maven project
will try to build all the Debian packaging for it. Can you give it a
try, it's in the package archive
(http://wiki.debian.org/Teams/JavaPackaging) or in my PPA
(https://launchpad.net/~ludovicc/+archive/ppa/)

You can also have a look at the plexus-active-collection package, it
builds its documentation using Maven.
At the moment, I don't handle links between packages, but that should
not be too hard, the only problem being that I need to enhance the Maven
Javadoc plugin as its configuration is horrendous for us.

Ludovic


Matthias Klose a écrit :
>
>
> No, this looks wrong, because you cannot enforce this for packages where
> the docs are shipped in the same package. You should use
> /usr/share/doc/<lib package>/api, and maybe add a directory
> /usr/share/doc/<doc package> with an api symlink to /usr/share/doc/<lib
> package>/api, if the docs are in a separate package.
>
>


--
To UNSUBSCRIBE, email to debian-java-REQUEST.RemoveThis@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster.RemoveThis@lists.debian.org

Le Wed, 05 Aug 2009 23:41:54 +0100,
Ludovic Claude <ludovic.claude.RemoveThis@laposte.net> a écrit :

>
> Matthias, I have just uploaded a new version of maven-debian-helper.
> It uses Maven to build packages, and supports now the generation of
> Javadoc packages. There is also a utility, mh_make, which given a
> Maven project will try to build all the Debian packaging for it. Can

At work we have a maven repository for all our projects java and c++
can we teach mh_make to skip non java projects ?


--
To UNSUBSCRIBE, email to debian-java-REQUEST.RemoveThis@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster.RemoveThis@lists.debian.org

Le Wed, 05 Aug 2009 18:05:11 +0200,
Matthias Klose <doko.TakeThisOut@ubuntu.com> a écrit :

> No, this looks wrong, because you cannot enforce this for packages
> where the docs are shipped in the same package. You should
> use /usr/share/doc/<lib
> package>/api, and maybe add a directory /usr/share/doc/<doc package>
> package>with an api
> symlink to /usr/share/doc/<lib package>/api, if the docs are in a
> separate package.

this way all the documentation could be found in /usr/share/doc/<lib
package>/api. The policy should enforce to split lib package in the .jar
files and -doc for the api documentation. thah way it would be easy to
compute the doc dependency from the library dependency. And to reduce
the size of the java runtime for system with low space like embeded
devices.

the java-default-doc should provide, using the alternative, the right
location for the standard api documentation.

Frederic


--
To UNSUBSCRIBE, email to debian-java-REQUEST.TakeThisOut@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster.TakeThisOut@lists.debian.org

Hi Matthew,

On Thu, Aug 6, 2009 at 9:56 AM, Matthew Johnson<mjj29 RemoveThis @debian.org> wrote:
> Does it support building packages with debhelper rather than cdbs?

Please see <http://twerner.blogspot.com/2009/08/state-of-maven-in-debian.html>.

Cheers,
Torsten


--
To UNSUBSCRIBE, email to debian-java-REQUEST RemoveThis @lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster RemoveThis @lists.debian.org

Hello Matthew,

You can see more details about Maven support in my blog post.
http://ludovicc.blogspot.com/2009/08/state-of-maven-in-debian.html

mh_make relies on a lot of Java code to extract all information from the
Maven POM descriptors and the local Maven repository for Debian, so
there's not so much code duplication. But I can see a few good things in
your jh_makepkg script which would be good for me to use. Can you
authorize me to copy some of your code? Your package is GPL2 licensed,
and mine is Apache 2.0 (to allow code exchange between me and Maven).

Ludovic

Matthew Johnson a écrit :
> On Wed Aug 05 23:41, Ludovic Claude wrote:
>> Matthias, I have just uploaded a new version of maven-debian-helper. It
>> uses Maven to build packages
>
> Does it support building packages with debhelper rather than cdbs?
>
>> packages. There is also a utility, mh_make, which given a Maven project
>> will try to build all the Debian packaging for it.
>
> I think it would probably be duplicating code less if this was
> integrated into the jh_makepkg that I've already written in javahelper
> which does this, but is not specific to maven. It has options for maven,
> the only reason I've not written all the supporting code is that I
> don't fully understand yet how maven works.
>
> Matt
>


--
To UNSUBSCRIBE, email to debian-java-REQUEST RemoveThis @lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster RemoveThis @lists.debian.org