From owner-freebsd-java@FreeBSD.ORG Mon Apr 5 08:00:22 2004 Return-Path: Delivered-To: freebsd-java@hub.freebsd.org Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 8D02016A4CF for ; Mon, 5 Apr 2004 08:00:22 -0700 (PDT) Received: from freefall.freebsd.org (freefall.freebsd.org [216.136.204.21]) by mx1.FreeBSD.org (Postfix) with ESMTP id 81A1843D5C for ; Mon, 5 Apr 2004 08:00:22 -0700 (PDT) (envelope-from gnats@FreeBSD.org) Received: from freefall.freebsd.org (gnats@localhost [127.0.0.1]) i35F0Lbv044144 for ; Mon, 5 Apr 2004 08:00:21 -0700 (PDT) (envelope-from gnats@freefall.freebsd.org) Received: (from gnats@localhost) by freefall.freebsd.org (8.12.10/8.12.10/Submit) id i35F0L0l044139; Mon, 5 Apr 2004 08:00:21 -0700 (PDT) (envelope-from gnats) Resent-Date: Mon, 5 Apr 2004 08:00:21 -0700 (PDT) Resent-Message-Id: <200404051500.i35F0L0l044139@freefall.freebsd.org> Resent-From: FreeBSD-gnats-submit@FreeBSD.org (GNATS Filer) Resent-To: freebsd-java@FreeBSD.org Resent-Reply-To: FreeBSD-gnats-submit@FreeBSD.org, Herve Quiroz Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125]) by hub.freebsd.org (Postfix) with ESMTP id 9FA3316A4CE for ; Mon, 5 Apr 2004 07:57:13 -0700 (PDT) Received: from arabica.esil.univ-mrs.fr (arabica.esil.univ-mrs.fr [139.124.41.108]) by mx1.FreeBSD.org (Postfix) with ESMTP id 1202E43D39 for ; Mon, 5 Apr 2004 07:57:13 -0700 (PDT) (envelope-from rv@arabica.esil.univ-mrs.fr) Received: from arabica.esil.univ-mrs.fr (localhost.esil.univ-mrs.fr [127.0.0.1])i35Ev3DN043276 for ; Mon, 5 Apr 2004 16:57:03 +0200 (CEST) (envelope-from rv@arabica.esil.univ-mrs.fr) Received: (from rv@localhost)i35Ev3dM043275; Mon, 5 Apr 2004 16:57:03 +0200 (CEST) (envelope-from rv) Message-Id: <200404051457.i35Ev3dM043275@arabica.esil.univ-mrs.fr> Date: Mon, 5 Apr 2004 16:57:03 +0200 (CEST) From: Herve Quiroz To: FreeBSD-gnats-submit@FreeBSD.org X-Send-Pr-Version: 3.113 Subject: java/65211: bsd.java.mk: variable documentation in header X-BeenThere: freebsd-java@freebsd.org X-Mailman-Version: 2.1.1 Precedence: list List-Id: Porting Java to FreeBSD List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 05 Apr 2004 15:00:22 -0000 >Number: 65211 >Category: java >Synopsis: bsd.java.mk: variable documentation in header >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-java >State: open >Quarter: >Keywords: >Date-Required: >Class: change-request >Submitter-Id: current-users >Arrival-Date: Mon Apr 05 08:00:20 PDT 2004 >Closed-Date: >Last-Modified: >Originator: Herve Quiroz >Release: FreeBSD 5.2.1-RELEASE i386 >Organization: >Environment: System: FreeBSD arabica.esil.univ-mrs.fr 5.2.1-RELEASE FreeBSD 5.2.1-RELEASE #0: Fri Feb 27 11:36:17 CET 2004 root@arabica.esil.univ-mrs.fr:/usr/obj/usr/src/sys/ASSIMILATED i386 >Description: I realized that each bsd.*.mk file has its variables/macros documented in its header. So here is the documentation to be put in the header of bsd.java.mk. >How-To-Repeat: >Fix: --- bsd.java.mk.original Mon Apr 5 16:29:40 2004 +++ bsd.java.mk Mon Apr 5 16:51:31 2004 @@ -18,6 +18,89 @@ Java_Include_MAINTAINER= znerd@FreeBSD.org # +# [variables that each port can define] +# +# USE_JAVA Should be defined to the remaining variables to have any +# effect +# +# JAVA_VERSION List of space-separated suitable java versions for the +# port. An optional "+" allows you to specify a range of +# versions. (allowed values: 1.1[+] 1.2[+] 1.3[+] 1.4[+]) +# +# JAVA_OS List of space-separated suitable JDK port operating systems +# for the port. (allowed values: native linux) +# +# JAVA_VENDOR List of space-separated suitable JDK port vendors for the +# port. (allowed values: freebsd bsdjava sun ibm blackdown) +# +# JAVA_BUILD When set, it means that the selected JDK port should be +# added to build dependencies for the port. +# +# JAVA_RUN This variable works exactly the same as JAVA_BUILD but +# regarding run dependencies. +# +# USE_JIKES Wether the port should or should not use jikes(1) to build. +# +# [variables set by the port] +# +# JAVA_PORT The name of the JDK port. (e.g. 'java/jdk14') +# +# JAVA_PORT_VERSION The version of the JDK port. (e.g. '1.4') +# +# JAVA_PORT_OS The operating system used by the JDK port. (e.g. 'linux') +# +# JAVA_PORT_VENDOR The vendor of the JDK port. For example: sun. +# +# JAVA_PORT_OS_DESCRIPTION Description of the operating system used by the +# JDK port. (e.g. 'Linux') +# +# JAVA_PORT_VENDOR_DESCRIPTION Description of the vendor of the JDK port. +# (e.g. 'FreeBSD Foundation') +# +# JAVA_HOME Path to the installation directory of the JDK. (e.g. +# '/usr/local/jdk1.3.1') +# +# JAVAC Path to the Java compiler to use. (e.g. +# '/usr/local/jdk1.1.8/bin/javac' or '/usr/local/bin/jikes') +# +# JAR Path to the JAR tool to use. (e.g. +# '/usr/local/jdk1.2.2/bin/jar' or '/usr/local/bin/fastjar') +# +# APPLETVIEWER Path to the appletviewer utility. (e.g. +# '/usr/local/linux-jdk1.2.2/bin/appletviewer') +# +# JAVA Path to the java executable. Use this for executing Java +# programs. (e.g. '/usr/local/jdk1.3.1/bin/java') +# +# JAVADOC Path to the javadoc utility program. +# +# JAVAH Path to the javah program. +# +# JAVAP Path to the javap program. +# +# JAVA_KEYTOOL Path to the keytool utility program. This settings is +# availble only if the JDK is Java 1.2 or higher. +# +# JAVA_N2A Path to the native2ascii tool. +# +# JAVA_POLICYTOOL Path to the policytool program. This variable is available +# only if the JDK is Java 1.2 or higher. +# +# JAVA_SERIALVER Path to the serialver utility program. +# +# RMIC Path to the RMI stub/skeleton generator, rmic. +# +# RMIREGISTRY Path to the RMI registry program, rmiregistry. +# +# RMID Path to the RMI daemon program. This settings is only +# available if the JDK is Java 1.2 or higher. +# +# JAVA_CLASSES Path to the archive that contains the JDK class files. On +# JDK 1.2 or later, this is ${JAVA_HOME}/jre/lib/rt.jar. +# Earlier JDK's use ${JAVA_HOME/lib/classes.zip. +# + +# # There are the following stages: # # Stage 1: Define constants >Release-Note: >Audit-Trail: >Unformatted: