From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from lists.gentoo.org (pigeon.gentoo.org [208.92.234.80]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by finch.gentoo.org (Postfix) with ESMTPS id 2FC8915803E for ; Sun, 31 Dec 2023 16:27:01 +0000 (UTC) Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id E3EC72BC074; Sun, 31 Dec 2023 16:26:45 +0000 (UTC) Received: from mout.kundenserver.de (mout.kundenserver.de [217.72.192.74]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange ECDHE (prime256v1) server-signature RSA-PSS (4096 bits) server-digest SHA256) (No client certificate requested) by pigeon.gentoo.org (Postfix) with ESMTPS id 3A2BB2BC023 for ; Sun, 31 Dec 2023 16:26:45 +0000 (UTC) Received: from CYRTRY1.fritz.box ([109.250.31.104]) by mrelayeu.kundenserver.de (mreue106 [212.227.15.146]) with ESMTPSA (Nemesis) id 1M4aA4-1rLcXd2pok-001gN2 for ; Sun, 31 Dec 2023 17:26:43 +0100 From: "Volkmar W. Pogatzki" To: gentoo-dev@lists.gentoo.org Subject: [gentoo-dev] [PATCH 1/3] java-utils-2.eclass: new JAVADOC_CLASSPATH, JAVADOC_SRC_DIRS Date: Sun, 31 Dec 2023 17:26:00 +0100 Message-ID: <20231231162632.10228-1-gentoo@pogatzki.net> X-Mailer: git-send-email 2.41.0 Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org X-Auto-Response-Suppress: DR, RN, NRN, OOF, AutoReply MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Provags-ID: V03:K1:+U/L5/JzPMDBYgqePKmucaZ6hAU/sH93r/BKwOar9bHkIJFNA+Y 0dxb8YCJhDLnc3AFAub8U5jj9CXh/89BrphgFXrW3gM0kIR4YDnfLRhHs0jcTzoQobFFMUk o+jzXpSBcL5YD8XKwCVgNJkkn2hMYgWviyESltBwp3fbmirYJRZhmggs5E+CAYpmSOpbtcd fK3MLzsuX87s5vfis9sjw== X-Spam-Flag: NO UI-OutboundReport: notjunk:1;M01:P0:0du1pGzlcXc=;nATZT/RX7HdphQ1lL+amHsCxqZz RRpjRjp5BNQlA9T6RtCRmdezDtMbkfbIkmZQHJvTblt3oHbtpxvp+IT1tvQbH32P2ujagJZv7 4kx/mR0kgyl4wbBx6wuQdJoFX8lxdjb+QSat5j0ewsYmTY1yYMh4YmP69SPebMkGdwzW6zN6Z 48LEO3cE6WIpLgHJcVs0Y95S/UBV3w214fGkvRh2FoHfumbh7LXxYWuSwf1M2bl8nFwI9xoEX YrhgjUjDdC5Hzu4RAOUXrAdmZOnW5eKywrjPhrSwiaO+beAScs2R0SdcxyY+CBSK3EIBlPIfT 4GXL5WP08nKO3STrTKe8r+2IMvLsUazDJOzVK/RqwlhdOhaDxNMDV5mKdFOlxs5lWlbqF2HTg /15HFORNxXveqt3lW+DgZljKbniSNYeQyMwm4LW0bhUWH7o2zNFG+C1sylH2CdDXvUb2RzCa8 KxBXSoCDYYASEGC3p/bDe+TZBs7ivoTwM7Izv8zNCwvdchAT2jjBJAHW4o0NvxSloWCuX9D/O 55+cTTiMj5ANwI1E7nJDRP4XTBCQcyF0P5MEU2JT2eDYiQqBRVkHty8Y6CozXuWGei6OnGPXK T4HynKUtOR8b9VumHcJKlaEGBJR4E+Qvb3hDdwYojAo/isin+3lCrKsolt6KndDNHBQo4XDtY Xtb+Qc3gPmF7Y66xxmGrdbcTcsVWTOL6Uu1vK+ecIZCYxb8W5pvlcmePeGDj6VEBp32snWmpQ IdjInBxWBMvnh2YG2ch0NDTYhW82y7oTE+eFDie3BgvFddMKLIjksqJpMqToU8oKJOMbeZTB3 U1/ETSbIHHP+9cCejlSa+FNV9t6culbAl3hfklpzKbdNrHGDyw9W9/xfVs8+nHJCnRpJXIuoo SzZbK0jeYa4MM3w== X-Archives-Salt: 1c17a35d-f85b-4228-8291-201b3a909665 X-Archives-Hash: a51039ed5f948fd9ccf38a9e04035411 Several multi-jar packages built with java-pkg-simple.eclass use a workaround to avoid passing arguments to ejavadoc. That workaround runs another java-pkg-simple_src_compile which builds an unneeded jar file usually called "ignoreme.jar". This patch defines the JAVADOC_SRC_DIRS eclass variable needed by the java-pkg-simple.eclass to decide whether to call ejavadoc or not. The other new eclass variable is JAVADOC_CLASSPATH. It can be used for multi-jar packages to pass dependencies's classpath to ejavadoc. Signed-off-by: Volkmar W. Pogatzki --- eclass/java-utils-2.eclass | 40 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) diff --git a/eclass/java-utils-2.eclass b/eclass/java-utils-2.eclass index 31b8ab8df60a..814b4957d52c 100644 --- a/eclass/java-utils-2.eclass +++ b/eclass/java-utils-2.eclass @@ -218,6 +218,46 @@ JAVA_PKG_COMPILERS_CONF=${JAVA_PKG_COMPILERS_CONF:="/etc/java-config-2/build/com # ebuild foo.ebuild compile # @CODE +# @ECLASS_VARIABLE: JAVADOC_CLASSPATH +# @DEFAULT_UNSET +# @DESCRIPTION: +# Comma or space separated list of java packages that are needed for generating +# javadocs. Can be used to avoid overloading the compile classpath in multi-jar +# packages if there are jar files which have different dependencies. +# +# @CODE +# Example: +# JAVADOC_CLASSPATH=" +# jna-4 +# jsch +# " +# @CODE + +# @ECLASS_VARIABLE: JAVADOC_SRC_DIRS +# @DEFAULT_UNSET +# @DESCRIPTION: +# An array of directories relative to ${S} which contain the sources of +# the application. It needs to sit in global scope; if put in src_compile() +# it would not work. +# It is needed by the java-pkg-simple.eclass to decide whether to call ejavadoc +# or not. If this variable is defined then java-pkg-simple_src_compile will not +# call ejavadoc automatically. ejavadoc has then to be called explicitly from +# the ebuild. It is meant for usage in multi-jar packages in order to avoid an +# extra compilation run only for producing the javadocs. +# +# @CODE +# Example: +# JAVADOC_SRC_DIRS=( +# "${PN}-core" +# "${PN}-jsch" +# "${PN}-pageant" +# "${PN}-sshagent" +# "${PN}-usocket-jna" +# "${PN}-usocket-nc" +# "${PN}-connector-factory" +# ) +# @CODE + # TODO document me JAVA_PKG_QA_VIOLATIONS=0 -- 2.41.0