From: Cyril Bonté Date: Tue, 22 Apr 2014 21:52:25 +0000 (+0200) Subject: DOC: fix fetching samples syntax X-Git-Tag: v1.5-dev23~7 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=62ba870f520abfeda0ce6515ab38751fa785c14e;p=thirdparty%2Fhaproxy.git DOC: fix fetching samples syntax The syntax used to document fetching samples with optional arguments was not always valid. This commit fixes this issue in order to allow an easier parsing of the documentation. --- diff --git a/doc/configuration.txt b/doc/configuration.txt index 76b093e70d..113818fa92 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -9741,7 +9741,7 @@ fe_id : integer backends to check from which backend it was called, or to stick all users coming via a same frontend to the same server. -sc_bytes_in_rate(,[]) : integer +sc_bytes_in_rate([,
]) : integer sc0_bytes_in_rate([
]) : integer sc1_bytes_in_rate([
]) : integer sc2_bytes_in_rate([
]) : integer @@ -9749,7 +9749,7 @@ sc2_bytes_in_rate([
]) : integer counters, measured in amount of bytes over the period configured in the table. See also src_bytes_in_rate. -sc_bytes_out_rate(,[
]) : integer +sc_bytes_out_rate([,
]) : integer sc0_bytes_out_rate([
]) : integer sc1_bytes_out_rate([
]) : integer sc2_bytes_out_rate([
]) : integer @@ -9757,7 +9757,7 @@ sc2_bytes_out_rate([
]) : integer counters, measured in amount of bytes over the period configured in the table. See also src_bytes_out_rate. -sc_clr_gpc0(,[
]) : integer +sc_clr_gpc0([,
]) : integer sc0_clr_gpc0([
]) : integer sc1_clr_gpc0([
]) : integer sc2_clr_gpc0([
]) : integer @@ -9775,14 +9775,14 @@ sc2_clr_gpc0([
]) : integer tcp-request connection accept if !abuse save tcp-request connection reject if abuse kill -sc_conn_cnt(,[
]) : integer +sc_conn_cnt([,
]) : integer sc0_conn_cnt([
]) : integer sc1_conn_cnt([
]) : integer sc2_conn_cnt([
]) : integer Returns the cumulated number of incoming connections from currently tracked counters. See also src_conn_cnt. -sc_conn_cur(,[
]) : integer +sc_conn_cur([,
]) : integer sc0_conn_cur([
]) : integer sc1_conn_cur([
]) : integer sc2_conn_cur([
]) : integer @@ -9790,7 +9790,7 @@ sc2_conn_cur([
]) : integer tracked counters. This number is automatically incremented when tracking begins and decremented when tracking stops. See also src_conn_cur. -sc_conn_rate(,[
]) : integer +sc_conn_rate([,
]) : integer sc0_conn_rate([
]) : integer sc1_conn_rate([
]) : integer sc2_conn_rate([
]) : integer @@ -9798,14 +9798,14 @@ sc2_conn_rate([
]) : integer measured in amount of connections over the period configured in the table. See also src_conn_rate. -sc_get_gpc0(,[
]) : integer +sc_get_gpc0([,
]) : integer sc0_get_gpc0([
]) : integer sc1_get_gpc0([
]) : integer sc2_get_gpc0([
]) : integer Returns the value of the first General Purpose Counter associated to the currently tracked counters. See also src_get_gpc0 and sc/sc0/sc1/sc2_inc_gpc0. -sc_gpc0_rate(,[
]) : integer +sc_gpc0_rate([,
]) : integer sc0_gpc0_rate([
]) : integer sc1_gpc0_rate([
]) : integer sc2_gpc0_rate([
]) : integer @@ -9816,7 +9816,7 @@ sc2_gpc0_rate([
]) : integer that the "gpc0_rate" counter must be stored in the stick-table for a value to be returned, as "gpc0" only holds the event count. -sc_http_err_cnt(,[
]) : integer +sc_http_err_cnt([,
]) : integer sc0_http_err_cnt([
]) : integer sc1_http_err_cnt([
]) : integer sc2_http_err_cnt([
]) : integer @@ -9824,7 +9824,7 @@ sc2_http_err_cnt([
]) : integer counters. This includes the both request errors and 4xx error responses. See also src_http_err_cnt. -sc_http_err_rate(,[
]) : integer +sc_http_err_rate([,
]) : integer sc0_http_err_rate([
]) : integer sc1_http_err_rate([
]) : integer sc2_http_err_rate([
]) : integer @@ -9833,7 +9833,7 @@ sc2_http_err_rate([
]) : integer includes the both request errors and 4xx error responses. See also src_http_err_rate. -sc_http_req_cnt(,[
]) : integer +sc_http_req_cnt([,
]) : integer sc0_http_req_cnt([
]) : integer sc1_http_req_cnt([
]) : integer sc2_http_req_cnt([
]) : integer @@ -9841,7 +9841,7 @@ sc2_http_req_cnt([
]) : integer counters. This includes every started request, valid or not. See also src_http_req_cnt. -sc_http_req_rate(,[
]) : integer +sc_http_req_rate([,
]) : integer sc0_http_req_rate([
]) : integer sc1_http_req_rate([
]) : integer sc2_http_req_rate([
]) : integer @@ -9850,7 +9850,7 @@ sc2_http_req_rate([
]) : integer the table. This includes every started request, valid or not. See also src_http_req_rate. -sc_inc_gpc0(,[
]) : integer +sc_inc_gpc0([,
]) : integer sc0_inc_gpc0([
]) : integer sc1_inc_gpc0([
]) : integer sc2_inc_gpc0([
]) : integer @@ -9864,7 +9864,7 @@ sc2_inc_gpc0([
]) : integer acl kill sc0_inc_gpc0 gt 0 tcp-request connection reject if abuse kill -sc_kbytes_in(,[
]) : integer +sc_kbytes_in([,
]) : integer sc0_kbytes_in([
]) : integer sc1_kbytes_in([
]) : integer sc2_kbytes_in([
]) : integer @@ -9873,7 +9873,7 @@ sc2_kbytes_in([
]) : integer test is currently performed on 32-bit integers, which limits values to 4 terabytes. See also src_kbytes_in. -sc_kbytes_out(,[
]) : integer +sc_kbytes_out([,
]) : integer sc0_kbytes_out([
]) : integer sc1_kbytes_out([
]) : integer sc2_kbytes_out([
]) : integer @@ -9882,7 +9882,7 @@ sc2_kbytes_out([
]) : integer test is currently performed on 32-bit integers, which limits values to 4 terabytes. See also src_kbytes_out. -sc_sess_cnt(,[
]) : integer +sc_sess_cnt([,
]) : integer sc0_sess_cnt([
]) : integer sc1_sess_cnt([
]) : integer sc2_sess_cnt([
]) : integer @@ -9893,7 +9893,7 @@ sc2_sess_cnt([
]) : integer backend sessions if some HTTP keep-alive is performed over the connection with the client. See also src_sess_cnt. -sc_sess_rate(,[
]) : integer +sc_sess_rate([,
]) : integer sc0_sess_rate([
]) : integer sc1_sess_rate([
]) : integer sc2_sess_rate([
]) : integer @@ -9904,7 +9904,7 @@ sc2_sess_rate([
]) : integer connection could result in many backend sessions if some HTTP keep-alive is performed over the connection with the client. See also src_sess_rate. -sc_tracked(,[
]) : boolean +sc_tracked([,
]) : boolean sc0_tracked([
]) : boolean sc1_tracked([
]) : boolean sc2_tracked([
]) : boolean @@ -9912,7 +9912,7 @@ sc2_tracked([
]) : boolean the current session. This can be useful when deciding whether or not we want to set some values in a header passed to the server. -sc_trackers(,[
]) : integer +sc_trackers([,
]) : integer sc0_trackers([
]) : integer sc1_trackers([
]) : integer sc2_trackers([
]) : integer