[rhmessaging-commits] rhmessaging commits: r3104 - store/trunk/cpp.

[rhmessaging-commits at lists.jboss.org]

Author: kpvdr
Date: 2009-02-04 08:50:06 -0500 (Wed, 04 Feb 2009)
New Revision: 3104

Modified:
   store/trunk/cpp/README
Log:
Update to README file

Modified: store/trunk/cpp/README
===================================================================
--- store/trunk/cpp/README	2009-02-03 20:44:17 UTC (rev 3103)
+++ store/trunk/cpp/README	2009-02-04 13:50:06 UTC (rev 3104)
@@ -1,30 +1,52 @@
-== MessageStore plugin for qpid c++ broker ==
+== Asynchronous Message Store Plugin for Qpid c++ Broker ==
 
-Pre-requisites:
+-- PREREQUISITES --
+
+ - libaio-devel libs
  - qpid broker headers and libraries (see below)
- - all pre-requisites for qpid
+ - all prerequisites for qpid (see qpid's cpp/INSTALL file)
  - berkeley db4  (tested with version 4.3.29)
  - python (to run system tests)
 
 For the qpid requirements you can either install the qpidd-devel package or
 check-out the qpid source from:
 
-  https://svn.apache.org/repos/asf/incubator/qpid/trunk/qpid
+  https://svn.apache.org/repos/asf/qpid/trunk/qpid
 
-To use a checkout ./configure --with-qpid-checkout=<path_to_qpid>
+-- BUILDING --
 
-* 'make' or 'make all' will build the module
+The following steps should build the package (all from the cpp directory):
 
-* 'make check' will run unit and system tests.  Use
-  'make check TESTS=run-unit-tests' or
-  'make check TESTS=system_test.sh' to run these separately.
+0. If you are using an svn checkout of qpidd, then build this package following
+   the instructions in the cpp/INSTALL file from that project. The store will not
+   link without the libqpidcommon.so library from that project. If you installed
+   the qpidd package, then this library is installed.
 
-Note: system tests require --with-qpid-checkout and also need python.
-They will be skipped otherwise.
+1. './bootstrap' (This initializes the autotools)
 
-On a fedora system install prerequisites via:
-  yum install db4-devel qpidd-devel
+2. If the qpidd package is installed, then:
 
+   './configure'
+
+   Otherwise, if using an svn checkout of qpidd (as opposed to installing
+   the qpidd package), then:
+
+   './configure --with-qpid-checkout=<path_to_qpid>'
+
+   (Point to the top-level qpid dir in which the cpp and python dirs exist)
+
+3. 'make' or 'make all' will build the module
+   'make check' will run unit and system tests.
+
+Note: Some system tests require qpid's python test framework, and therefore
+will not run unless python is installed and qpidd is installed from
+subversion and the --with-qpid-checkout option is used in configure.
+
+-- DISTRIBUTION-SPECIFIC NOTES ---
+
+On a Fedora system install prerequisites via:
+  yum install libaio-devel db4-devel qpidd-devel
+
 On a Debian-based system, install prerequisites via:
   apt-get install libdb4.3++-dev