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

[wahwah at users.sourceforge.net]

Revision: 21033
          http://gar.svn.sourceforge.net/gar/?rev=21033&view=rev
Author:   wahwah
Date:     2013-05-09 00:10:15 +0000 (Thu, 09 May 2013)
Log Message:
-----------
opencsw-manual: Documentation updates.

Modified Paths:
--------------
    csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/mirror-setup.rst
    csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/buildfarm-setup.rst
    csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/mirror-setup.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/mirror-setup.rst	2013-05-08 21:17:23 UTC (rev 21032)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/mirror-setup.rst	2013-05-09 00:10:15 UTC (rev 21033)
@@ -12,13 +12,18 @@
 quickly and with low bandwidth use and also preserves hardlinks. Not all
 mirrors provide access via the ``rsync`` protocol, please consult
 `our list of mirrors`_.
-To make a full copy of the OpenCSW repository::
 
-  MIRROR_DIR=/export/mirror/opencsw
+To make a full copy of the OpenCSW repository, first make sure you have rsync
+on your system::
+
   sudo pkgutil -y -i rsync
-  sudo mkdir -p "${MIRROR_DIR}"
-  sudo rsync -aH --delete rsync://rsync.opencsw.org/opencsw/ "${MIRROR_DIR}"
 
+Then copy the files::
+
+  sudo mkdir -p /export/mirror/opencsw
+  sudo chown $LOGNAME /export/mirror/opencsw
+  rsync -aH --delete rsync://rsync.opencsw.org/opencsw/ /export/mirror/opencsw
+
 The directory ``opencsw-mirror`` can either be shared via HTTP or via NFS to the
 ``pkgutil`` clients.  Use ``http://myserver/opencsw-mirror/`` for HTTP and
 ``file:///myserver/opencsw-mirror`` for NFS as mirror option in ``pkgutil``.

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/buildfarm-setup.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/buildfarm-setup.rst	2013-05-08 21:17:23 UTC (rev 21032)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/buildfarm-setup.rst	2013-05-09 00:10:15 UTC (rev 21033)
@@ -4,9 +4,6 @@
 
 .. highlight:: text
 
-Introduction
-------------
-
 Packages released by OpenCSW must be built on the OpenCSW buildfarm, but if
 you want to experiment, or build in-house packages, you might want to set up
 your own build farm, or at least a build host.

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst	2013-05-08 21:17:23 UTC (rev 21032)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst	2013-05-09 00:10:15 UTC (rev 21033)
@@ -4,11 +4,11 @@
 
 .. 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.
+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 and 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
 ----------------------
@@ -17,16 +17,16 @@
 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”
+Catalognames 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).
+Use the upstream project name, keep it short and simple. If the name consists
+of many words, use word separators. Dashes are used to separate words in the
+pkgname (CSWfoo-bar) and underscores in the catalogname (foo\_bar).
 
 Shared libraries
 ----------------
@@ -45,3 +45,6 @@
 ------------------
 
 Prepend packages with pm\_, py\_ and rb\_, respectively.
+
+.. _shared libraries:
+  shared-libraries.html

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