Bug 44759 - can't run ant task dist-javadoc as described in BUILDING.txt
Summary: can't run ant task dist-javadoc as described in BUILDING.txt
Status: RESOLVED FIXED
Alias: None
Product: Tomcat 6
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 6.0.16
Hardware: Macintosh other
: P2 minor (vote)
Target Milestone: default
Assignee: Tomcat Developers Mailing List
URL:
Keywords: PatchAvailable
Depends on:
Blocks:
 
Reported: 2008-04-05 09:11 UTC by Stephen Bannasch
Modified: 2008-04-16 14:37 UTC (History)
0 users



Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Stephen Bannasch 2008-04-05 09:11:32 UTC
After a svn checkout of:

  http://svn.apache.org/repos/asf/tomcat/tc6.0.x/tags/TOMCAT_6_0_16

and a successful build I tried following the instruction in BUILDING.txt for generating the javadoc however running:

  ant -f dist.xml dist-javadoc

produced this error:

BUILD FAILED
/Users/stephen/dev/java/src/tomcat_6_0_16/dist.xml:368: No source files and no packages have been specified.

I needed to run this first to produce the documentation:

  ant -f dist.xml dist-source

You could either add a statement about this to this section of the instructions in: BUILDING.txt

(5) Building the servlet and jsp API documentation

The documentation can be easly built:

    cd ${tomcat.source}
    ant -f dist.xml dist-javadoc

Or apply this patch which adds dist-source as a dependency to the dist-javadoc ant task:

Index: dist.xml
===================================================================
--- dist.xml	(revision 645027)
+++ dist.xml	(working copy)
@@ -356,7 +356,7 @@
 
   </target>
 
-  <target name="dist-javadoc" description="Create the Tomcat javadoc" >
+  <target name="dist-javadoc" depends="dist-source" description="Create the Tomcat javadoc" >
     <javadoc packagenames="org.apache.*"
       sourcepath="${tomcat.dist}/src/java"
       destdir="${tomcat.dist}/webapps/docs/api"


fyI: regarding OS: I'm running MacOS 10.5.2 -- Mac OS X 10.5 should be added to your bugzilla list of OS types.
Comment 1 Mark Thomas 2008-04-05 13:10:46 UTC
Many thanks for the patch. It has been applied to trunk and proposed for 6.0.x.
Comment 2 Mark Thomas 2008-04-16 14:37:23 UTC
This has been fixed in svn for 6.0.x and will be in 6.0.17 onwards.