From 28f4cd51c113f39b0ebe0582d4a689005b7691db Mon Sep 17 00:00:00 2001
From: Hanno Hecker <vetinari@ankh-morp.org>
Date: Tue, 3 Jun 2008 16:09:59 +0000
Subject: [PATCH] clarify what "return values are ignored or discarded" means

git-svn-id: https://svn.perl.org/qpsmtpd/trunk@925 958fd67b-6ff1-0310-b445-bb7760255be9
---
 docs/plugins.pod | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/docs/plugins.pod b/docs/plugins.pod
index 6413e56..e972eb2 100644
--- a/docs/plugins.pod
+++ b/docs/plugins.pod
@@ -410,6 +410,13 @@ are noted in the description of the hook. If you need examples how the
 hook can be used, see the source of the plugins, which are given as 
 example plugins.
 
+B<NOTE>: for some hooks (post-fork, post-connection, disconnect, deny, ok) the
+return values are ignored. This does B<not> mean you can return anything you
+want. It just means the return value is discarded and you can not disconnect
+a client with I<DENY_DISCONNECT>. The rule to return I<DECLINED> to run the
+next plugin for this hook (or return I<OK> / I<DONE> to stop processing) 
+still applies.
+
 =head2 hook_pre_connection
 
 Called by a controlling process (e.g. forkserver or prefork) after accepting