From: Katerina Kubecova <katerina.kubecova@nic.cz>
Date: Wed, 15 Jan 2025 12:06:16 +0000 (+0100)
Subject: Documentation: show memory decription
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=1f881778d4a3363814e9499a132b0a67a9096bb3;p=thirdparty%2Fbird.git

Documentation: show memory decription
---

diff --git a/doc/bird.sgml b/doc/bird.sgml
index a3563c666..9133f743b 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -1317,6 +1317,10 @@ This argument can be omitted if there exists only a single instance.
 	Show router status, that is BIRD version, uptime and time from last
 	reconfiguration.
 
+        <tag><label id="cli-show-status">show memory</tag>
+	Show BIRD memory. BIRD does not stop other computations in order to measure
+	the used memory, hence the measured memory usage may differ from the real memory usage.
+
 	<tag><label id="cli-show-interfaces">show interfaces [summary]</tag>
 	Show the list of interfaces. For each interface, print its type, state,
 	MTU and addresses assigned.