]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2237] Text edits
authorSuzanne Goldlust <sgoldlust@isc.org>
Mon, 13 Dec 2021 15:57:26 +0000 (15:57 +0000)
committerThomas Markwalder <tmark@isc.org>
Mon, 13 Dec 2021 18:54:45 +0000 (18:54 +0000)
platforms.rst

index e3863a81c9d9f78e92fd4788829a4cd2c9e4ceff..e4d1f681523f1837a50e5fb6f580e3bfc5950455 100644 (file)
@@ -1,10 +1,9 @@
-
 .. _platforms:
 
-Supported platforms
+Supported Platforms
 ===================
 
-In general, this version of Kea will build and run on any POSIX-compliant
+In general, this version of Kea builds and runs on any POSIX-compliant
 system with a C++ compiler (with C++11 support), the Botan cryptographic library,
 the log4cplus logging library and the Boost system library.
 
@@ -13,9 +12,9 @@ and Clang 800.0.38 and some later versions.
 
 ISC regularly tests Kea on many operating systems and architectures, but
 lacks the resources to test all of them. Consequently, ISC is only able to
-offer support on a "best effort" basis for some.
+offer support on a "best-effort" basis for some.
 
-Regularly tested platforms
+Regularly Tested Platforms
 --------------------------
 
 Kea is officially supported on Alpine, CentOS, Fedora, Ubuntu, Debian,
@@ -30,7 +29,7 @@ and FreeBSD systems. Kea-|release| builds have been tested on:
 
 There are currently no plans to port Kea to Windows systems.
 
-Best effort
+Best-Effort
 -----------
 
 The following are platforms on which Kea is known to build and run.
@@ -42,18 +41,18 @@ engineering staff, and other constraints.
 * FreeBSD - 11.4
 * macOS — 10.13, 10.14
 
-Community maintained
+Community-Maintained
 --------------------
 
 These systems may not all have the required dependencies for building Kea
-easily available, although it will be possible in many cases to compile
+easily available, although it is possible in many cases to compile
 those directly from source. The community and interested parties may wish
 to help with maintenance, and we welcome patch contributions, although we
-cannot guarantee that we will accept them.  All contributions will be
+cannot guarantee that we will accept them. All contributions are
 assessed against the risk of adverse effect on officially supported
 platforms.
 
-Platforms past their respective EOL dates, such as:
+These include platforms past their respective EOL dates, such as:
 
 * Alpine — 3.10 (1 May 2021)
 * CentOS — 6 (30 November 2020)
@@ -62,10 +61,10 @@ Platforms past their respective EOL dates, such as:
 * Debian — 8 (30 June 2020)
 * FreeBSD — 10 (31 October 2018)
 
-Unsupported platforms
+Unsupported Platforms
 ---------------------
 
-These are platforms on which Kea 1.7+ is known *not* to build or run:
+These are platforms on which versions of Kea since 1.7 are known *not* to build or run:
 
 * Windows (all versions)
 * Windows Server (all versions)
@@ -74,19 +73,19 @@ These are platforms on which Kea 1.7+ is known *not* to build or run:
 
 .. _required-software:
 
-Required Software at Run-Time
-=============================
+Required Software at Runtime
+============================
 
-Running Kea uses various extra software packages which may not be
+Kea uses various extra software packages which may not be
 provided in the default installation of some operating systems, nor in
-the standard package collections. You may need to install this required
-software separately. (For the build requirements, also see :ref:`build-requirements`.)
+the standard package collections. This required software may need to
+be installed separately. (For the build requirements, also see :ref:`build-requirements`.)
 
 -  Kea supports two cryptographic libraries: Botan and OpenSSL. Only one
    of them is required to be installed during compilation. Kea uses the
    Botan library for C++ (https://botan.randombit.net/), version 2.0 or
-   later. Note that support for Botan versions earlier than 2.0 was
-   removed in Kea 1.7.0 and later. As an alternative to Botan, Kea can
+   later; support for Botan versions earlier than 2.0 was
+   removed as of Kea 1.7.0. As an alternative to Botan, Kea can
    use the OpenSSL cryptographic library (https://www.openssl.org/),
    version 1.0.2 or later.
 
@@ -110,21 +109,22 @@ Some optional features of Kea have additional dependencies.
 
 -  To store lease information in a Cassandra database (CQL),
    Kea requires Cassandra headers and libraries. This is an optional
-   dependency; Kea can be built without Cassandra support.
+   dependency; Kea can be built without Cassandra support. (Cassandra
+   support is deprecated.)
 
--  Integration with RADIUS is provided in Kea via the hooks library
-   available to our paid support customers. Use of this library requires
-   the FreeRadius-client library to be present on the system where Kea
+-  Integration with RADIUS is provided in Kea via the hook library
+   available to ISC's paid support customers. Use of this library requires
+   the FreeRADIUS-client library to be present on the system where Kea
    is running. This is an optional dependency; Kea can be built
    without RADIUS support.
 
--  Kea provides a NETCONF interface with the kea-netconf agent. This Kea module
+-  Kea provides a NETCONF interface with the ``kea-netconf`` agent. This Kea module
    requires Sysrepo software when used. Building Kea with NETCONF support
    requires many dependencies to be installed, which are described in more
    detail in :ref:`netconf-install`. This is an optional dependency; Kea can be
    built without NETCONF support.
 
--  To sign and verify DNS updates, Kea DDNS server may use GSS-TSIG which requires
+-  To sign and verify DNS updates the Kea DDNS server may use GSS-TSIG, which requires
    MIT Kerberos 5 or Heimdal libraries. The dependencies required to be
    installed are described in more detail in :ref:`gss-tsig-install`. This is an
    optional dependency; Kea can be built without GSS-TSIG support.