Skip to content

Commit f1df002

Browse files
author
HAProxy Community
committed
Update docs for dev
1 parent f76aacb commit f1df002

File tree

3 files changed

+41
-13
lines changed

3 files changed

+41
-13
lines changed

docs/dev/configuration.html

Lines changed: 33 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.2-dev4-3 - Configuration Manual</title>
5+
<title>HAProxy version 3.2-dev4-5 - 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" />
@@ -4093,6 +4093,8 @@
40934093

40944094
<a class="list-group-item" href="#tune.disable-zero-copy-forwarding">tune.disable-zero-copy-forwarding</a>
40954095

4096+
<a class="list-group-item" href="#tune.epoll.mask-events">tune.epoll.mask-events</a>
4097+
40964098
<a class="list-group-item" href="#tune.events.max-events-at-once">tune.events.max-events-at-once</a>
40974099

40984100
<a class="list-group-item" href="#tune.fail-alloc">tune.fail-alloc</a>
@@ -4448,7 +4450,7 @@
44484450
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
44494451
</p>
44504452
<p class="text-right">
4451-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/24</b></small>
4453+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/27</b></small>
44524454
</p>
44534455
</div>
44544456
<!-- /.sidebar -->
@@ -4459,7 +4461,7 @@
44594461
<div class="text-center">
44604462
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
44614463
<h2>Configuration Manual</h2>
4462-
<p><strong>version 3.2-dev4-3</strong></p>
4464+
<p><strong>version 3.2-dev4-5</strong></p>
44634465
<p>
44644466
2025/01/24<br>
44654467

@@ -7181,6 +7183,7 @@ <h2 id="chapter-2.9" data-target="2.9"><small><a class="small" href="#2.9">2.9.<
71817183
- <a href="#tune.comp.maxlevel">tune.comp.maxlevel</a>
71827184
- <a href="#tune.disable-fast-forward">tune.disable-fast-forward</a>
71837185
- <a href="#tune.disable-zero-copy-forwarding">tune.disable-zero-copy-forwarding</a>
7186+
- <a href="#tune.epoll.mask-events">tune.epoll.mask-events</a>
71847187
- <a href="#tune.events.max-events-at-once">tune.events.max-events-at-once</a>
71857188
- <a href="#tune.fail-alloc">tune.fail-alloc</a>
71867189
- <a href="#tune.fd.edge-triggered">tune.fd.edge-triggered</a>
@@ -8802,7 +8805,32 @@ <h2 id="chapter-3.2" data-target="3.2"><small><a class="small" href="#3.2">3.2.<
88028805
Thanks to this directive, it is possible to disable this optimization. Note
88038806
it also disable any kernel tcp splicing.
88048807
</pre><div class="page-header"><b>See also:</b> tune.pt.zero-copy-forwarding, tune.applet.zero-copy-forwarding, tune.h1.zero-copy-fwd-recv, tune.h1.zero-copy-fwd-send, tune.h2.zero-copy-fwd-send, tune.quic.zero-copy-fwd-send</div>
8805-
<a class="anchor" name="tune.events.max-events-at-once"></a><a class="anchor" name="3-tune.events.max-events-at-once"></a><a class="anchor" name="3.2-tune.events.max-events-at-once"></a><a class="anchor" name="tune.events.max-events-at-once (Global parameters)"></a><a class="anchor" name="tune.events.max-events-at-once (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.events.max-events-at-once"></a><a href="#3.2-tune.events.max-events-at-once">tune.events.max-events-at-once</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the number of events that may be processed at once by an asynchronous
8808+
<a class="anchor" name="tune.epoll.mask-events"></a><a class="anchor" name="3-tune.epoll.mask-events"></a><a class="anchor" name="3.2-tune.epoll.mask-events"></a><a class="anchor" name="tune.epoll.mask-events (Global parameters)"></a><a class="anchor" name="tune.epoll.mask-events (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.epoll.mask-events"></a><a href="#3.2-tune.epoll.mask-events">tune.epoll.mask-events</a></b> <span style="color: #080">&lt;event<span style="color: #008">[,...]</span>&gt;</span></div><pre class="text">Along HAProxy's history, a few complex issues were met that were caused by
8809+
bugs in the epoll mechanism in the Linux kernel. These ones usually are very
8810+
rare and unreproducible outside the reporter's environment, and may only be
8811+
worked around by disabling epoll and switching to poll instead, which is not
8812+
very satisfying for high performance environments. Each time, issues affect
8813+
only very specific (and rare) event types, and offering the ability to mask
8814+
them can constitute a more acceptable work-around. This options offers this
8815+
possibility by permitting to silently ignore events a few uncommon events
8816+
and replace them with an input (which reports an unspecified incoming event).
8817+
The effect is to avoid the fast error processing paths in certain places and
8818+
only use the common paths. This should never be used unless being invited to
8819+
do so by an expert in order to diagnose or work around a kernel bug.
8820+
8821+
The option takes a single argument which is a comma-delimited list of words
8822+
each designating an event to be masked. The currently supported list of
8823+
events is:
8824+
- &quot;err&quot;: mask the EPOLLERR event
8825+
- &quot;hup&quot;: mask the EPOLLHUP events
8826+
- &quot;rdhup&quot;: mask the EPOLLRDHUP events
8827+
</pre><div class="separator">
8828+
<span class="label label-success">Example:</span>
8829+
<pre class="prettyprint">
8830+
<code><span class="comment"># mask all non-traffic epoll events:</span>
8831+
tune.epoll.mask-events err,hup,rdhup
8832+
</code></pre>
8833+
</div><a class="anchor" name="tune.events.max-events-at-once"></a><a class="anchor" name="3-tune.events.max-events-at-once"></a><a class="anchor" name="3.2-tune.events.max-events-at-once"></a><a class="anchor" name="tune.events.max-events-at-once (Global parameters)"></a><a class="anchor" name="tune.events.max-events-at-once (Performance tuning)"></a><div class="keyword"><b><a class="anchor" name="tune.events.max-events-at-once"></a><a href="#3.2-tune.events.max-events-at-once">tune.events.max-events-at-once</a></b> <span style="color: #080">&lt;number&gt;</span></div><pre class="text">Sets the number of events that may be processed at once by an asynchronous
88068834
task handler (from event_hdl API). &lt;number&gt; should be included between 1
88078835
and 10000. Large number could cause thread contention as a result of the
88088836
task doing heavy work without interruption, and on the other hand, small
@@ -31764,7 +31792,7 @@ <h2 id="chapter-11.3" data-target="11.3"><small><a class="small" href="#11.3">11
3176431792
<br>
3176531793
<hr>
3176631794
<div class="text-right">
31767-
HAProxy 3.2-dev4-3 &ndash; Configuration Manual<br>
31795+
HAProxy 3.2-dev4-5 &ndash; Configuration Manual<br>
3176831796
<small>, 2025/01/24</small>
3176931797
</div>
3177031798
</div>

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.2-dev4-3 - Starter Guide</title>
5+
<title>HAProxy version 3.2-dev4-5 - 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>2025/01/24</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>2025/01/27</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.2-dev4-3</strong></p>
498+
<p><strong>version 3.2-dev4-5</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.2-dev4-3 &ndash; Starter Guide<br>
2518+
HAProxy 3.2-dev4-5 &ndash; Starter Guide<br>
25192519
<small>, </small>
25202520
</div>
25212521
</div>

docs/dev/management.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.2-dev4-3 - Management Guide</title>
5+
<title>HAProxy version 3.2-dev4-5 - 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" />
@@ -654,7 +654,7 @@
654654
You can use <strong>left</strong> and <strong>right</strong> arrow keys to navigate between chapters.<br>
655655
</p>
656656
<p class="text-right">
657-
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/24</b></small>
657+
<small>Converted with <a href="https://github.com/cbonte/haproxy-dconv">haproxy-dconv</a> v<b>0.4.2-15</b> on <b>2025/01/27</b></small>
658658
</p>
659659
</div>
660660
<!-- /.sidebar -->
@@ -665,7 +665,7 @@
665665
<div class="text-center">
666666
<h1><a href="http://www.haproxy.org/" title="HAProxy"><img src="../img/HAProxyCommunityEdition_60px.png?0.4.2-15" /></a></h1>
667667
<h2>Management Guide</h2>
668-
<p><strong>version 3.2-dev4-3</strong></p>
668+
<p><strong>version 3.2-dev4-5</strong></p>
669669
<p>
670670
<br>
671671

@@ -5455,7 +5455,7 @@ <h2 id="chapter-13.1" data-target="13.1"><small><a class="small" href="#13.1">13
54555455
<br>
54565456
<hr>
54575457
<div class="text-right">
5458-
HAProxy 3.2-dev4-3 &ndash; Management Guide<br>
5458+
HAProxy 3.2-dev4-5 &ndash; Management Guide<br>
54595459
<small>, </small>
54605460
</div>
54615461
</div>

0 commit comments

Comments
 (0)