From 7e9f283759afc3afaa0a3945001fdff379e6efee Mon Sep 17 00:00:00 2001 From: Remi Gacogne Date: Tue, 25 Aug 2020 10:47:25 +0200 Subject: [PATCH] dnsdist: Dcocument the new 'clearConsoleHistory()' command --- pdns/dnsdistdist/docs/reference/config.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/pdns/dnsdistdist/docs/reference/config.rst b/pdns/dnsdistdist/docs/reference/config.rst index 3dee111fa4..ab594888fb 100644 --- a/pdns/dnsdistdist/docs/reference/config.rst +++ b/pdns/dnsdistdist/docs/reference/config.rst @@ -232,6 +232,14 @@ Control Socket, Console and Webserver :param str netmask: A CIDR netmask, e.g. ``"192.0.2.0/24"``. Without a subnetmask, only the specific address is allowed. +.. function:: clearConsoleHistory() + + .. versionadded:: 1.6.0 + + Clear the internal (in-memory) buffers of console commands. These buffers are used to provide the :func:`delta` command and + console completion and history, and can end up being quite large when a lot of commands are issued via the console, consuming + a noticeable amount of memory. + .. function:: controlSocket(address) Bind to ``addr`` and listen for a connection for the console. Since 1.3.0 only connections from local users are allowed @@ -241,6 +249,10 @@ Control Socket, Console and Webserver :param str address: An IP address with optional port. By default, the port is 5199. +.. function:: delta() + + Issuing `delta` on the console will print the changes to the configuration that have been made since startup. + .. function:: inClientStartup() Returns true while the console client is parsing the configuration. -- 2.47.2