From: Willy Tarreau <w@1wt.eu>
Date: Fri, 28 Aug 2015 08:39:11 +0000 (+0200)
Subject: DOC: lua: mention than txn:close was renamed txn:done.
X-Git-Tag: v1.6-dev4~2
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=bc183a6eda5437853327cce460c19b02b3202fdf;p=thirdparty%2Fhaproxy.git

DOC: lua: mention than txn:close was renamed txn:done.

Also indicate that it's not limited to error processing.
---

diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst
index f8cfee26bc..fa69e1f466 100644
--- a/doc/lua-api/index.rst
+++ b/doc/lua-api/index.rst
@@ -931,10 +931,11 @@ TXN class
   :param class_txn txn: The class txn object containing the data.
   :returns: an array of headers.
 
-.. js:function:: TXN.close(txn)
+.. js:function:: TXN.done(txn)
 
-  This function close the transaction and the associated session. It can be
-  used when a critical error is detected.
+  This function terminates processing of the transaction and the associated
+  session. It can be used when a critical error is detected or to terminate
+  processing after some data have been returned to the client (eg: a redirect).
 
   :param class_txn txn: The class txn object containing the data.