https://projects.ecoinformatics.org/ecoinfo/https://projects.ecoinformatics.org/ecoinfo/ecoinfo/favicon.ico?14691340362011-11-29T20:44:56ZEcoinformatics RedmineKepler - Bug #5557: Replace hardcoded path separator with File.pathSeparatorhttps://projects.ecoinformatics.org/ecoinfo/issues/5557?journal_id=192722011-11-29T20:44:56Zdhogan dhogand.hogan@ge.com
<ul></ul><p>Added a few more fixes. The importance should be bumped to normal because it's no longer just a cosmetic fix. When I run 'ant javadoc' on Windows, it fails immediately due to the path separator problem.</p>
<p>The attached patch fixes it with a few other changes: point to Oracle/JRE 1.6.x and fix a few typos. I'm getting 522 warnings and 3 errors when running javadoc against r29009/trunk on Windows. Could someone test on the platform that normally generates the javadoc to see if that's the same?</p> Kepler - Bug #5557: Replace hardcoded path separator with File.pathSeparatorhttps://projects.ecoinformatics.org/ecoinfo/issues/5557?journal_id=192732012-01-05T21:16:07ZDerik Barseghianbarseghian@nceas.ucsb.edu
<ul></ul><p>Thanks for your contribution. Committed to trunk at r29119.<br />ant javadoc still needs testing on Windows, see comment#1, leaving open.</p> Kepler - Bug #5557: Replace hardcoded path separator with File.pathSeparatorhttps://projects.ecoinformatics.org/ecoinfo/issues/5557?journal_id=192742012-01-06T01:24:16ZDerik Barseghianbarseghian@nceas.ucsb.edu
<ul></ul><p>On linux w/ java 1.6 I get 8 errors, 626 warnings, and the process ends with an IOException:</p>
<p>[create-javadoc] 8 errors<br />[create-javadoc] 626 warnings<br />[create-javadoc] IOException: java.io.IOException: Subprocess "javadoc -d /home/barseghian/dev2/kepler.modules/javadoc -sourcepath /home/barseghian/dev2/kepler.modules/sensor-view/src:/home/barseghian/dev2/kepler.modules/runtimemonitor/src:/home/barseghian/dev2/kepler.modules/reporting/src:/home/barseghian/dev2/kepler.modules/workflow-run-manager/src:/home/barseghian/dev2/kepler.modules/provenance/src:/home/barseghian/dev2/kepler.modules/tagging/src:/home/barseghian/dev2/kepler.modules/workflow-scheduler-gui/src:/home/barseghian/dev2/kepler.modules/outreach/src:/home/barseghian/dev2/kepler.modules/r/src:/home/barseghian/dev2/kepler.modules/loader/src:/home/barseghian/dev2/kepler.modules/actors/src:/home/barseghian/dev2/kepler.modules/opendap/src:/home/barseghian/dev2/kepler.modules/dataturbine/src:/home/barseghian/dev2/kepler.modules/ecogrid/src:/home/barseghian/dev2/kepler.modules/authentication-gui/src:/home/barseghian/dev2/kepler.modules/gui/src:/home/barseghian/dev2/kepler.modules/module-manager-gui/src:/home/barseghian/dev2/kepler.modules/authentication/src:/home/barseghian/dev2/kepler.modules/repository/src:/home/barseghian/dev2/kepler.modules/job/src:/home/barseghian/dev2/kepler.modules/io/src:/home/barseghian/dev2/kepler.modules/ssh/src:/home/barseghian/dev2/kepler.modules/data-handling/src:/home/barseghian/dev2/kepler.modules/sms/src:/home/barseghian/dev2/kepler.modules/component-library/src:/home/barseghian/dev2/kepler.modules/util/src:/home/barseghian/dev2/kepler.modules/event-state/src:/home/barseghian/dev2/kepler.modules/core/src:/home/barseghian/dev2/kepler.modules/common/src:/home/barseghian/dev2/kepler.modules/module-manager/src:/home/barseghian/dev2/kepler.modules/configuration-manager/src:/home/barseghian/dev2/kepler.modules/ptolemy/src:/home/barseghian/dev2/kepler.modules/build-area/src -classpath ptolemy/lib/guava.jar:/home/barseghian/dev2/kepler.modules/util/lib/jar/commons-logging-1.1.jar:/home/barseghian/dev2/kepler.modules/build-area/lib/ant.jar -tagletpath /home/barseghian/dev2/kepler.modules/build-area/target/kepler-tasks.jar -exclude ptdb:ptolemy.actor.lib.excel:ptolemy.actor.lib.io.comm:ptolemy.actor.lib.jai:ptolemy.actor.lib.jmf:ptolemy.actor.lib.joystick:ptolemy.actor.lib.jxta:ptolemy.actor.lib.logic.fuzzy:ptolemy.actor.lib.mail:ptolemy.actor.lib.opencv:ptolemy.actor.lib.reactable:ptolemy.actor.lib.x10:ptolemy.actor.ptalon:ptolemy.apps:ptolemy.backtrack:ptolemy.backtrack.eclipse:ptolemy.backtrack.test:ptolemy.cg:ptolemy.codegen:ptolemy.copernicus:ptolemy.distributed:ptolemy.domains.giotto:ptolemy.domains.gr:ptolemy.domains.gro:ptolemy.domains.jogl:ptolemy.domains.ptides:ptolemy.domains.ptinyos:ptolemy.domains.wireless:ptolemy.homer:ptolemy.moml.jxta:ptolemy.plot.servlet:ptolemy.vergil.basic.export.itextpdf:ptserver -subpackages org:com:util:ptolemy -link <a class="external" href="http://docs.oracle.com/javase/6/docs/api/">http://docs.oracle.com/javase/6/docs/api/</a> -linksource -author -breakiterator -use -quiet -tag Pt.AcceptedRating -tag Pt.ProposedRating -tag category.name -tag UserLevelDocumentation -tag created -tag entity.description -tag status -taglet org.kepler.build.RatingTaglet -J-Xmx768m" returned 1</p>
<hr />
<p>On Windows XP w/ java 1.7, after 146 minutes I finish with 556676 errors, and the IOException error. Something's clearly very wrong here -- most of these errors seem to be to do w/ illegal characters. I disabled my system bell just to get through this, most/all of these errors cause a beep.</p> Kepler - Bug #5557: Replace hardcoded path separator with File.pathSeparatorhttps://projects.ecoinformatics.org/ecoinfo/issues/5557?journal_id=192752012-01-09T08:01:30ZChristopher Brookscxh@eecs.berkeley.edu
<ul></ul><p>I took a look at the javadoc problem under Linux and there were a number of problems.</p>
<p>- The -taglet parameter named org.kepler.build.RatingTaglet, but that class does not exist. I set -taglet to doc.doclets.RatingTaglet. I'm not about this.</p>
<p>- I was seeing errors like<br />java.lang.ClassCastException: com.sun.tools.javadoc.ClassDocImpl cannot be cast to com.sun.javadoc.AnnotationTypeDoc</p>
<p>The net said that this would occur if a class had annotations but the jar file<br />that contained the annotations was not included in the classpath to javadoc.<br />So, I added ptolemy/src/lib/junit-4.8.2.jar and ptolemy/src/lib/JUnitParams-0.3.0.jar to CreateJavadoc. I don't understand why I need to add these jar<br />files individually. When javadoc is run, the classpath should include<br />all the jar files for all the modules.</p>
<p>I'm still getting 2 errors and a message about the subprocess returning 1<br />under Linux.</p>
<p>Under Windows, I was getting lots of warnings and beeps as well. I believe the<br />problem is that the jar files are getting processed as source? Probably the<br />fix is to exclude the .jar files somehow.</p>
<p>I've found that javadoc does not work very well with large argument strings.<br />Ant has a way to use files instead of large argument strings. <br />I recently updated the javadoc command in ptII/build.xml. That file is created<br />by running (cd $PTII;./configure).</p> Kepler - Bug #5557: Replace hardcoded path separator with File.pathSeparatorhttps://projects.ecoinformatics.org/ecoinfo/issues/5557?journal_id=192762012-01-09T23:02:55Zdhogan dhogand.hogan@ge.com
<ul></ul><p>This is a bit of a hack since it requires you to compile doc.doclets.RatingTaglet first. It does generate all of the javadoc though.</p>
<p>There were two main problems with the javadoc:</p>
<ul>
<li>Missing jars which caused packages warnings<br /> - Fixed by using the compile classpath for every module involved</li>
<li>Taglet class not found and the wrong name<br /> - Build doc.doclets.RatingTaglet in ptolemy now<br /> - Point to Ptolemy's classes directory rather than kepler-tasks.jar</li>
</ul>
<p>This patch isn't ideal because it's pointing to ptolemy classes that have to be built first. It's down to 0 errors and 397 warnings (all related to invalid javadoc tag usage or Oracle proprietary APIs).</p>
<p>I generated the javadocs by running "ant force-ptolemy compile ; ant javadoc".</p> Kepler - Bug #5557: Replace hardcoded path separator with File.pathSeparatorhttps://projects.ecoinformatics.org/ecoinfo/issues/5557?journal_id=192772012-01-10T01:50:30ZChristopher Brookscxh@eecs.berkeley.edu
<ul></ul><p>I folded in d. hogan's path (Thanks!)<br />One change that I made was that we now look for tools.jar by getting the java.home JDK property.</p>
<p>Unfortunately, I still can't run 'ant javadoc' under Windows, I get messages like:<br />--start--<br />Loading source files for package org.ecoinformatics.seek.R...</p>
<p>C:\Users\Administrator\src\kepler\r\target\classes\org\ecoinformatics\seek\R\RExpression2.class:62: error: unmappable character for encoding Cp1252<br />--end--</p>
<p>The above message can be reproduced by creating a file called "doit" that contains:</p>
<p>--start--<br />CLASSPATH="C:/Users/Administrator/src/kepler/r/target/classes" javadoc <del>sourcepath "C:/Users/Administrators/src/kepler/r/src/" -subpackages org<br />--end-</del></p>
<p>and then starting up Cygwin and running<br /> sh doit</p>
<p>This is with Windows Java 1.7.0:<br />$ java -version<br />java version "1.7.0" <br />Java(TM) SE Runtime Environment (build 1.7.0-b147)<br />Java HotSpot(TM) 64-Bit Server VM (build 21.0-b17, mixed mode)</p>
<p>If I use the javadoc from Java 1.6.0_26, the problem goes away.</p>
<p>I submitted a bug to Oracle, we will see if anything comes of it.</p> Kepler - Bug #5557: Replace hardcoded path separator with File.pathSeparatorhttps://projects.ecoinformatics.org/ecoinfo/issues/5557?journal_id=192782013-03-27T21:30:53ZRedmine Admin
<ul></ul><p>Original Bugzilla ID was 5557</p>