Javadocs and pkg-plist

Matthew Seaman m.seaman at
Sun Oct 26 07:40:13 PST 2003

Dear ports,

Greg Lewis pointed out to me a problem with a new port I had submitted
(ports/57753), and on investigation it turns out that the same thing
may affect several ports in the tree.

The affected ports will be those that install api documentation which
they generate by running javadoc(1) themselves, and that can be
installed using one of several different JDK versions, and that don't
build their pkg-plist dynamically.

It turns out that javadoc from Java 1.4.x will generate two extra
files compared to javadoc from Java 1.3.x: 'allclasses-noframe.html'
and 'constant-values.html'.  These may or may not be listed in the
pkg-plist for the port, depending on which version the maintainer
happened to be using at the time.  I haven't been able to test any
earlier Java versions for similar problems.

Hardly a world-shaking problem but worth sorting.  This, for example,
is the fix I came up with:

diff -Nur mysql-connector-java.bak/Makefile mysql-connector-java/Makefile
--- mysql-connector-java.bak/Makefile	Sun Oct 26 09:50:28 2003
+++ mysql-connector-java/Makefile	Thu Oct 23 14:40:49 2003
@@ -42,6 +42,14 @@
 JDCLASSPATH=	${WRKSRC}:${WRKSRC}/lib/jdbc2_0-stdext.jar:${WRKSRC}/lib/jta-spec1_0_1.jar:${CLASSPATH}
+.include <>
+.if ${USE_JAVA:C/[.+]//g} >= 14
+PLIST_SUB+=	JAVA14="@comment "
 	@cd ${WRKSRC} && ${ANT} ${ANT_TARGET}
 .if !defined(NOPORTDOCS)
@@ -73,4 +81,4 @@
 	@${ECHO_CMD} " [ DONE ]"
-.include <>
+.include <>
diff -Nur mysql-connector-java.bak/pkg-plist mysql-connector-java/pkg-plist
--- mysql-connector-java.bak/pkg-plist	Sun Oct 26 09:58:55 2003
+++ mysql-connector-java/pkg-plist	Thu Oct 23 14:11:50 2003
@@ -2,7 +2,7 @@
@@ -54,7 +54,7 @@
@@ -81,4 +81,3 @@
 %%PORTDOCS%%@dirrm %%DOCSDIR%%/javadoc/com
 %%PORTDOCS%%@dirrm %%DOCSDIR%%/javadoc
 %%PORTDOCS%%@dirrm %%DOCSDIR%%

By my count there are some 60 ports in the tree (as of about 10.00am
UTC today) which manifestly install javadoc derived documentation --
that is, they include 'allclasses-frame.html' in their pkg-plist
files.  Of those, 39 seem to be installing pre-generated javadocs
straight from their distfiles (they have NO_BUILD=yes or they have no
RUN/BUILD dependency on java) or they depend on a specific java

The remaining 21 are potentially affected:

1) ant-xinclude-task-0.2
    ORIGIN:     textproc/ant-xinclude-task
    MAINTAINER: znerd at
    USE_JAVA:   1.1+

2) apache-jserv-1.1.2_1
    ORIGIN:     www/apache-jserv
    MAINTAINER: greg at
    USE_JAVA:   1.1+

3) cocoon-1.8.2_3
    ORIGIN:     textproc/cocoon
    MAINTAINER: ports at
    USE_JAVA:   1.1+

4) emboss-2.4.1_2
    ORIGIN:     biology/emboss
    MAINTAINER: wjv at
    USE_JAVA:   1.3+

5) jakarta-commons-beanutils-1.6.1
    ORIGIN:     java/jakarta-commons-beanutils
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

6) jakarta-commons-cli-1.0
    ORIGIN:     java/jakarta-commons-cli
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

7) jakarta-commons-collections-2.1
    ORIGIN:     java/jakarta-commons-collections
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

8) jakarta-commons-dbcp-1.0
    ORIGIN:     java/jakarta-commons-dbcp
    MAINTAINER: toha at
    USE_JAVA:   1.2+

9) jakarta-commons-lang-1.0.1
    ORIGIN:     java/jakarta-commons-lang
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

10) jakarta-commons-logging-1.0.3
    ORIGIN:     java/jakarta-commons-logging
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

11) jakarta-commons-pool-1.0.1
    ORIGIN:     java/jakarta-commons-pool
    MAINTAINER: toha at
    USE_JAVA:   1.2+

12) java-checkstyle-3.1
    ORIGIN:     java/java-checkstyle
    MAINTAINER: dglo at
    USE_JAVA:   1.3+

13) jboss-3.2.1_1
    ORIGIN:     java/jboss3
    MAINTAINER: des at
    USE_JAVA:   1.3+

14) jdom-1.0b9
    ORIGIN:     java/jdom
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

15) jump-0.4.1_1
    ORIGIN:     java/jump
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

16) resin-2.1.11
    ORIGIN:     www/resin2
    MAINTAINER: jb.quenot at
    USE_JAVA:   1.2+

17) spread-j-3.17.0_1
    ORIGIN:     net/spread-j
    MAINTAINER: joshua at
    USE_JAVA:   1.2+

18) xalan-j-2.5.1
    ORIGIN:     java/xalan-j
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

19) xerces-j-2.2.0
    ORIGIN:     textproc/xerces-j
    MAINTAINER: kevlo at
    USE_JAVA:   1.3+

20) xincluder-1.0.d11_1
    ORIGIN:     textproc/xincluder
    MAINTAINER: znerd at
    USE_JAVA:   1.2+

21) xmlenc-0.39
    ORIGIN:     textproc/xmlenc
    MAINTAINER: znerd at
    USE_JAVA:   1.1+

The other 39 ports that install javadoc documentation that I've found are:

 1) apache-ant-1.5.4_1       devel/apache-ant         znerd at
 2) apache-soap-2.3.1        net/apache-soap          brian at
 3) axis-1.1_2               www/axis                 rui at
 4) biojava-1.01             biology/biojava          bio at
 5) bouncycastle-1.16        java/bouncycastle        rara.rasputin at
 6) cos-2002.11.05,1         java/cos                 java at
 7) crimson-1.1.3_1          textproc/crimson         girgen at
 8) dbXML-1.0b2              databases/dbXML          rws at
 9) fesi-1.1.5               lang/fesi                leo at
10) gettext-0.12.1           devel/gettext            ports at
11) gnu-regexp-1.1.4         java/gnu-regexp          ports at
12) infobus-1.2              java/infobus             java at
13) j2sdkee-1.3.1_02         java/j2sdkee13           des at
14) jaf-1.0.2_1              java/jaf                 java at
15) jakarta-bcel-5.0         java/jakarta-bcel        des at
16) jakarta-log4j-1.2.8      java/jakarta-log4j       herve.quiroz at
17) jakarta-tomcat-4.0.6     www/jakarta-tomcat4      znerd at
18) jakarta-tomcat-4.1.27    www/jakarta-tomcat41     znerd at
19) jakarta-tomcat-5.0.12_1  www/jakarta-tomcat5      liukang at
20) janosvm-0.6.0_1          java/janosvm             znerd at
21) java-beepcore-0.9.07     net/java-beepcore        ports at
22) javamail-1.3.1           java/javamail            java at
23) jboss-2.4.11             java/jboss2              ports at
24) jdbcpool-0.99            java/jdbcpool            java at
25) jedit-4.1.0              editors/jedit            ports at
26) jetty-4.2.11             www/jetty                ports at
27) jfc-1.1.1                java/jfc                 kuriyama at
28) jing-2003.06.19          textproc/jing            ports at
29) junit-3.8.1              java/junit               okazaki at
30) jython-2.1_1             lang/jython              perky at
31) opencyc-0.7.0            misc/opencyc             alexs at
32) pircbot-1.2.5            irc/pircbot              tim at
33) robocode-1.0.6           games/robocode           ports at
34) saxon-6.5.2              textproc/saxon           ports at
35) simplicity-1.2.6b        java/simplicity          ports at
36) sqlrelay-0.32_2          databases/sqlrelay       ports at
37) trove4j-1.0.2            java/trove4j             herve.quiroz at
38) xdoclet-1.2b3            java/xdoclet             sheldonh at
39) xml4j-3.1.1              textproc/xml4j           ports at

as well as several that use dynamic pkg-plists which I assume don't
suffer from the problem in question.



Dr Matthew J Seaman MA, D.Phil.                       26 The Paddocks
                                                      Savill Way
PGP:         Marlow
Tel: +44 1628 476614                                  Bucks., SL7 1TH UK
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 187 bytes
Desc: not available
Url :

More information about the freebsd-ports mailing list