From mboxrd@z Thu Jan 1 00:00:00 1970 From: Hartmut Goebel Subject: [PATCH 1/2] doc: Add specification for Java packages Date: Sat, 16 Apr 2016 10:51:22 +0200 Message-ID: <1460796683-24368-2-git-send-email-h.goebel@crazy-compilers.com> References: <1460796683-24368-1-git-send-email-h.goebel@crazy-compilers.com> Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:34006) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1arLwx-0003xp-Oo for guix-devel@gnu.org; Sat, 16 Apr 2016 04:51:32 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1arLwu-00088l-V3 for guix-devel@gnu.org; Sat, 16 Apr 2016 04:51:31 -0400 Received: from mail-out.m-online.net ([212.18.0.9]:57034) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1arLwu-00088a-Oh for guix-devel@gnu.org; Sat, 16 Apr 2016 04:51:28 -0400 Received: from frontend01.mail.m-online.net (unknown [192.168.8.182]) by mail-out.m-online.net (Postfix) with ESMTP id 3qn7S00WTKz3hjPg for ; Sat, 16 Apr 2016 10:51:28 +0200 (CEST) Received: from localhost (dynscan1.mnet-online.de [192.168.6.68]) by mail.m-online.net (Postfix) with ESMTP id 3qn7S00NlWzvdWd for ; Sat, 16 Apr 2016 10:51:28 +0200 (CEST) Received: from mail.mnet-online.de ([192.168.8.182]) by localhost (dynscan1.mail.m-online.net [192.168.6.68]) (amavisd-new, port 10024) with ESMTP id JpzAu3p4LGic for ; Sat, 16 Apr 2016 10:51:27 +0200 (CEST) Received: from hermia.goebel-consult.de (ppp-188-174-141-143.dynamic.mnet-online.de [188.174.141.143]) (using TLSv1 with cipher DHE-RSA-CAMELLIA256-SHA (256/256 bits)) (No client certificate requested) by mail.mnet-online.de (Postfix) with ESMTPS for ; Sat, 16 Apr 2016 10:51:27 +0200 (CEST) Received: from thisbe.goebel-consult.de (unknown [192.168.110.30]) by hermia.goebel-consult.de (Postfix) with ESMTP id 33B316047B for ; Sat, 16 Apr 2016 10:51:25 +0200 (CEST) In-Reply-To: <1460796683-24368-1-git-send-email-h.goebel@crazy-compilers.com> List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: "Guix-devel" To: guix-devel@gnu.org * doc/guix.texi (Java Packages): New subsection. --- doc/guix.texi | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/doc/guix.texi b/doc/guix.texi index 6c7107c..b54582b 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -225,6 +225,7 @@ Packaging Guidelines * Synopses and Descriptions:: Helping users find the right package. * Python Modules:: Taming the snake. * Perl Modules:: Little pearls. +* Java Packages:: Coffee break. * Fonts:: Fond of fonts. Contributing @@ -10739,6 +10740,7 @@ needed is to review and apply the patch. * Synopses and Descriptions:: Helping users find the right package. * Python Modules:: Taming the snake. * Perl Modules:: Little pearls. +* Java Packages:: Coffee break. * Fonts:: Fond of fonts. @end menu @@ -10980,6 +10982,25 @@ are also prepended by @code{perl-}. Such modules tend to have the word prefix. For instance, @code{libwww-perl} becomes @code{perl-libwww}. +@node Java Packages +@subsection Java Packages + +Java programs standing for themselves are named as any other package, +using the lowercase upstream name. + +To avoid confusion and naming clashes with other programming languages, +it's desirable that the name of a package for a Java package is prefixed +with @code{java-}. If a project already contains the word +@code{java}, we drop this; for instance, the package @code{dnsjava} +is packaged under the name @code{java-dns}. + +For Java packages containing a single class or a small class hierarchy, +we use the lowercase class name, replace all occurrences of @code{.} by +dashes and prepend the prefix @code{java-}. So the class +@code{apache.commons.cli} becomes package +@code{java-apache-commons-cli}. + + @node Fonts @subsection Fonts -- 2.7.4