# HG changeset patch
# User Matthew Wild <mwild1@gmail.com>
# Date 1487929696 0
# Node ID 99b32f77f00d44a287830abe9d0156a952652ae0
# Parent  2b533a7b5236bbc6f9de8a24fd04728c86ccdbb4
mod_firewall: Document PASS, RETURN and DEFAULT

diff -r 2b533a7b5236 -r 99b32f77f00d mod_firewall/README.markdown
--- a/mod_firewall/README.markdown	Fri Feb 24 09:38:20 2017 +0000
+++ b/mod_firewall/README.markdown	Fri Feb 24 09:48:16 2017 +0000
@@ -474,8 +474,9 @@
 
   Action                  Description
   ----------------------- ---------------------------------------------------------------------------------------------------------------------------------------------------------
-  `PASS.`                 Stop executing actions and rules on this stanza, and let it through this chain.
+  `PASS.`                 Stop executing actions and rules on this stanza, and let it through this chain and any calling chains.
   `DROP.`                 Stop executing actions and rules on this stanza, and discard it.
+  `DEFAULT.`              Stop executing actions and rules on this stanza, prevent any other scripts/modules from handling it, to trigger the appropriate default "unhandled stanza" behaviour. Do not use in custom chains (it is treated as PASS).
   `REDIRECT=jid`          Redirect the stanza to the given JID.
   `REPLY=text`            Reply to the stanza (assumed to be a message) with the given text.
   `BOUNCE.`               Bounce the stanza with the default error (usually service-unavailable)
@@ -532,7 +533,7 @@
 
 Rules are grouped into "chains", which are injected at particular points in Prosody's routing code.
 
-Available chains are:
+Available built-in chains are:
 
   Chain          Description
   -------------- -------------------------------------------------------------------------------------------
@@ -573,6 +574,7 @@
   Action                   Description
   ------------------------ ------------------------------------------------------------------------
   `JUMP CHAIN=name`        Switches chains, and passes the stanza through the rules in chain 'name'. If the new chain causes the stanza to be dropped/redirected, the current chain halts further processing.
+  `RETURN.`                Stops executing the current chain and returns to the parent chain. For built-in chains, equivalent to PASS. RETURN is implicit at the end of every chain.
 
 It is possible to jump to chains defined by other scripts and modules.