[#1055] platforms.rst file updated

diff --git a/doc/sphinx/arm/intro.rst b/doc/sphinx/arm/intro.rst
index da447d845772ef24266e1ecd98284a9759678369..c85103f7ff1e37a5a69ca0340f5109c908787d64 100644 (file)
--- a/doc/sphinx/arm/intro.rst
+++ b/doc/sphinx/arm/intro.rst
@@ -10,7 +10,9 @@ e.g. prefix delegation and dynamic updates to DNS.
 
 This guide covers Kea version |release|.
 
-For information about supported platforms see <insert reference>.
+For information about supported platforms see :ref:`platforms`.
+
+.. include:: platforms.rst
 
 .. _kea_software:
 

diff --git a/doc/sphinx/conf.py b/doc/sphinx/conf.py
index abe7a3aca93f1a23104647be4561f0f7570f4602..9d2a6026295deeedc72bdf9956d3abcfea3ca3f6 100644 (file)
--- a/doc/sphinx/conf.py
+++ b/doc/sphinx/conf.py
@@ -74,6 +74,7 @@ language = None
 exclude_patterns = [
     '_build', 'Thumbs.db', '.DS_Store',
     # included files need to be excluded to avoid duplicate labels
+    'arm/platforms.rst',
     'arm/hooks-bootp.rst',
     'arm/hooks-class-cmds.rst',
     'arm/hooks-cb-cmds.rst',

diff --git a/platforms.rst b/platforms.rst
index 6b11525e39747a9c4a6cdf6f73f47cd1e6998d4a..6f12a8bf572a48d448938accfc5a436187f89421 100644 (file)
--- a/platforms.rst
+++ b/platforms.rst
@@ -1,14 +1,8 @@
-<!--
- - Copyright (C) Internet Systems Consortium, Inc. ("ISC")
- -
- - This Source Code Form is subject to the terms of the Mozilla Public
- - License, v. 2.0. If a copy of the MPL was not distributed with this
- - file, You can obtain one at http://mozilla.org/MPL/2.0/.
- -
- - See the COPYRIGHT file distributed with this work for additional
- - information regarding copyright ownership.
--->
-## Supported platforms
+
+.. _platforms:
+
+Supported platforms
+===================
 
 In general, this version of Kea will build and run on any POSIX-compliant
 system with a C++ compiler (with C++11 support), the Botan cryptographic library, 
@@ -17,6 +11,63 @@ the log4cplus logging library and the Boost system library.
 The Kea build has been checked with GCC g++ 4.8.5 and some later versions,
 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.
+
+Regularly tested platforms
+--------------------------
+
+As of January, 2020, Kea is officially supported on CentOS, Fedora, Ubuntu, Debian, and
+FreeBSD systems. Kea-|release| builds have been tested on:
+
+* CentOS Linux — 7, 8
+* Fedora — 30, 31
+* Ubuntu — 16.04, 18.04, 19.04
+* Debian GNU/Linux — 9, 10
+
+There are currently no plans to port Kea to Windows systems.
+
+Best effort
+-----------
+
+The following are platforms on which Kea is known to build and run.
+ISC makes every effort to fix bugs on these platforms, but may be unable to
+do so quickly due to lack of hardware, less familiarity on the part of
+engineering staff, and other constraints. 
+
+* FreeBSD — 11.3, 12.0
+* Alpine Linux — 3.10
+* macOS — 10.13, 10.14
+
+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
+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
+assessed against the risk of adverse effect on officially supported
+platforms.
+
+* Platforms past or close to their respective EOL dates, such as:
+    * Ubuntu 14.04, 18.10
+    * CentOS 6
+    * Debian Jessie
+    * FreeBSD 10.x
+
+Unsupported platforms
+---------------------
+
+These are platforms on which Kea 1.7+ is known *not* to build or run:
+
+* Windows (all versions)
+* Windows Server (all versions)
+* Any platform with OpenSSL 1.0.1 or earlier, which does not also have Botan as an alternative
+* Any platform with log4cplus version 1.0.2 or earlier.
+
+.. _required-software:
 
 Required Software at Run-Time
 =============================
@@ -68,60 +119,4 @@ Some optional features of Kea have additional dependencies.
    requires many dependencies to be installed, which are described in
    more detail in :ref:`netconf-install`.
 
----
-
-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.
-
-
-### Regularly tested platforms
-
-As of January, 2020, Kea is officially supported on CentOS, Fedora, Ubuntu, Debian, and
-FreeBSD systems. Kea-|release| builds have been tested on:
-
-* CentOS Linux — 7, 8
-* Fedora — 30, 31
-* Ubuntu — 16.04, 18.04, 19.04
-* Debian GNU/Linux — 9, 10
-
-There are currently no plans to port Kea to Windows systems.
-
-
-### Best effort
-
-The following are platforms on which Kea is known to build and run.
-ISC makes every effort to fix bugs on these platforms, but may be unable to
-do so quickly due to lack of hardware, less familiarity on the part of
-engineering staff, and other constraints. 
-
-* FreeBSD — 11.3, 12.0
-* Alpine Linux — 3.10
-* macOS — 10.13, 10.14
-
-    
-
-### 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
-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
-assessed against the risk of adverse effect on officially supported
-platforms.
-
-* Platforms past or close to their respective EOL dates, such as:
-    * Ubuntu 14.04, 18.10
-    * CentOS 6
-    * Debian Jessie
-    * FreeBSD 10.x
-
-## Unsupported platforms
-
-These are platforms on which Kea 1.7+ is known *not* to build or run:
-
-* Windows (all versions)
-* Windows Server (all versions)
-* Any platform with OpenSSL 1.01 or earlier, which does not also have Botan as an alternative
-* Any platform with log4cplus version 1.0.2 or earlier.
\ No newline at end of file
+