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

[wahwah at users.sourceforge.net]

Revision: 16868
          http://gar.svn.sourceforge.net/gar/?rev=16868&view=rev
Author:   wahwah
Date:     2012-01-20 20:04:35 +0000 (Fri, 20 Jan 2012)
Log Message:
-----------
opencsw-manual/trunk: Formatting changes

Modified Paths:
--------------
    csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/filesystem-layout.rst
    csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/shared-libraries.rst

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/filesystem-layout.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/filesystem-layout.rst	2012-01-20 18:45:29 UTC (rev 16867)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/filesystem-layout.rst	2012-01-20 20:04:35 UTC (rev 16868)
@@ -20,3 +20,8 @@
 a common practice to set up non-global sparse zones with shared /opt/csw. In
 this setup, non-global zones see /opt/csw as mounted read-only. Any local
 state needs to be kept under /var/opt/csw.
+
+.. [#shared-opt-csw]
+   `Shared /opt/csw configuration files`_
+.. Shared /opt/csw configuration files:
+   http://wiki.opencsw.org/shared-opt-csw-setup

Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/shared-libraries.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/shared-libraries.rst	2012-01-20 18:45:29 UTC (rev 16867)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/shared-libraries.rst	2012-01-20 20:04:35 UTC (rev 16868)
@@ -74,7 +74,6 @@
 Advantages:
 
 * easy and complete lifecycle of shared libraries
-
 * phasing out of shared libraries can become part of standard catalog
   update procedures
 * simpler packages, simpler builds (no need for version modulations and
@@ -89,7 +88,6 @@
   number remains: 4 per release.  There will be one new CSWlibpython*
   package, and the old CSWlibpython library won't be upgraded.
 
-
 Disadvantages:
 
 * maintainers need to make more decisions when packaging
@@ -130,24 +128,24 @@
 libapr-1.so.10.0.0        CSWlibapr1-10-0-0       libapr1_10_0_0
 ========================= ======================= =========================
 
-Separators
-^^^^^^^^^^
+Separators are added between two adjacent numbers, and removed if a number and
+a letter are next to each other.  For example, ``libfoo.so.0`` becomes
+``CSWlibfoo0``, and ``libfoo-1.so.0`` becomes ``CSWlibfoo1-0``.
 
-Separators are added between two adjacent numbers, and removed if a number and a letter are next to each other.  For example, ``libfoo.so.0`` becomes ``CSWlibfoo0``, and ``libfoo-1.so.0`` becomes ``CSWlibfoo1-0``.
-
 Linkable shared objects
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-The policy or recommendation shall refer to libraries which are //linkable,// meaning other binaries can link against them.  Shared objects in private directories, such as /opt/csw/lib/someproject/foo.so (think Python modules) are not shared libraries which other projects can link to, and therefore there is no benefit in placing them in separate packages.
+The policy or recommendation shall refer to libraries which are //linkable,//
+meaning other binaries can link against them.  Shared objects in private
+directories, such as /opt/csw/lib/someproject/foo.so (think Python modules)
+are not shared libraries which other projects can link to, and therefore there
+is no benefit in placing them in separate packages.
 
-Special cases
-^^^^^^^^^^^^^
+Some packages (e.g. Kerberos libraries) put private shared libraries into
+/opt/csw/lib.  They don't expose any public API, and only own Kerberos
+binaries link to them.  Private shared libraries can be bundled with the main
+package, without splitting them off.
 
-Some packages (e.g. Kerberos libraries) put private shared libraries into /opt/csw/lib.  They don't expose any public API, and only own Kerberos binaries link to them.  Private shared libraries can be bundled with the main package, without splitting them off.
-
-Examples
-^^^^^^^^
-
 ============================================================================== ============
 file                                                                           linkable?
 ============================================================================== ============
@@ -169,7 +167,7 @@
 tests. [#is-library-linkable-unit-tests]_
 
 Private shared libraries
-^^^^^^^^^^^^^^^^^^^^^^^^
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Some software projects install private (non-linkable) shared libraries
 into libdir (e.g. ``/opt/csw/lib``) by default.  To ensure that they are

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