Adding upstream version 3.0.0.upstream/3.0.0

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 41 insertions, 25 deletions

diff --git a/doc/lua-api/index.rst b/doc/lua-api/index.rst
index 17927f3..0d69a2f 100644
--- a/doc/lua-api/index.rst
+++ b/doc/lua-api/index.rst
@@ -348,33 +348,33 @@ Core class
   end
 ..
 
-.. js:function:: core.add_acl(filename, key)
+.. js:function:: core.add_acl(name, key)
 
   **context**: init, task, action, sample-fetch, converter
 
-  Add the ACL *key* in the ACLs list referenced by the file *filename*.
+  Add the ACL *key* in the ACLs list referenced by *name*.
 
-  :param string filename: the filename that reference the ACL entries.
+  :param string name: the name that reference the ACL entries.
   :param string key: the key which will be added.
 
-.. js:function:: core.del_acl(filename, key)
+.. js:function:: core.del_acl(name, key)
 
   **context**: init, task, action, sample-fetch, converter
 
   Delete the ACL entry referenced by the key *key* in the list of ACLs
-  referenced by *filename*.
+  referenced by *name*.
 
-  :param string filename: the filename that reference the ACL entries.
+  :param string name: the name that reference the ACL entries.
   :param string key: the key which will be deleted.
 
-.. js:function:: core.del_map(filename, key)
+.. js:function:: core.del_map(name, key)
 
   **context**: init, task, action, sample-fetch, converter
 
   Delete the map entry indexed with the specified key in the list of maps
-  referenced by his filename.
+  referenced by his name.
 
-  :param string filename: the filename that reference the map entries.
+  :param string name: the name that reference the map entries.
   :param string key: the key which will be deleted.
 
 .. js:function:: core.get_info()
@@ -828,14 +828,14 @@ Core class
 
   :param integer nice: the nice value, it must be between -1024 and 1024.
 
-.. js:function:: core.set_map(filename, key, value)
+.. js:function:: core.set_map(name, key, value)
 
   **context**: init, task, action, sample-fetch, converter
 
   Set the value *value* associated to the key *key* in the map referenced by
-  *filename*.
+  *name*.
 
-  :param string filename: the Map reference
+  :param string name: the Map reference
   :param string key: the key to set or replace
   :param string value: the associated value
 
@@ -2877,6 +2877,22 @@ TXN class
 
   :see: :js:func:`TXN.reply`, :js:class:`Reply`
 
+.. js:function:: TXN.set_fc_tos(txn, tos)
+
+  Is used to set the TOS or DSCP field value of packets sent to the client to
+  the value passed in "tos" on platforms which support this.
+
+  :param class_txn txn: The class txn object containing the data.
+  :param integer tos: The new TOS os DSCP.
+
+.. js:function:: TXN.set_fc_mark(txn, mark)
+
+  Is used to set the Netfilter MARK on all packets sent to the client to the
+  value passed in "mark" on platforms which support it.
+
+  :param class_txn txn: The class txn object containing the data.
+  :param integer mark: The mark value.
+
 .. js:function:: TXN.set_loglevel(txn, loglevel)
 
   Is used to change the log level of the current request. The "loglevel" must
@@ -2888,21 +2904,21 @@ TXN class
     :js:attr:`core.crit`, :js:attr:`core.err`, :js:attr:`core.warning`, :js:attr:`core.notice`,
     :js:attr:`core.info`, :js:attr:`core.debug` (log level definitions)
 
-.. js:function:: TXN.set_tos(txn, tos)
+.. js:function:: TXN.set_mark(txn, mark)
 
-  Is used to set the TOS or DSCP field value of packets sent to the client to
-  the value passed in "tos" on platforms which support this.
+  Alias for :js:func:`TXN.set_fc_mark()`.
 
-  :param class_txn txn: The class txn object containing the data.
-  :param integer tos: The new TOS os DSCP.
+  .. warning::
+     This function is deprecated. :js:func:`TXN.set_fc_mark()` must be used
+     instead.
 
-.. js:function:: TXN.set_mark(txn, mark)
+.. js:function:: TXN.set_tos(txn, tos)
 
-  Is used to set the Netfilter MARK on all packets sent to the client to the
-  value passed in "mark" on platforms which support it.
+  Alias for :js:func:`TXN.set_fc_tos()`.
 
-  :param class_txn txn: The class txn object containing the data.
-  :param integer mark: The mark value.
+  .. warning::
+     This function is deprecated. :js:func:`TXN.set_fc_tos()` must be used
+     instead.
 
 .. js:function:: TXN.set_priority_class(txn, prio)
 
@@ -3367,11 +3383,11 @@ Map class
   Note that :js:attr:`Map.reg` is also available for compatibility.
 
 
-.. js:function:: Map.new(file, method)
+.. js:function:: Map.new(name, method)
 
   Creates and load a map.
 
-  :param string file: Is the file containing the map.
+  :param string name: Is the name referencing the map.
   :param integer method: Is the map pattern matching method. See the attributes
    of the Map class.
   :returns: a class Map object.
@@ -3913,7 +3929,7 @@ Filter class
 
   This class contains return codes some filter callback functions may return. It
   also contains configuration flags and some helper functions. To understand how
-  the filter API works, see `doc/internal/filters.txt` documentation.
+  the filter API works, see `doc/internals/api/filters.txt` documentation.
 
 .. js:attribute:: filter.CONTINUE