I just played with this in Eclipse, Netbeans and IntelliJ. Eclipse seems to magically find the javadoc even before mounting the javadoc jar. It possibly finds the source in OSGI-OPT/src of the actual jar file and generates its own javadoc on the fly, I think...
Netbeans works fine with both the javadoc jar that contains the prefix as well as the one that has index.html in the root. IntelliJ only works with the one that has the javadoc in the root. So leaving it in the root will mean that for all 3 IDEs the javadoc will work correctly, so unless there is a strong case against this I would like to go with that. And I think showing documentation with occasional broken links is better than showing no documentation at all :) This is what I put in the staging are before here: Core: https://oss.sonatype.org/content/repositories/orgosgi-724/ Enterprise: https://oss.sonatype.org/content/repositories/orgosgi-725/ Cheers, David On 14 June 2012 16:51, David Bosschaert <[email protected]> wrote: > You're right - maven insists on javadoc. I think this is specific to the > manual upload mechanism [1] (which we have to use here) as there are lots > of other released maven artifacts that don't have javadoc. > > Not sure what to do here. I think that more things will work if you put > the javadoc at the root, even though it might cause broken links, so I'm > inclined to go that way. Most IDEs can extract the javadoc out the source > code anyway so we don't really need it - its just to keep the maven upload > process happy... > > Cheers, > > David > > [1] > https://docs.sonatype.org/display/Repository/Uploading+3rd-party+Artifacts+to+The+Central+Repository > > > On 14 June 2012 14:53, BJ Hargrave <[email protected]> wrote: > >> I don't use maven myself, so I don't have a personal dog in the hunt. >> Just trying to make sure the javadoc actually works for people. >> >> If you can just use the web links, do that. But I am pretty sure Peter >> said maven central insists on javadoc jars. >> >> -- >> >> *BJ Hargrave* >> Senior Technical Staff Member, IBM >> OSGi Fellow and CTO of the *OSGi Alliance* <http://www.osgi.org/>* >> **[email protected]* <[email protected]> >> >> office: +1 386 848 1781 >> mobile: +1 386 848 3788 >> >> >> >> >> >> >> From: David Bosschaert <[email protected]> >> To: OSGi Developer Mail List <[email protected]>, >> Date: 2012/06/14 08:56 >> Subject: Re: [osgi-dev] OSGi Core and Enterprise R5 jars for Maven >> Sent by: [email protected] >> ------------------------------ >> >> >> >> I'm not sure I agree. IDEs with Maven integration will automatically find >> the javadoc if its in the right place. I don't recall seeing how to >> configure this to go 1 level deeper but if it's possible it's fiddly to say >> the least. >> >> Another option is to not publish the javadoc in Maven Central. I don't >> think its a hard requirement and it's already available online via * >> http://www.osgi.org/javadoc/r5/core*<http://www.osgi.org/javadoc/r5/core>and >> *http://www.osgi.org/javadoc/r5/enterprise.*<http://www.osgi.org/javadoc/r5/enterprise.> >> .. >> >> David >> >> On 14 June 2012 13:39, BJ Hargrave >> <*[email protected]*<[email protected]>> >> wrote: >> I don't think that will work since the enterprise javadoc is built with >> links to ../core/. If you strip out the folders, then there will be lots of >> broken links in the enterprise javadoc unless someone manually recreates >> the core folder. Since maven doesn't care, it would be better to leave the >> base folder and have the IDEs deal with it. >> >> -- >> >> *BJ Hargrave* >> >> Senior Technical Staff Member, IBM >> OSGi Fellow and CTO of the *OSGi Alliance* <http://www.osgi.org/>* >> **[email protected]* <[email protected]> >> >> office: *+1 386 848 1781* <%2B1%20386%20848%201781> >> mobile: *+1 386 848 3788* <%2B1%20386%20848%203788> >> >> >> >> >> >> >> >> From: David Bosschaert >> <*[email protected]*<[email protected]> >> > >> To: OSGi Developer Mail List >> <*[email protected]*<[email protected]>>, >> >> Date: 2012/06/14 07:44 >> Subject: Re: [osgi-dev] OSGi Core and Enterprise R5 jars for Maven >> Sent by: >> *[email protected]*<[email protected]> >> ------------------------------ >> >> >> >> >> Thanks for spotting that. I have uploaded new artifacts with the >> javadoc in the root of the javadoc jar files. >> >> Core: >> *https://oss.sonatype.org/content/repositories/orgosgi-724/*<https://oss.sonatype.org/content/repositories/orgosgi-724/> >> Enterprise: >> *https://oss.sonatype.org/content/repositories/orgosgi-725/*<https://oss.sonatype.org/content/repositories/orgosgi-725/> >> >> Would be great if someone could double check again. If all ok I'll >> release. >> >> Cheers, >> >> David >> >> On 14 June 2012 08:35, Ancoron Luciferis >> <*[email protected]* <[email protected]>> >> wrote: >> > Maven doesn't care about this, but some IDEs will, I guess. >> > >> > >> > On 06/13/2012 08:58 PM, BJ Hargrave wrote: >> >> >> >> The javadoc jars do not have the javadoc in the root of the JAR (e.g. >> it >> >> is in core/ folder for core javadoc jar, enterprise/ folder for >> >> enterprise javadoc jar). Is this OK for maven? >> >> >> >> -- >> >> >> >> *BJ Hargrave* >> >> >> >> Senior Technical Staff Member, IBM >> >> OSGi Fellow and CTO of the _OSGi Alliance_ >> >> <*http://www.osgi.org/*<http://www.osgi.org/> >> >_ >> >> [email protected]_ <*mailto:[email protected]*<[email protected]> >> > >> >> >> >> office: *+1 386 848 1781* <%2B1%20386%20848%201781> >> >> mobile: *+1 386 848 3788* <%2B1%20386%20848%203788> >> >> >> >> >> >> >> >> >> >> >> >> >> >> >> >> From: David Bosschaert >> >> <*[email protected]*<[email protected]> >> > >> >> To: OSGi Developer Mail List >> >> <*[email protected]*<[email protected]> >> >, >> >> Date: 2012/06/13 11:34 >> >> Subject: [osgi-dev] OSGi Core and Enterprise R5 jars for Maven >> >> Sent by: *[email protected]*<[email protected]> >> >> >> >> >> ------------------------------------------------------------------------ >> >> >> >> >> >> >> >> >> >> Hi all, >> >> >> >> Now that Core and Enterprise R5 are released [1] I prepared the jars >> >> for upload into maven. >> >> >> >> Before publishing them I would appreciate if someone could have a look >> >> and check that they are ok. >> >> The staging areas are: >> >> core: >> >> *https://oss.sonatype.org/content/repositories/orgosgi-672/*<https://oss.sonatype.org/content/repositories/orgosgi-672/> >> >> enterprise: * >> https://oss.sonatype.org/content/repositories/orgosgi-673/*<https://oss.sonatype.org/content/repositories/orgosgi-673/> >> >> >> >> I think these are ok, but it would be great if someone could: >> >> * check that the ultimate jars are ok >> >> * check that the included javadoc and source is in the right format >> >> * check that the signatures are ok. >> >> >> >> Thanks! >> >> >> >> David >> >> >> >> [1] >> >> * >> http://blog.osgi.org/2012/06/core-release-5-and-enterprise-release-5.html >> *<http://blog.osgi.org/2012/06/core-release-5-and-enterprise-release-5.html> >> >> _______________________________________________ >> >> OSGi Developer Mail List >> >> *[email protected]* <[email protected]> >> >> *https://mail.osgi.org/mailman/listinfo/osgi-dev*<https://mail.osgi.org/mailman/listinfo/osgi-dev> >> >> >> >> >> >> >> >> >> >> _______________________________________________ >> >> OSGi Developer Mail List >> >> *[email protected]* <[email protected]> >> >> *https://mail.osgi.org/mailman/listinfo/osgi-dev*<https://mail.osgi.org/mailman/listinfo/osgi-dev> >> > >> > >> > _______________________________________________ >> > OSGi Developer Mail List >> > *[email protected]* <[email protected]> >> > *https://mail.osgi.org/mailman/listinfo/osgi-dev*<https://mail.osgi.org/mailman/listinfo/osgi-dev> >> _______________________________________________ >> OSGi Developer Mail List* >> **[email protected]* <[email protected]>* >> **https://mail.osgi.org/mailman/listinfo/osgi-dev*<https://mail.osgi.org/mailman/listinfo/osgi-dev> >> >> >> >> _______________________________________________ >> OSGi Developer Mail List* >> **[email protected]* <[email protected]>* >> **https://mail.osgi.org/mailman/listinfo/osgi-dev*<https://mail.osgi.org/mailman/listinfo/osgi-dev> >> _______________________________________________ >> OSGi Developer Mail List >> [email protected] >> https://mail.osgi.org/mailman/listinfo/osgi-dev >> >> >> _______________________________________________ >> OSGi Developer Mail List >> [email protected] >> https://mail.osgi.org/mailman/listinfo/osgi-dev >> > >
_______________________________________________ OSGi Developer Mail List [email protected] https://mail.osgi.org/mailman/listinfo/osgi-dev
