Skip to content

Commit 649e2c3

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent dd373bf commit 649e2c3

File tree

3 files changed

+51
-15
lines changed

3 files changed

+51
-15
lines changed

docs/dev/configuration.html

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1-dev12-14 - Configuration Manual</title>
5+
<title>HAProxy version 3.1-dev13 - Configuration Manual</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -4416,7 +4416,7 @@
44164416
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44174417
</p>
44184418
<p class="text-right">
4419-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/08</b></small>
4419+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/15</b></small>
44204420
</p>
44214421
</div>
44224422
<!-- /.sidebar -->
@@ -4427,9 +4427,9 @@
44274427
<div class="text-center">
44284428
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44294429
<h2>Configuration Manual</h2>
4430-
<p><strong>version 3.1-dev12-14</strong></p>
4430+
<p><strong>version 3.1-dev13</strong></p>
44314431
<p>
4432-
2024/11/08<br>
4432+
2024/11/15<br>
44334433

44344434
</p>
44354435
</div>
@@ -6991,10 +6991,12 @@ <h2 id="chapter-2.9" data-target="2.9"><small><a class="small" href="#2.9">2.9.<
69916991
- <a href="#tune.h2.be.glitches-threshold">tune.h2.be.glitches-threshold</a>
69926992
- <a href="#tune.h2.be.initial-window-size">tune.h2.be.initial-window-size</a>
69936993
- <a href="#tune.h2.be.max-concurrent-streams">tune.h2.be.max-concurrent-streams</a>
6994+
- <a href="#tune.h2.be.rxbuf">tune.h2.be.rxbuf</a>
69946995
- <a href="#tune.h2.fe.glitches-threshold">tune.h2.fe.glitches-threshold</a>
69956996
- <a href="#tune.h2.fe.initial-window-size">tune.h2.fe.initial-window-size</a>
69966997
- <a href="#tune.h2.fe.max-concurrent-streams">tune.h2.fe.max-concurrent-streams</a>
69976998
- <a href="#tune.h2.fe.max-total-streams">tune.h2.fe.max-total-streams</a>
6999+
- <a href="#tune.h2.fe.rxbuf">tune.h2.fe.rxbuf</a>
69987000
- <a href="#tune.h2.header-table-size">tune.h2.header-table-size</a>
69997001
- <a href="#tune.h2.initial-window-size">tune.h2.initial-window-size</a>
70007002
- <a href="#tune.h2.max-concurrent-streams">tune.h2.max-concurrent-streams</a>
@@ -31442,8 +31444,8 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3144231444
<br>
3144331445
<hr>
3144431446
<div class="text-right">
31445-
HAProxy 3.1-dev12-14 &ndash; Configuration Manual<br>
31446-
<small>, 2024/11/08</small>
31447+
HAProxy 3.1-dev13 &ndash; Configuration Manual<br>
31448+
<small>, 2024/11/15</small>
3144731449
</div>
3144831450
</div>
3144931451
<!-- /.col-lg-12 -->

docs/dev/intro.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1-dev12-14 - Starter Guide</title>
5+
<title>HAProxy version 3.1-dev13 - Starter Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -484,7 +484,7 @@
484484
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
485485
</p>
486486
<p class="text-right">
487-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/08</b></small>
487+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/15</b></small>
488488
</p>
489489
</div>
490490
<!-- /.sidebar -->
@@ -495,7 +495,7 @@
495495
<div class="text-center">
496496
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
497497
<h2>Starter Guide</h2>
498-
<p><strong>version 3.1-dev12-14</strong></p>
498+
<p><strong>version 3.1-dev13</strong></p>
499499
<p>
500500
<br>
501501

@@ -2515,7 +2515,7 @@ <h2 id="chapter-4.4" data-target="4.4"><small><a class="small" href="#4.4">4.4.<
25152515
<br>
25162516
<hr>
25172517
<div class="text-right">
2518-
HAProxy 3.1-dev12-14 &ndash; Starter Guide<br>
2518+
HAProxy 3.1-dev13 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/dev/management.html

Lines changed: 39 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
<html lang="en">
33
<head>
44
<meta charset="utf-8" />
5-
<title>HAProxy version 3.1-dev12-14 - Management Guide</title>
5+
<title>HAProxy version 3.1-dev13 - Management Guide</title>
66
<link href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.7/css/bootstrap.min.css" rel="stylesheet" />
77
<link href="https://raw.githubusercontent.com/thomaspark/bootswatch/v3.3.7/cerulean/bootstrap.min.css" rel="stylesheet" />
88
<link href="../css/page.css?0.4.2-15" rel="stylesheet" />
@@ -307,6 +307,8 @@
307307

308308
<a class="list-group-item" href="#debug">debug</a>
309309

310+
<a class="list-group-item" href="#debug counters">debug counters</a>
311+
310312
<a class="list-group-item" href="#debug dev">debug dev</a>
311313

312314
<a class="list-group-item" href="#del">del</a>
@@ -513,7 +515,9 @@
513515

514516
<a class="list-group-item" href="#set weight">set weight</a>
515517

516-
<a class="list-group-item" href="#show">show</a>
518+
<a class="list-group-item" href="#show (Unix Socket commands)">show (Unix Socket commands)</a>
519+
520+
<a class="list-group-item" href="#show (Master CLI commands)">show (Master CLI commands)</a>
517521

518522
<a class="list-group-item" href="#show acl">show acl</a>
519523

@@ -648,7 +652,7 @@
648652
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
649653
</p>
650654
<p class="text-right">
651-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/08</b></small>
655+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2024/11/15</b></small>
652656
</p>
653657
</div>
654658
<!-- /.sidebar -->
@@ -659,7 +663,7 @@
659663
<div class="text-center">
660664
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
661665
<h2>Management Guide</h2>
662-
<p><strong>version 3.1-dev12-14</strong></p>
666+
<p><strong>version 3.1-dev13</strong></p>
663667
<p>
664668
<br>
665669

@@ -2778,6 +2782,36 @@ <h2 id="chapter-9.3" data-target="9.3"><small><a class="small" href="#9.3">9.3.<
27782782

27792783
See also &quot;<a href="#new%20ssl%20crl-file">new ssl crl-file</a>&quot;, &quot;<a href="#set%20ssl%20crl-file">set ssl crl-file</a>&quot;, &quot;<a href="#abort%20ssl%20crl-file">abort ssl crl-file</a>&quot; and
27802784
&quot;<a href="#add%20ssl%20crt-list">add ssl crt-list</a>&quot;.
2785+
</pre><a class="anchor" name="debug"></a><a class="anchor" name="9-debug"></a><a class="anchor" name="9.3-debug"></a><a class="anchor" name="debug (Statistics and monitoring)"></a><a class="anchor" name="debug (Unix Socket commands)"></a><a class="anchor" name="debug counters"></a><a class="anchor" name="9-debug counters"></a><a class="anchor" name="9.3-debug counters"></a><a class="anchor" name="debug counters (Statistics and monitoring)"></a><a class="anchor" name="debug counters (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="debug counters"></a><a href="#9.3-debug%20counters">debug counters</a></b> <span style="color: #008">[reset|show|all|bug|chk|cnt|glt|?]</span>*</div><pre class="text">List internal counters placed in the code, which may vary depending on some
2786+
build options. Some of them depend on DEBUG_STRICT, others on DEBUG_GLITCHES.
2787+
The command takes a combination of multiple arguments, some defining actions
2788+
and others defining filters:
2789+
- bug enables listing the counters for BUG_ON() statements
2790+
- cnt enables listing the counters for COUNT_IF() statements
2791+
- chk enables listing the counters for CHECK_IF() statements
2792+
- glt enables listing the counters for COUNT_GLITCH() statements
2793+
- all enables showing counters that never triggered (value 0)
2794+
- reset action: resets all specified counters
2795+
- show action: shows all specified counters
2796+
2797+
By default, the action is &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">show<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#show%20%28Unix%20Socket%20commands%29">Unix Socket commands</a></li><li><a href="#show%20%28Master%20CLI%20commands%29">Master CLI commands</a></li></ul></span>&quot; to show counters, and the listed counters
2798+
are all types with a non-zero value. The &quot;<span class="dropdown"><a class="dropdown-toggle" data-toggle="dropdown" href="#">show<span class="caret"></span></a><ul class="dropdown-menu"><li class="dropdown-header">This keyword is available in sections :</li><li><a href="#show%20%28Unix%20Socket%20commands%29">Unix Socket commands</a></li><li><a href="#show%20%28Master%20CLI%20commands%29">Master CLI commands</a></li></ul></span>&quot; command is implicit when no
2799+
other action is specified, and is only present to ease the production of
2800+
commands from scripts.
2801+
2802+
The output starts with an integer counter, followed by the type of the
2803+
counter in upper case, then its location in the code (file:line), the
2804+
function name, and optionally &quot;: &quot; followed by a description. Please note
2805+
that the output format might change between major versions, and new types
2806+
and entries might be backported to stable versions for the purpose of
2807+
improved debugging capabilities. Any monitoring performed on them should
2808+
only be done in a very lenient and permissive way, and preferably not.
2809+
2810+
Normally, end users will not use this command, but they may be invited to do
2811+
so by a developer trying to figure the cause of an issue, looking for CNT or
2812+
GLT entries. By the way, non-zero &quot;CHK&quot; entries are not expected to happen
2813+
and should be reported to developers as they might indicate some incorrect
2814+
assumptions in the code.
27812815
</pre><a class="anchor" name="debug"></a><a class="anchor" name="9-debug"></a><a class="anchor" name="9.3-debug"></a><a class="anchor" name="debug (Statistics and monitoring)"></a><a class="anchor" name="debug (Unix Socket commands)"></a><a class="anchor" name="debug dev"></a><a class="anchor" name="9-debug dev"></a><a class="anchor" name="9.3-debug dev"></a><a class="anchor" name="debug dev (Statistics and monitoring)"></a><a class="anchor" name="debug dev (Unix Socket commands)"></a><div class="keyword"><b><a class="anchor" name="debug dev"></a><a href="#9.3-debug%20dev">debug dev</a></b> <span style="color: #080">&lt;command&gt;</span> <span style="color: #008">[args]</span>*</div><pre class="text">Call a developer-specific command. Only supported on a CLI connection running
27822816
in expert mode (see &quot;expert-mode on&quot;). Such commands are extremely dangerous
27832817
and not forgiving, any misuse may result in a crash of the process. They are
@@ -5352,7 +5386,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
53525386
<br>
53535387
<hr>
53545388
<div class="text-right">
5355-
HAProxy 3.1-dev12-14 &ndash; Management Guide<br>
5389+
HAProxy 3.1-dev13 &ndash; Management Guide<br>
53565390
<small>, </small>
53575391
</div>
53585392
</div>

0 commit comments

Comments
 (0)