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

[wahwah at users.sourceforge.net]

Revision: 20917
          http://gar.svn.sourceforge.net/gar/?rev=20917&view=rev
Author:   wahwah
Date:     2013-04-30 18:36:11 +0000 (Tue, 30 Apr 2013)
Log Message:
-----------
opencsw-manual/trunk: Buildfarm setup rewrite

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

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-04-30 15:01:16 UTC (rev 20916)
+++ csw/mgar/pkg/opencsw-manual/trunk/files/for-maintainers/buildfarm-setup.rst	2013-04-30 18:36:11 UTC (rev 20917)
@@ -11,24 +11,56 @@
 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.
 
-Buildfarm setup consists of:
+Core setup
+----------
 
-* `basic OpenCSW installation`_
-* `GAR setup`_ and subversion checkout of build recipes
-* `local catalog mirror`_
-* `checkpkg database`_ setup
-* pkgdb-web (with Apache)
-* system garrc
-* `wiki instructions`_ (Java setup, Solaris Studio setup, ssh agent setup)
-* catalog signing daemon
+The following setup is sufficient to create packages using the OpenCSW build
+system. You can set up a small virtual machine on a home server, or build
+a set of custom packages in your company.
 
+* `basic OpenCSW installation`_, as you would do on any Solaris host where
+  you're using OpenCSW packages.
+* `GAR setup`_, including subversion checkout of build recipes. This is the
+  core part of the package building system,
+
+A `packaging video tutorial`_ is available. It covers all the steps from
+a fresh Solaris 10 install to a built package. It takes about 2-3h to complete
+it (but YMMV).
+
+Advanced setup
+--------------
+
+The following components are not required, but are quite useful.
+
+* `local catalog mirror`_ will allow you to quickly access all packages that
+  are in any of OpenCSW catalogs for any Solaris version.
+* `checkpkg database`_ will allow you to check packages for common problems,
+  for example library dependencies.
+* pkgdb-web (with Apache) is a web app on which you can browse your package
+  database and inspect package metadata without having to unpack and examine
+  packages in the terminal. Information such as list of files, pkginfo content
+  and /usr/ccs/bin/dump output are available on that page.
+* system garrc is useful when you have multiple users, for example colleagues
+  at work who also want to build packages.
+* `Additional setup documented on the wiki`_
+
+  * Java setup
+  * Solaris Studio setup if you want to build software with that compiler.
+    Many of existing build recipes at OpenCSW use this compiler, not GCC.
+  * ssh agent setup for paswordless logins
+
+* catalog signing daemon is useful if you wish to build package catalogs
+  locally and sign them with a GPG key.
+
+  * `Catalog signing daemon source code`_
+
 .. _GAR setup:
   http://sourceforge.net/apps/trac/gar/wiki/GarSetup
 
 .. _checkpkg database:
   http://wiki.opencsw.org/checkpkg#toc2
 
-.. _wiki instructions:
+.. _Additional setup documented on the wiki:
   http://wiki.opencsw.org/buildfarm
 
 .. _local catalog mirror:
@@ -36,3 +68,9 @@
 
 .. _basic OpenCSW installation:
   ../for-administrators/getting-started.html
+
+.. _packaging video tutorial:
+  http://youtu.be/JWKCbPJSaxw
+
+.. _Catalog signing daemon source code:
+  http://sourceforge.net/p/opencsw/code/HEAD/tree/catalog_signatures/

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