all messages for Guix-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Hartmut Goebel <h.goebel@crazy-compilers.com>
To: guix-devel@gnu.org
Subject: [PATCH 1/2] doc: Add specification for Java packages
Date: Sat, 16 Apr 2016 10:51:22 +0200	[thread overview]
Message-ID: <1460796683-24368-2-git-send-email-h.goebel@crazy-compilers.com> (raw)
In-Reply-To: <1460796683-24368-1-git-send-email-h.goebel@crazy-compilers.com>

* 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

  reply	other threads:[~2016-04-16  8:51 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-04-16  8:51 [PATCH 0/2] Updated: Prefix "java-" for Java packages Hartmut Goebel
2016-04-16  8:51 ` Hartmut Goebel [this message]
2016-04-16  8:51 ` [PATCH 2/2] gnu: Rename Java packages to match new naming specification Hartmut Goebel
2016-04-19 14:56 ` [PATCH 0/2] Updated: Prefix "java-" for Java packages Ricardo Wurmus

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=1460796683-24368-2-git-send-email-h.goebel@crazy-compilers.com \
    --to=h.goebel@crazy-compilers.com \
    --cc=guix-devel@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/guix.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.