From: Maria Matejka <mq@ucw.cz>
Date: Sat, 25 Jan 2025 15:02:03 +0000 (+0100)
Subject: Merge branch 'mq-docs-to-markdown' into mq-docs-to-markdown-3
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fb49c11f1a1bf57d054167a98c59f3c8c3b3380b;p=thirdparty%2Fbird.git

Merge branch 'mq-docs-to-markdown' into mq-docs-to-markdown-3
---

fb49c11f1a1bf57d054167a98c59f3c8c3b3380b
diff --cc doc/bird.sgml
index a3563c666,6cd0098e1..cc15b07be
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@@ -774,49 -786,8 +774,49 @@@ to set options
  	server setups, running GC on hundreds of full BGP routing tables can
  	take significant amount of time, therefore they should use higher GC
  	periods. Default: adaptive, based on number of routing tables in the
- 	configuration. From 10 s (with <= 25 routing tables) up to 600 s (with
- 	>= 1500 routing tables).
+ 	configuration. From 10 s (with &lt;= 25 routing tables) up to 600 s (with
+ 	&gt;= 1500 routing tables).
 +
 +	<tag><label id="rtable-cork-threshold">cork threshold <m/number/ <m/number/</tag>
 +	Too many pending exports may lead to memory bloating. In such cases,
 +        BIRD tries to relieve the memory pressure by pausing some routines until
 +        the queue sizes get low enough. This option allows the user to set the
 +        thresholds; first value is the low threshold (when to resume), the
 +        second one is the high threshold (when to pause). The higher is the
 +        threshold, the more memory can get used. In most cases, the defaults
 +	should work for you but if you experience memory bloating on import
 +	surges, this knob is the first to turn down. Default: 333300 1011010.
 +
 +	<tag><label id="rtable-export-settle-time">export settle time <m/time/ <m/time/</tag>
 +	Minimum and maximum settle times, respectively, for export announcements.
 +	When multiple routes are changing, this mechanism waits for the changes
 +	to settle before waking up sleeping export threads but if the changes are coming
 +	steadily, BIRD isn't waiting forever; at most the maximum time.
 +	Default values: <cf/1 ms 100 ms/. You have to always provide both values.
 +
 +	<tag><label id="rtable-route-refresh-export-settle-time">route refresh export settle time <m/time/ <m/time/</tag>
 +	Minimum and maximum settle times, respectively, for export announcements
 +	(the same as above), valid when any channel is currently doing a route refresh.
 +	This serves a purpose of even more aggresive change bundling, knowing that there
 +	is some active process generating changes in a fast pace. If you don't want
 +	this feature, set this to the same values as <ref id="rtable-export-settle-time" name="export settle time">.
 +	Default values: <cf/100 ms 3 s/.
 +
 +	<tag><label id="rtable-digest-settle-time">digest settle time <m/time/ <m/time/</tag>
 +	Minimum and maximum settle times, respectively, for table change digests.
 +	This settle time applies to ROA table changes where a trie is generated
 +	containing all changed ROAs to automatically reload depending channels.
 +	Default values: <cf/1 s 20 s/.
 +
 +	<tag><label id="rtable-debug">debug all|off|{ states|routes|events [, <m/.../] }</tag>
 +	Set table debugging options. Each table can write some trace messages
 +	into log with category <cf/trace/. You can request <cf/all/ trace messages
 +	or select some types: <cf/states/ for table state changes and auxiliary
 +	processes, <cf/routes/ for auxiliary route notifications (next hop update,
 +        flowspec revalidation) and <cf/events/ for more detailed auxiliary routine
 +	debug. See also <ref id="channel-debug" name="channel debugging option">.
 +	Default: off.
 +
  </descrip>