From 33128ff7ca0e7c3975ba8d3eb3045216da19e8fe Mon Sep 17 00:00:00 2001 From: Suzanne Goldlust Date: Fri, 5 Nov 2021 21:25:06 +0000 Subject: [PATCH] [#2139] Text edits --- doc/sphinx/arm/hooks-bootp.rst | 38 ++++++++++++++++------------------ 1 file changed, 18 insertions(+), 20 deletions(-) diff --git a/doc/sphinx/arm/hooks-bootp.rst b/doc/sphinx/arm/hooks-bootp.rst index a41379c2af..57e898ae7d 100644 --- a/doc/sphinx/arm/hooks-bootp.rst +++ b/doc/sphinx/arm/hooks-bootp.rst @@ -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 `__). 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 - `__ 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 + `__, is not supported. Kea only + supports BOOTP with vendor-information extensions.