SF.net SVN: gar:[23429] csw/mgar/pkg/opencsw-manual/trunk/files
wahwah at users.sourceforge.net
wahwah at users.sourceforge.net
Sat Apr 19 01:48:00 CEST 2014
Revision: 23429
http://sourceforge.net/p/gar/code/23429
Author: wahwah
Date: 2014-04-18 23:47:59 +0000 (Fri, 18 Apr 2014)
Log Message:
-----------
/home/maciej/opencsw/opencsw-manual/trunk: Turns out you can create an index.
Modified Paths:
--------------
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/faq.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/installation-en-masse.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/mirror-setup.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/solaris-10-sparse-zones.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/32-bit-and-64-bit.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/buildfarm-setup.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/building-a-catalog.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-format.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-releases.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/filesystem-layout.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst
csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/shared-libraries.rst
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/faq.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/faq.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/faq.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -19,11 +19,11 @@
How can I install CSW packages in a location other than ``/opt/csw``?
=====================================================================
-OpenCSW packages are not relocatable, so you can't install them in a location
-other than /opt/csw. Even if the packages were relocatable from the package
-system point of view, there are usually paths hard-coded within the packaged
-applications that point to and rely on /opt/csw (for libraries, configuration
-files, data files and such). Relocating such applications is
+OpenCSW packages are not :index:`relocatable`, so you can't install them in a
+location other than /opt/csw. Even if the packages were relocatable from the
+package system point of view, there are usually paths hard-coded within the
+packaged applications that point to and rely on /opt/csw (for libraries,
+configuration files, data files and such). Relocating such applications is
application-specific.
How can I transfer packages to a computer without an Internet connection?
@@ -32,25 +32,26 @@
Please see :ref:`installing on a host without an Internet connection
<installing-on-a-host-without-an-internet-connection>`.
-Why do packages go by two names (e.g. CSWftype2 and freetype2)?
+Why do packages go by two names? (e.g. CSWftype2 and freetype2)
===============================================================
There are two names associated with every piece of software that we ship: a
-package name (a.k.a. pkgname, or pkginst) and a catalog name. The package name
-is used by the underlying Solaris SVR4 package management tools (pkgadd, pkgrm,
-pkginfo), needs to fit historical limits (32 characters), and is sometimes
-cryptically condensed. The catalog name has no significance to Solaris itself,
-and is used by pkgutil and in package catalogs.
+package name (a.k.a. :index:`pkgname`, or :index:`pkginst`) and a
+:index:`catalog name`. The package name is used by the underlying Solaris SVR4
+package management tools (pkgadd, pkgrm, pkginfo), needs to fit historical
+limits (32 characters), and is sometimes cryptically condensed. The catalog
+name has no significance to Solaris itself, and is used by pkgutil and in
+package catalogs.
Why not use third party dependencies?
=====================================
Problems with declaring SUNW and SFW packages as dependencies are:
-* pkgutil can't download and install them, so declaring them as dependencies
+* pkgutil can't download and/or install them, so declaring them as dependencies
won't help during installation
* they often contain old versions of software (or libraries), while OpenCSW
- package need newer versions
+ packages need newer versions
* OpenCSW packages must be installable on multiple Solaris versions; a package
built for Solaris 9 will also install on Solaris 10. In many cases, the
required shared libraries are in packages of different names, e.g. 64-bit
@@ -70,8 +71,8 @@
Are the binaries compiled for advanced Instruction Set Architectures?
=====================================================================
-Binaries are compiled for basic ISAs. As of April 2014, it means pentium_pro on
-Intel and sparcv8+ on SPARC.
+Binaries are compiled for basic ISAs. As of April 2014, it means
+:index:`pentium_pro` on Intel and :index:`sparcv8+` on SPARC.
In most cases, performance is not significantly improved by compiling for
advanced ISAs. For those cases where it is, we usually provide cpu-optimized
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/getting-started.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -1,11 +1,9 @@
-.. $Id$
+.. _getting-started:
---------------
Getting started
---------------
-.. _getting-started:
-
::
pkgadd -d http://get.opencsw.org/now
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/installation-en-masse.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/installation-en-masse.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/installation-en-masse.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -4,7 +4,6 @@
.. _installing-on-a-host-without-an-internet-connection:
----------------------------------------------------
Installing on a host without an Internet connection
---------------------------------------------------
@@ -31,12 +30,12 @@
.. _discussed on the community site: http://www.opencsw.org/community/questions/92/installing-without-a-direct-internet-access
------------------
+
Large deployments
-----------------
-To manage package across multiple hosts, you can use a configuration management
-system like puppet, see `Andy Botting's blog post`_ for an example.
+1. :ref:`Set up a local mirror<setting-up-local-mirror>`.
+2. Manage packages with puppet, see `Andy Botting's blog post`_ for an example.
.. _Andy Botting's blog post:
http://www.andybotting.com/using-pkgutil-on-solaris-with-puppet-for-easy-package-management
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 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/mirror-setup.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -1,9 +1,11 @@
.. $Id$
----------------------------
-Setting up a private mirror
----------------------------
+.. _setting-up-local-mirror:
+----------------------------------
+Setting up a :index:`local mirror`
+----------------------------------
+
Sometimes it is sufficient to simply use a mirror on the Internet.
However, there are situations where a local mirror can be useful. When you have
a lot of servers accessing the repository, want to control the package updates
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/setup.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -37,8 +37,8 @@
Do not set LD_LIBRARY_PATH
==========================
-LD_LIBRARY_PATH is an environment variable which can be used to make the
-dynamic linker look for shared libraries in specific places. It is not
+:index:`LD_LIBRARY_PATH` is an environment variable which can be used to make
+the dynamic linker look for shared libraries in specific places. It is not
necessary to set it for OpenCSW binaries. All of them are built with the ``-R``
flag, so each binary itself knows where to look for the shared objects.
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/solaris-10-sparse-zones.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/solaris-10-sparse-zones.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-administrators/solaris-10-sparse-zones.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -1,6 +1,6 @@
------------------------
-Solaris 10 sparse zones
------------------------
+--------------------------------
+Solaris 10 :index:`sparse zones`
+--------------------------------
1. set inherit-pkg-dir on ``/opt/csw``
2. install OpenCSW packages in the global zone
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/32-bit-and-64-bit.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/32-bit-and-64-bit.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/32-bit-and-64-bit.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -5,9 +5,8 @@
64-bit binaries aren't always best
----------------------------------
-It's counter-intuitive, but 64-bit binaries are more memory-hungry and
-often slower than 32-bit ones. It makes sense to build 64-bit binaries
-when:
+It's counter-intuitive, but :index:`64-bit` binaries are more memory-hungry and
+often slower than 32-bit ones. It makes sense to build 64-bit binaries when:
* There's a measurable speed boost.
* The application needs to access more than 2G of RAM.
@@ -58,8 +57,8 @@
Development packages (header files)
-----------------------------------
-Development packages in most cases don't distinguish between 32-bit and
-64-bit ‒ you don't have to do anything.
+:index:`Development packages` in most cases don't distinguish between 32-bit
+and 64-bit ‒ you don't have to do anything.
However, there are some software projects (e.g. ``gmp``) which install
different headers depending on bitness. These have to be handled
@@ -136,11 +135,12 @@
BUILD64 = 1
-**See also**
+.. seealso::
-* `Solaris 64-bit Developer's Guide`_
-* `Are 64-bit Binaries Really Slower than 32-bit Binaries?`_
+ `Solaris 64-bit Developer's Guide`_
+ `Are 64-bit Binaries Really Slower than 32-bit Binaries?`_
+
.. _Solaris 64-bit Developer's Guide:
http://docs.sun.com/app/docs/doc/816-5138
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 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/buildfarm-setup.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -11,9 +11,9 @@
starting from a fresh Solaris 10 install and ends with a built package. It
takes about 2-3h to complete. It covers the basic GAR setup.
-A build-farm is a set of hosts where you can build Solaris packages. You can
-connect Intel and SPARC hosts together to build a set of packages with one
-shell command.
+A :index:`buildfarm` is a set of hosts where you can build Solaris packages.
+You can connect Intel and SPARC hosts together to build a set of packages with
+one shell command.
There is a few separate parts which you can set up (in no particular order):
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/building-a-catalog.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/building-a-catalog.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/building-a-catalog.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -1,3 +1,5 @@
+.. _building-a-catalog:
+
--------------------------
Building a package catalog
--------------------------
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-format.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-format.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-format.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -23,8 +23,8 @@
there's a source package available. In that case extra fields should be
added to the end so not to break existing tools.
-Signatures
-==========
+GPG Signatures
+==============
A catalog file can be signed with gpg, cleartext style, with the signature
embedded in the file.
@@ -36,9 +36,10 @@
# CREATIONDATE 2014-03-16T08:39:58Z
-See also:
+.. seealso::
-* `Building a catalog`_
+ `Building a catalog`_
+ Information on how to build your own catalog.
.. _Building a catalog:
- building-a-catalog.html
+ building-a-catalog.html
Modified: csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-releases.rst
===================================================================
--- csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-releases.rst 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/catalog-releases.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -9,12 +9,12 @@
also see the README file on the OpenCSW master mirror
[#opencsw-master-mirror]_.
-* **unstable** is a working catalog where package maintainers make changes at
+* **:index:`unstable`** is a working catalog where package maintainers make changes at
will. Updates to unstable are pushed every 10 minutes (April 2014).
* **testing** is a symlink to a named release. It gets periodically updated
from the unstable catalog. As of March 2014, it is done infrequently, by a
human.
-* **stable** is a symlink to a named release. Once a stable release is made, it
+* **:index:`stable`** is a symlink to a named release. Once a stable release is made, it
is not updated unless there are important security updates to be pushed.
References
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 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/filesystem-layout.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -22,7 +22,7 @@
local state needs to be kept under ``/var/opt/csw``.
Inside the ``/opt/csw`` prefix, the typical hierarchy rules apply. You can
-consult the Debian `filesystem hierarchy standard`_ for an overview. A short version is:
+consult the `Debian filesystem hierarchy standard`_ for an overview. A short version is:
* Executables go to ``/opt/csw/bin`` ``/opt/csw/sbin`` ``/opt/csw/libexec``
* Shared libraries go to ``/opt/csw/lib``
@@ -43,5 +43,5 @@
.. _Shared /opt/csw configuration files:
http://wiki.opencsw.org/shared-opt-csw-setup
-.. _filesystem hierarchy standard:
+.. _Debian filesystem hierarchy standard:
http://wiki.debian.org/FilesystemHierarchyStandard
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 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/package-naming.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -13,13 +13,12 @@
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”.
+:index:`pkgname` is also known as :index:`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 are names used in the catalog index. This means that one package
-has two names, for example “CSWfoo” (pkgname) and “foo”
-(catalogname).
+has two names, for example "CSWfoo" (pkgname) and "foo" (:index:`catalogname`).
Applications and named projects
-------------------------------
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 2014-04-18 19:50:09 UTC (rev 23428)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/shared-libraries.rst 2014-04-18 23:47:59 UTC (rev 23429)
@@ -11,7 +11,7 @@
Life cycle of a shared library can be summarized in the following way:
-1. A SONAME appears
+1. A :index:`SONAME` appears
2. We decide to distribute it
3. Binaries start linking to it
4. Time passes, new version of the same library comes along
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the devel
mailing list