[csw-devel] SF.net SVN: gar:[19801] csw/mgar/pkg/opencsw-manual/trunk/files/ for-maintainers

[wahwah at users.sourceforge.net]

Revision: 19801
          http://gar.svn.sourceforge.net/gar/?rev=19801&view=rev
Author:   wahwah
Date:     2012-12-02 13:43:05 +0000 (Sun, 02 Dec 2012)
Log Message:
-----------
opencsw-manual: About package naming

In response to:
http://lists.opencsw.org/pipermail/maintainers/2012-December/017401.html

Modified Paths:
--------------
    csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/index.rst

Added Paths:
-----------
    csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/index.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/index.rst	2012-12-01 21:08:52 UTC (rev 19800)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/index.rst	2012-12-02 13:43:05 UTC (rev 19801)
@@ -11,3 +11,4 @@
   filesystem-layout
   building-a-catalog
   shared-libraries
+  package-naming

Added: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst	                        (rev 0)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst	2012-12-02 13:43:05 UTC (rev 19801)
@@ -0,0 +1,47 @@
+--------------
+Package naming
+--------------
+
+.. highlight:: text
+
+We are paying attention to package naming, so we can maintain consistency across
+the catalog. For example, we have special rules about how to name packages with
+shared libraries, or development packages. In general, we often find ourselves
+following Debian, so if you're in doubt, consulting the Debian package
+repository is a good idea.
+
+pkgname vs catalogname
+----------------------
+
+pkgname is also known as pkginst. It's a name of a package in the Solaris
+packaging system. These package names start with the company ticker (e.g.
+SUNW). OpenCSW package start with “CSW”.
+
+Catalognames on the other hand, are names used in the catalog index. This means
+that one package has two names, for example “CSWfoo” (pkgname) and “foo”
+(catalogname).
+
+Applications and named projects
+-------------------------------
+
+Use the project name, keep it short and simple. If the name consists of many
+words, separate words. Use dashes to separate words in the pkgname (CSWfoo-bar)
+and underscores in the catalogname (foo_bar).
+
+Shared libraries
+----------------
+
+Shared libraries follow a special naming convention. In short, if you're
+packaging libfoo.so.1, there should be a package containing just that library,
+and the package should be named CSWlibfoo1. See the shared libraries article for
+more information.
+
+Development packages
+--------------------
+
+Software name plus the “-dev” suffix. For example: CSWfoo-dev and foo_dev.
+
+Perl, Python, Ruby
+------------------
+
+Prepend packages with pm\_, py\_ and rb\_, respectively.

This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.