From: Andrei Pavel <andrei@isc.org>
Date: Fri, 28 Apr 2023 07:24:04 +0000 (+0300)
Subject: [#2658] document big integer statistics
X-Git-Tag: Kea-2.3.8~131
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=37da13e46fbe98330b1348e77244dee6aa01cb89;p=thirdparty%2Fkea.git

[#2658] document big integer statistics
---

diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst
index 4ca0b227df..28dfe0f429 100644
--- a/doc/sphinx/arm/dhcp6-srv.rst
+++ b/doc/sphinx/arm/dhcp6-srv.rst
@@ -6540,7 +6540,7 @@ The DHCPv6 server supports the following statistics:
    |                                              |                | are certain cases where there is   |
    |                                              |                | no response.                       |
    +----------------------------------------------+----------------+------------------------------------+
-   | subnet[id].total-nas                         | integer        | Total number of NA addresses       |
+   | subnet[id].total-nas                         | big integer    | Total number of NA addresses       |
    |                                              |                | available for DHCPv6 management    |
    |                                              |                | for a given subnet; in other       |
    |                                              |                | words, this is the sum of all      |
@@ -6587,7 +6587,7 @@ The DHCPv6 server supports the following statistics:
    |                                              |                | subnet separately, and is reset    |
    |                                              |                | during a reconfiguration event.    |
    +----------------------------------------------+----------------+------------------------------------+
-   | subnet[id].total-pds                         | integer        | Total number of PD prefixes        |
+   | subnet[id].total-pds                         | big integer    | Total number of PD prefixes        |
    |                                              |                | available for DHCPv6 management    |
    |                                              |                | for a given subnet; in other       |
    |                                              |                | words, this is the sum of all      |
diff --git a/doc/sphinx/arm/stats.rst b/doc/sphinx/arm/stats.rst
index 4c59a29f17..289d4dd92c 100644
--- a/doc/sphinx/arm/stats.rst
+++ b/doc/sphinx/arm/stats.rst
@@ -26,6 +26,10 @@ There are four types of statistics:
    64-bit integer (int64_t in C++), so it can hold any value between
    -2^63 to 2^63-1.
 
+-  *big integer* - this type is inteded for holding large numbers. It is
+   implemented as a 128-bit integer (boost::multiprecision::int128_t in C++), so
+   it can hold any value between -2^127 to 2^127-1.
+
 -  *floating point* - this type is intended to store floating-point
    precision. It is implemented as a C++ double type.