]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#2139] Text edits
authorSuzanne Goldlust <sgoldlust@isc.org>
Fri, 5 Nov 2021 21:25:06 +0000 (21:25 +0000)
committerThomas Markwalder <tmark@isc.org>
Thu, 11 Nov 2021 19:58:02 +0000 (14:58 -0500)
doc/sphinx/arm/hooks-bootp.rst

index a41379c2afefc791a8457a491ad327e89411cde0..57e898ae7df0869043396e1c313aa262ff11b770 100644 (file)
@@ -8,20 +8,20 @@ BOOTP Support
    This library is still in the experimental phase. Use with care!
 
 
-This hooks library adds support for BOOTP with vendor information extensions
+This hook library adds support for BOOTP with vendor-information extensions
 (`RFC 1497 <https://tools.ietf.org/html/rfc1497>`__). Received BOOTP
 requests are recognized, translated into DHCPREQUEST packets by adding
-a dhcp-message-type option and put into the "BOOTP" client class.
+a ``dhcp-message-type`` option, and put into the "BOOTP" client class.
 Members of this class get infinite lifetime leases but the class can
-be used too for instance to guard a pool of addresses.
+also be used to guard a pool of addresses.
 
-The DHCP specific options, such as dhcp-message-type, are removed from
-the server's responses and responses shorter than the BOOTP minimum
-size (300 octets) are padded to this size.
+The DHCP-specific options, such as ``dhcp-message-type``, are removed from
+the server's responses; responses shorter than the BOOTP minimum
+size of 300 octets are padded to this size.
 
-The library is available since Kea 1.7.2 and can be loaded in a
-similar way to other hook libraries by the ``kea-dhcp4`` process.
-It takes no parameter.
+This open source library has been available since Kea 1.7.2. It is loaded
+similarly to other hook libraries by the ``kea-dhcp4`` process, and
+it takes no parameters.
 
 ::
 
@@ -35,19 +35,18 @@ It takes no parameter.
 
 .. note::
 
-   This library is only meant to be loaded by the ``kea-dhcp4`` process
+   This library can only be loaded by the ``kea-dhcp4`` process,
    as there is no BOOTP protocol for IPv6.
 
 .. note::
 
    A host reservation for a BOOTP client should use the hardware address
-   as the identifier (the client-id option is a DHCP specific option).
+   as the identifier (the ``client-id`` option is a DHCP-specific option).
 
 .. _hooks-bootp-config:
 
-Incoming BOOTP packets are added to the BOOTP class. This can be used
-to segregate BOOTP clients to separate pools. For example you can do
-the following:
+Incoming BOOTP packets are added to the BOOTP class, allowing administrators
+to segregate BOOTP clients into separate pools. For example:
 
 ::
 
@@ -83,12 +82,11 @@ the following:
 
 .. _hooks-bootp-limitations:
 
-BOOTP Hooks Limitation
-~~~~~~~~~~~~~~~~~~~~~~
+BOOTP Hooks Limitations
+~~~~~~~~~~~~~~~~~~~~~~~
 
 Currently the BOOTP library has the following limitation:
 
-- A basic BOOTP as defined in `RFC 951
-  <https://tools.ietf.org/html/rfc951>`__ is not supported. Kea only
-  supports the BOOTP with vendor information extensions. Depending on
-  the demand, this may or may not be implemented in the future.
+- Basic BOOTP, as defined in `RFC 951
+  <https://tools.ietf.org/html/rfc951>`__, is not supported. Kea only
+  supports BOOTP with vendor-information extensions.