[libmessage-passing-zeromq-perl] 41/78: Doc fixes

[Jonas Smedegaard]

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

js pushed a commit to branch master
in repository libmessage-passing-zeromq-perl.

commit 7e656a51075c93730a1d1f4d33e3e6c5c1409508
Author: Tomas Doran <bobtfish at bobtfish.net>
Date:   Mon May 28 08:59:43 2012 +0100

    Doc fixes
---
 Changes                                       |    2 ++
 lib/Message/Passing/Input/ZeroMQ.pm           |    2 +-
 lib/Message/Passing/Output/ZeroMQ.pm          |    9 +++------
 lib/Message/Passing/ZeroMQ.pm                 |   14 +++++++-------
 lib/Message/Passing/ZeroMQ/Role/HasASocket.pm |    2 +-
 5 files changed, 14 insertions(+), 15 deletions(-)

diff --git a/Changes b/Changes
index 573284f..e8d2296 100644
--- a/Changes
+++ b/Changes
@@ -1,3 +1,5 @@
+    - Documentation fixes.
+
 0.002_01
     - Rename dist
 
diff --git a/lib/Message/Passing/Input/ZeroMQ.pm b/lib/Message/Passing/Input/ZeroMQ.pm
index 6221b26..6aa5fa4 100644
--- a/lib/Message/Passing/Input/ZeroMQ.pm
+++ b/lib/Message/Passing/Input/ZeroMQ.pm
@@ -74,7 +74,7 @@ sub BUILD {
 
 =head1 NAME
 
-Message::Passing::Input::ZeroMQ - input logstash messages from ZeroMQ.
+Message::Passing::Input::ZeroMQ - input messages from ZeroMQ.
 
 =head1 DESCRIPTION
 
diff --git a/lib/Message/Passing/Output/ZeroMQ.pm b/lib/Message/Passing/Output/ZeroMQ.pm
index 4ced723..5f63d9b 100644
--- a/lib/Message/Passing/Output/ZeroMQ.pm
+++ b/lib/Message/Passing/Output/ZeroMQ.pm
@@ -31,7 +31,7 @@ with 'Message::Passing::Role::Output';
 
 =head1 NAME
 
-Message::Passing::Output::ZeroMQ - output logstash messages to ZeroMQ.
+Message::Passing::Output::ZeroMQ - output messages to ZeroMQ.
 
 =head1 SYNOPSIS
 
@@ -40,21 +40,18 @@ Message::Passing::Output::ZeroMQ - output logstash messages to ZeroMQ.
     my $logger = Message::Passing::Output::ZeroMQ->new;
     $logger->consume({data => { some => 'data'}, '@metadata' => 'value' });
 
-    # You are expected to produce a logstash message format compatible message,
-    # see the documentation in Message::Passing for more details.
-
     # Or see Log::Dispatch::Message::Passing for a more 'normal' interface to
     # simple logging.
 
     # Or use directly on command line:
-    logstash --input STDIN --output ZeroMQ
+    message-passing --input STDIN --output ZeroMQ
     {"data":{"some":"data"},"@metadata":"value"}
 
 =head1 DESCRIPTION
 
 A L<Message::Passing> L<ZeroMQ> output class.
 
-Can be used as part of a chain of classes with the L<logstash> utility, or directly as
+Can be used as part of a chain of classes with the L<message-passing> utility, or directly as
 a logger in normal perl applications.
 
 =head1 METHODS
diff --git a/lib/Message/Passing/ZeroMQ.pm b/lib/Message/Passing/ZeroMQ.pm
index 16da75c..55ab375 100644
--- a/lib/Message/Passing/ZeroMQ.pm
+++ b/lib/Message/Passing/ZeroMQ.pm
@@ -21,16 +21,16 @@ POSIX::AtFork->add_to_prepare(subname at_fork => sub {
 
 =head1 NAME
 
-Message::Passing::ZeroMQ - input and output logstash messages to ZeroMQ.
+Message::Passing::ZeroMQ - input and output messages to ZeroMQ.
 
 =head1 SYNOPSIS
 
     # Terminal 1:
-    $ logstash --input STDIN --output ZeroMQ --output_options '{"connect":"tcp://127.0.0.1:5558"}'
+    $ message-passing --input STDIN --output ZeroMQ --output_options '{"connect":"tcp://127.0.0.1:5558"}'
     {"data":{"some":"data"},"@metadata":"value"}
 
     # Terminal 2:
-    $ logstash --output STDOUT --input ZeroMQ --input_options '{"socket_bind":"tcp://*:5558"}'
+    $ message-passing --output STDOUT --input ZeroMQ --input_options '{"socket_bind":"tcp://*:5558"}'
     {"data":{"some":"data"},"@metadata":"value"}
 
 =head1 DESCRIPTION
@@ -59,9 +59,9 @@ it via L<Log::Dispatch::Message::Passing>.
 
     # FIXME - Example code, including overriding IP to connect to here
 
-On your log aggregation server, just run the logstash utility:
+On your log aggregation server, just run the message-passing utility:
 
-    logstash --input ZeroMQ --input_options '{"socket_bind":"tcp://*:5222"}' \
+    message-passing --input ZeroMQ --input_options '{"socket_bind":"tcp://*:5222"}' \
         --output File --output_options '{"filename":"/tmp/my_test.log"}'
 
 =head1 CONNECTION DIRECTION
@@ -99,7 +99,7 @@ With this in mind, we can easily create a system which aggregates messages from
 multiple publishers, and passes them out (in a round-robin fashion) to a pool of workers.
 
     # The message distributor:
-    logstash --input ZeroMQ --input_options '{"socket_bind":"tcp://*:5222"}' \
+    message-passing --input ZeroMQ --input_options '{"socket_bind":"tcp://*:5222"}' \
         --output ZeroMQ --output_options '{"socket_bind":"tcp://*:5223","socket_type":"PUSH"}'
 
     # Workers
@@ -116,7 +116,7 @@ multiple publishers, and passes them out (in a round-robin fashion) to a pool of
         }
     }
 
-    logstash --input ZeroMQ --input_options '{"connect":"tcp://127.0.0.1:5223","socket_type":"PULL"}'
+    message-passing --input ZeroMQ --input_options '{"connect":"tcp://127.0.0.1:5223","socket_type":"PULL"}'
         --filter '+MyApp::MessageWorker'
         --output STDOUT
 
diff --git a/lib/Message/Passing/ZeroMQ/Role/HasASocket.pm b/lib/Message/Passing/ZeroMQ/Role/HasASocket.pm
index 887394b..e081277 100644
--- a/lib/Message/Passing/ZeroMQ/Role/HasASocket.pm
+++ b/lib/Message/Passing/ZeroMQ/Role/HasASocket.pm
@@ -73,7 +73,7 @@ has connect => (
 
 =head1 NAME
 
-Message::Passing::ZeroMQ::HasASocket - Role for instances which have a ZeroMQ socket.
+Message::Passing::ZeroMQ::Role::HasASocket - Role for instances which have a ZeroMQ socket.
 
 =head1 ATTRIBUTES
 

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libmessage-passing-zeromq-perl.git