From nobody Sun Jan 5 18:59:58 2025 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4YR67f45rSz5k6LV for ; Sun, 05 Jan 2025 18:59:58 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4YR67f3LwQz4LXH; Sun, 5 Jan 2025 18:59:58 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1736103598; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=9OnKbq/2xRXo9PvrXXxfvncVZC5fO/xGx6RMLAwhFcQ=; b=vx367o/J3jTilgLSs6YqPsAwVNTdF0FoMBAx3nRHkBcw3u4XVi9Lh9ssL2Yc2zJJfyUORO A/0PKpirpd0gjpTgyUFEuRm5OpwbZKZb1cjo4yRhmIEl/ZK9jmyvH1TcxOFPgkpq79FWBH H2WRiwrDv6P6Y1NyGDQO3ER3WUuZhPMaknZAzEm4u/CYVPEjgjxMr2m+s6oyU0xbUSyal8 FZqTt8ezJ70Z5Y+81VGSiCvkzLXu9dkul6pHoepWUClVrBKYI4L1cgxwzeIJjIesboi3t7 W7z3KwfqOQO8JqrsX1uR5ZvILdJ9JJ1yyB8ZhvOY0ELGZUj5YY1uBe6k98ygQw== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1736103598; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=9OnKbq/2xRXo9PvrXXxfvncVZC5fO/xGx6RMLAwhFcQ=; b=SEpyB58MO53JlhBuMsGATOAwGiUFVbVw2mPMVHmQr+m8Ns0seZiSj1vOW2klMD7khh9pr1 NDk3rc8hi9lvJlrtt3dh49Ik/SMwyYKcmN4+7awkvmJFIOw6cFo/3Pp4trDzk0w3tzoyBx tqSQE35J+wDGguFRW6i9+we7eVQtUo4TbyjzljcUUiIHDhTaR13PMH17Pkq8yYdfDAKaLk b0zstXl4Hovit/QP8yTI8pHJmfDKTk980gL7h0u3CbqZjBO/ViENugYUINkHUtWyYppYrd 13rU4qlWKOU8hBLRo4AVw+LMFbkISREfdcJ4PgT1NfiAdI5B7DRafGeFCmnhvQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1736103598; a=rsa-sha256; cv=none; b=ZyVWuVN4y4RZ1aJ3piiX4ULEzMYsaLHtGaYy5JK2RzOuBqBOOXe1NZOQTpzOXn9sdiHQ+g r8G+NSSJwfT9RW+DaPxsRy9tTDvvA/EsmTl89nf9bEivOCettyV04/OcR3eVvB3Ux5P8Sv K/3D8acedDz23RbC44M6qa50Ki1F9BE8G3pErajq90Aj8gHB3A10MFZcbV7n1MZsFTXsa2 6cfiFJKyht1lAUtV5oBQceuaMkA+oUcoF5vuEJzNtsQnMc2lDzc+huAZh3T9TzPv5vMS5U nLQsZq9i9x6m07//2MAG7qtYY33utGuu/WVS9DggkndaVifzpw0rns2UNcSKTQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4YR67f2j91zrJM; Sun, 05 Jan 2025 18:59:58 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 505IxwFX007708; Sun, 5 Jan 2025 18:59:58 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 505Ixwg9007702; Sun, 5 Jan 2025 18:59:58 GMT (envelope-from git) Date: Sun, 5 Jan 2025 18:59:58 GMT Message-Id: <202501051859.505Ixwg9007702@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Fernando =?utf-8?Q?Apestegu=C3=ADa?= Subject: git: 5e7b0befe1 - main - [phb]: Document Uses=java List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: fernape X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 5e7b0befe151cd97730da15e93a33bc8a30b1465 Auto-Submitted: auto-generated The branch main has been updated by fernape: URL: https://cgit.FreeBSD.org/doc/commit/?id=5e7b0befe151cd97730da15e93a33bc8a30b1465 commit 5e7b0befe151cd97730da15e93a33bc8a30b1465 Author: Fernando Apesteguía AuthorDate: 2025-01-05 18:56:56 +0000 Commit: Fernando Apesteguía CommitDate: 2025-01-05 18:59:46 +0000 [phb]: Document Uses=java --- .../en/books/porters-handbook/uses/_index.adoc | 108 +++++++++++++++++++++ 1 file changed, 108 insertions(+) diff --git a/documentation/content/en/books/porters-handbook/uses/_index.adoc b/documentation/content/en/books/porters-handbook/uses/_index.adoc index 0bec4ee1a1..97b3e0c2fd 100644 --- a/documentation/content/en/books/porters-handbook/uses/_index.adoc +++ b/documentation/content/en/books/porters-handbook/uses/_index.adoc @@ -1044,6 +1044,114 @@ If the `env` argument is given, the `configure` target is not set. If the `-a` flag is a problem for the port, add the `notall` argument. If `xmkmf` does not generate a `install.man` target, add the `noman` argument. +[[uses-java]] +== `java` + +Possible arguments: (none), `ant`, `build`, `extract`, `run` + +Defaults to `USES=java:build,run` if no arguments are provided and `NO_BUILD` +is undefined. If `NO_BUILD` is defined, `USES=java:run` is used. +If the `ant` argument is given, the port uses Apache Ant. +If the `build` argument is given, a JDK port is added to the build dependencies. +If the `extract` argument is given, a JDK port is added to the extract dependencies. +If the `run` argument is given, a JDK port is added to the run dependencies. + +The framework provides the following variables to be set by the port: + +`JAVA_VERSION`:: +List of space-separated suitable java versions for the port. An optional `\+` +allows you to specify a range of versions. (allowed values `8[+]`, `11[\+]`, +`17[+]`, `18[\+]`, `19[+]`, `20[\+]`, `21[+]`, `22[\+]`, `22[+]`) + +`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: `openjdk`, `oracle`) + +The framework exposes the following variables to be read by the port: + +`JAVA_PORT`:: +The name of the JDK port. (e.g. 'java/openjdk8') + +`JAVA_PORT_VERSION`:: +The version of the JDK port. (e.g. '8') + +`JAVA_PORT_OS`:: +The operating system used by the JDK port. (e.g. 'linux') + +`JAVA_PORT_VENDOR`:: +The vendor of the JDK port. (e.g. 'openjdk') + +`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. 'OpenJDK BSD Porting Team') + +`JAVA_HOME`:: +Path to the installation directory of the JDK. (e.g. [.filename]#/usr/local/openjdk8#) + +`JAVAC`:: +Path to the Java compiler to use. (e.g. [.filename]#/usr/local/openjdk8/bin/javac# or +[.filename]#/usr/local/bin/javac#) + +`JAR`:: +Path to the JAR tool to use. (e.g. [.filename]#/usr/local/openjdk8/bin/jar# or +[.filename]#/usr/local/bin/fastjar#) + +`APPLETVIEWER`:: +Path to the appletviewer utility. (e.g. +[.filename]#/usr/local/linux-jdk1.8.0/bin/appletviewer#) + +`JAVA`:: +Path to the `java` executable. Use this for executing Java programs. (e.g. [.filename]#/usr/local/openjdk8/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. + +`JAVA_N2A`:: +Path to the `native2ascii` tool. + +`JAVA_POLICYTOOL`:: +Path to the `policytool` program. + +`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. + +`JAVA_CLASSES`:: +Path to the archive that contains the JDK class files. On most JDKs, this is +[.filename]#${JAVA_HOME}/jre/lib/rt.jar#. + +`JAVASHAREDIR`:: +The base directory for all shared Java resources. + +`JAVAJARDIR`:: +The directory where a port should install JAR files. + +`JAVALIBDIR`:: +The directory where JAR files installed by other ports are located. + [[uses-kde]] == `kde`