From: Petr Špaček Date: Fri, 23 Oct 2020 15:34:31 +0000 (+0200) Subject: doc: document new command buffering scheme X-Git-Tag: v5.2.0~6^2~5 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=99e89bd69bb1f18453ebad19fe06e0612ce13161;p=thirdparty%2Fknot-resolver.git doc: document new command buffering scheme Fixup for c0b5faf222dfa6e8db94838c18331e7147a37128. --- diff --git a/doc/upgrading.rst b/doc/upgrading.rst index 09ec979df..2c6d14e14 100644 --- a/doc/upgrading.rst +++ b/doc/upgrading.rst @@ -18,9 +18,6 @@ Following section provides information about selected changes in not-yet-release We advise users to prepare for these changes sooner rather than later to make it easier to upgrade to newer versions when they are released. -* Users of :ref:`control-sockets` API need to terminate each command sent to resolver with newline - character (ASCII ``\n``). Correct usage: ``cache.stats()\n``. - Newline terminated commands are accepted by all resolver versions >= 1.0.0. * Human readable output from :ref:`control-sockets` is not stable and changes from time to time. Users who need machine readable output for scripts should use Lua function ``tojson()`` to convert Lua values into standard JSON format instead of attempting to parse @@ -38,6 +35,13 @@ newer versions when they are released. 5.1 to 5.2 ========== +Users +~~~~~ + +* Users of :ref:`control-sockets` API need to terminate each command sent to resolver with newline + character (ASCII ``\n``). Correct usage: ``cache.stats()\n``. + Newline terminated commands are accepted by all resolver versions >= 1.0.0. + Module changes -------------- * Reply packet :c:type:`kr_request.answer`