[libnet-dbus-perl] 138/335: Update readme notes

[Intrigeri]

This is an automated email from the git hooks/post-receive script.

intrigeri pushed a commit to branch experimental
in repository libnet-dbus-perl.

commit 6de959bf56e8a46fa69f4b802e310612159db417
Author: Daniel P. Berrange <dan at berrange.com>
Date:   Sun Oct 23 14:34:02 2005 +0000

    Update readme notes
---
 README | 53 ++++++++++++++++++++++++++---------------------------
 1 file changed, 26 insertions(+), 27 deletions(-)

diff --git a/README b/README
index 50d4dde..08ec66e 100644
--- a/README
+++ b/README
@@ -9,8 +9,9 @@ project website at:
 
   http://www.freedesktop.org/software/dbus/
 
-This version operates against DBus 0.32, and if there have
-been no serious API changes, later versions too.
+This version operates against DBus 0.32, through 0.51, and 
+possibly later versions, if there have been no serious API 
+changes.
 
 INSTALLATION
 ------------
@@ -22,29 +23,24 @@ To install this module type the following:
    make test
    sudo make install
 
-If your dbus installation is not in the /usr prefix,
-the the argument DBUS_HOME must be used to specify
-the instllation prefix when generating the Makefile.
-For example, if dbus were initially configured and
-built with 'configure --prefix=$HOME/dbus-0.32' then
-the installation procedure for this Perl module would 
-be
+The makefile calls the C<pkg-config> script to determine the
+correct flags to pass to the compiler & linkers when building
+the XS part of the module. Thus, ensure pkg-config is in
+a directory listed by the $PATH environment. 
 
-   perl Makefile.PL DBUS_HOME=$HOME/dbus-0.32
+The pkg-config program will likely find the DBus install in /usr
+provided by the base OS distribution, so if testing against an 
+alternate  install of DBus, set the C$PKG_CONFIG_PATH env 
+variable before generating the Makefile. For example, if your 
+dbus installation is in C<$HOME/usr/dbus-cvs-tip> , then to build
+and install against this version of DBus do
+
+   export PKG_CONFIG_PATH=$HOME/usr/dbus-cvs-tip/lib/pkg-config
+   perl Makefile.PL PREFIX=$HOME/usr/dbus-cvs-tip
    make
    make test
    make install
 
-The XS layer has the capability to output information
-about its operation on STDERR during normal operation.
-Due to its performance hit, this capability must be
-enabled when initially compiling the DBus module by
-specifying the 'PD_DEBUG=1' parameter:
-
-  perl Makefile.PL PD_DEBUG=1
-
-In addition, when running a program the environment
-variable PD_DEBUG must be set (to any value).
 
 DEPENDENCIES
 ------------
@@ -52,14 +48,18 @@ DEPENDENCIES
 In keeping with the C API, the Perl DBus implementation
 has minimal external dependancies:
 
-  Test::More
   Time::HiRes
   XML::Grove
   XML::Parser
 
-Both of these modules are present as standard in versions
-of Perl >= 5.8.0, while for earlier versions they may
-be obtained from CPAN (http://search.cpan.org/).
+And to run the test suite:
+
+  Test::More
+
+Although they are not part of the base Perl distribution, most 
+OS distributor will already provide addon packages containing
+these modules. Failing this, they are all available from CPAN
+http://search.cpan.org/
 
 EXAMPLES
 --------
@@ -73,7 +73,7 @@ developer APIs.
   example-signal-emitter.pl  - How to broadcast signals
   example-signal-receiver.pl - How to receive signals
   dump-object.pl             - Dump info about dbus objects
-
+  lshal.pl                   - Dump names of all HAL devices
 
 CONTRIBUTIONS
 -------------
@@ -113,7 +113,6 @@ COPYRIGHT AND LICENCE
 
 Copyright (C) 2004-2005 Daniel Berrange
 
-This library is provided under the terms of the GNU
-GPL 
+This library is provided under the terms of the GNU GPL 
 
 -- End

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libnet-dbus-perl.git