# HG changeset patch
# User Kim Alvefur <zash@zash.se>
# Date 1580064768 -3600
# Node ID c9de8275aaf2454ffa98324c28b367941ce5cbe8
# Parent  58cc0bc09f3d702d079749722ac6019ad5bf4218
mod_s2s: Comment on the various 'reason' arguments passed to :close

diff -r 58cc0bc09f3d -r c9de8275aaf2 plugins/mod_s2s/mod_s2s.lua
--- a/plugins/mod_s2s/mod_s2s.lua	Sun Jan 26 16:55:28 2020 +0100
+++ b/plugins/mod_s2s/mod_s2s.lua	Sun Jan 26 19:52:48 2020 +0100
@@ -487,6 +487,9 @@
 
 --- Session methods
 local stream_xmlns_attr = {xmlns='urn:ietf:params:xml:ns:xmpp-streams'};
+-- reason: stream error to send to the remote server
+-- remote_reason: stream error received from the remote server
+-- bounce_reason: stanza error to pass to bounce_sendq beacuse stream- and stanza errors are different
 local function session_close(session, reason, remote_reason, bounce_reason)
 	local log = session.log or log;
 	if session.conn then