RepoMirrors/haproxy
1
0
Fork 0
mirror of http://git.haproxy.org/git/haproxy.git/ synced 2025-02-17 02:56:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

DOC: lua: fix core.register_action typo

Browse Source 
"converter" was used in place of "action" as a result of a copy-paste
error probably.

Also, rephrasing the "actions" keyword explanation to prevent confusion
between action name (which is the name of new action about to be created)
and action facilities where we want to expose the new action.

This could be backported to every stable versions.
This commit is contained in:
Aurelien DARRAGON 2023-08-23 17:38:42 +02:00 committed by William Lallemand
parent 190f09a6ce
commit 7e9aea789f
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/lua-api/index.rst
View File

@ -490,11 +490,11 @@ Core class
used in HAProxy with the prefix "lua.". An action gets a TXN object class as used in HAProxy with the prefix "lua.". An action gets a TXN object class as
input. input.
:param string name: is the name of the converter. :param string name: is the name of the action.
:param table actions: is a table of string describing the HAProxy actions who :param table actions: is a table of string describing the HAProxy actions
want to register to. The expected actions are 'tcp-req', 'tcp-res', 'http-req' facilities where to expose the new action. Expected facilities are:
or 'http-res'. 'tcp-req', 'tcp-res', 'http-req' or 'http-res'.
:param function func: is the Lua function called to work as converter. :param function func: is the Lua function called to work as an action.
:param integer nb_args: is the expected number of argument for the action. :param integer nb_args: is the expected number of argument for the action.
By default the value is 0. By default the value is 0.