]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
Additional minor text edits in Kea docs
authorSuzanne Goldlust <sgoldlust@isc.org>
Tue, 17 Nov 2020 17:13:45 +0000 (17:13 +0000)
committerTomek Mrugalski <tomek@isc.org>
Fri, 20 Nov 2020 10:32:22 +0000 (11:32 +0100)
doc/sphinx/arm/dhcp4-srv.rst
doc/sphinx/arm/dhcp6-srv.rst
doc/sphinx/arm/hooks-lease-cmds.rst
doc/sphinx/arm/install.rst
doc/sphinx/arm/stork.rst

index 3bb61c596d71b87fe58b46e3d62d719e95f49b21..455fe469516d3efb1ef6be057e77cdbbcb5b840a 100644 (file)
@@ -3031,7 +3031,7 @@ Normally, when leases are renewed the server only updates DNS if the DNS
 information for the lease (e.g. FQDN, DNS update direction flags) has changed.
 Setting ``ddns-update-on-renew`` to true instructs the server to always update
 the DNS information when a lease is renewed even if its DNS information has not
-changed. This allows Kea to "self-heal" in the event it was previously unable
+changed. This allows Kea to "self-heal" if it was previously unable
 to add DNS entries or they were somehow lost by the DNS server.
 
 .. note::
@@ -3860,16 +3860,16 @@ be retained on the lease.  The lease's user-context will look something like thi
     hook library and at this time there is other use for this information within Kea.
 
 .. note::
-    It is possible that other hook libraries are already making use of user-context.
+    It is possible that other hook libraries are already using user-context.
     Enabling store-extended-info should not interfere with any other user-context
-    content so long as it does not also use an element labeled "ISC".  In other
+    content, as long as it does not also use an element labeled "ISC". In other
     words, user-context is intended to be a flexible container serving multiple
     purposes.  As long as no other purpose also writes an "ISC" element to
     user-context there should not be a conflict.
 
 .. _dhcp4-multi-threading-settings:
 
-Multi-threading settings
+Multi-Threading Settings
 ------------------------
 
 The Kea server can be configured to process packets in parallel using multiple
@@ -3900,7 +3900,7 @@ An example configuration that sets these parameter looks as follows:
        ...
    }
 
-Multi-threading settings in different backends
+Multi-Threading Settings in Different Backends
 ----------------------------------------------
 
 Both kea-dhcp4 and kea-dhcp6 are tested internally to determine which settings
@@ -3909,7 +3909,7 @@ recommendations and are very dependent on the particular hardware that was used
 for testing. We strongly advise that administrators run their own performance tests.
 
 A full report of Kea 1.7 performance results can be found `here <https://jenkins.isc.org/job/kea-1.7/job/performance/KeaPerformanceReport/>`_.
-This includes hardware descriptions, test scenario descriptions, and
+This includes hardware and test scenario descriptions, as well as
 current results.
 
 After enabling multi-threading, the number of threads is set by ``thread-pool-size``
@@ -6392,7 +6392,7 @@ parameters to control statistics default sample limits:
 - ``statistic-default-sample-age`` - determines the default maximum
   age in seconds of samples which are kept.
 
-For instance, to reduce the statistic keeping overhead, set
+For instance, to reduce the statistic-keeping overhead, set
 the default maximum sample count to 1 so only one sample is kept:
 
 ::
@@ -6530,7 +6530,7 @@ of LED devices could be configured in the following way:
        }],
    }
 
-Kea does not interpret or use the user context information; it simply stores it and makes it
+Kea does not interpret or use the user-context information; it simply stores it and makes it
 available to the hook libraries. It is up to each hook library to
 extract that information and use it. The parser translates a "comment"
 entry into a user context with the entry, which allows a comment to be
index 208b6bf265aa5e4a5154c6fad6ddbc13ad965073..388f308e61f13c494617aa59dda95448dc229b3f 100644 (file)
@@ -2749,7 +2749,7 @@ Normally, when leases are renewed the server will only update DNS if the DNS
 information for the lease (e.g. FQDN, DNS update direction flags) has changed.
 Setting ``ddns-update-on-renew`` to true instructs the server to always update
 the DNS information when a lease is renewed even if its DNS information has not
-changed.  This allows Kea to "self-heal" in the event it was previously unable
+changed.  This allows Kea to "self-heal" if it was previously unable
 to add DNS entries or they were somehow lost by the DNS server.
 
 .. note::
@@ -3374,7 +3374,7 @@ pretty-printed for clarity):
     It is possible that other hook libraries are already using
     user-context. Enabling store-extended-info should not interfere with
     any other user-context content, as long as it does not also use an element
-    labeled "ISC".  In other words, user-context is intended to be a flexible
+    labeled "ISC". In other words, user-context is intended to be a flexible
     container serving multiple purposes. As long as no other purpose also
     writes an "ISC" element to user-context there should not be a conflict.
 
@@ -3420,7 +3420,7 @@ recommendations and are very dependent on the particular hardware that was used
 for testing. We strongly advise that administrators run their own performance tests.
 
 A full report of Kea 1.7 performance results can be found `here <https://jenkins.isc.org/job/kea-1.7/job/performance/KeaPerformanceReport/>`_.
-This includes hardware descriptions, test scenario descriptions, and
+This includes hardware and test scenario descriptions, as well as
 current results.
 
 After enabling multi-threading, the number of threads is set by ``thread-pool-size``
@@ -4559,7 +4559,7 @@ the new setting is ignored and the warning log message is output.
 The backends continue to use the default setting, i.e. expecting that
 IP reservations are unique within each subnet. To allow the
 creation of non-unique IP reservations, the administrator must remove
-the backends which lack support for it from the configuration file.
+the backends which lack support for them from the configuration file.
 
 Administrators must be careful when they have been using multiple
 reservations for the same IP address and/or delegated prefix and later
@@ -6381,7 +6381,7 @@ parameters to control statistics default sample limits:
 - ``statistic-default-sample-age`` - determines the default maximum
   age in seconds of samples which are kept.
 
-For instance, to reduce the statistic keeping overhead, set
+For instance, to reduce the statistic-keeping overhead, set
 the default maximum sample count to 1 so that only one sample is kept:
 
 ::
index 52b04643ae3c45fc01b46f7de7c25e8f5969b2d4..764cd9d7d0083081759881033a1b4feb7f8aa659 100644 (file)
@@ -284,7 +284,7 @@ the performance penalty in the High-Availability mode when a single DHCPv6
 transaction resulted in multiple lease updates sent to the partner, if
 multiple address and/or prefix leases were allocated. Consider the case
 when a DHCPv6 client requests the assignment of two IPv6 addresses and two IPv6
-prefixes: that may result in allocation of 4 leases. In addition,
+prefixes: that may result in allocation of four leases. In addition,
 DHCPv6 may assign a different address than the one requested by the client during
 the renew or rebind stage, and delete the leases previously used by this client.
 There are six lease changes sent between the HA partners in this case.
index 6a5fd5904cfd30575c5cf844252b076e94523d15..e7f216730cfba2525f05d20390f80bcdbf560181 100644 (file)
@@ -130,7 +130,7 @@ system-specific installation tips.
 
 .. _install:
 
-Installation from Source
+Installation From Source
 ========================
 
 Although Kea may be available in pre-compiled, ready-to-use packages
@@ -177,7 +177,7 @@ files. They can be created by running ``autoreconf`` with the
 ``libtoolize``, ``autoheader``, ``automake``, and related commands.
 
 Write access to the Kea repository is only granted to ISC staff.
-Developers planning to contribute to Kea, should check our
+Developers planning to contribute to Kea should check our
 `Contributor's
 Guide <https://gitlab.isc.org/isc-projects/kea/blob/master/contributors-guide.md>`__.
 The `Kea Developer's
@@ -307,7 +307,7 @@ developers, or people who want to extend Kea code or send patches:
    and bison (.yy files). Kea sources have C++/h files generated out
    from them. By default Kea does not use flex or bison to avoid
    requiring installation of unnecessary dependencies for users.
-   However, anything in the parses is changed (such as adding a new
+   However, if anything in the parses is changed (such as adding a new
    parameter), flex and bison are required to regenerate
    parsers. This option permits that.
 
@@ -412,7 +412,7 @@ system (the ``build`` system) from the one where Kea runs
 (the ``host`` system).
 
 It is outside of the scope of common administrator operations and requires
-some developer skills, so the Developer Guide explains how to do that
+some developer skills, but the Developer Guide explains how to do that
 using an x86_64 Linux system to build Kea for a Raspberry Pi box running
 Raspbian: `Kea Cross-Compiling Example
 <https://jenkins.isc.org/job/Kea_doc/doxygen/de/d9a/crossCompile.html>`__.
@@ -603,7 +603,7 @@ use regular UDP sockets (refer to ``dhcp-socket-type`` parameter in the
 .. note::
 
    An alternative approach to running Kea with root privileges is to configure Kea to use
-   non-privileged ports (i.e. those greater than 1024) and redirecting traffic.  Note that this
+   non-privileged ports (i.e. those greater than 1024) and redirect traffic. Note that this
    only works for relayed traffic. Furthermore, we consider it experimental and untested in
    production environments. Use it only after careful consideration.
 
index 77b8950eeeec1f1034a33362d39700659bbaa4bf..3ae033973d13e22ae6a2bcdd03db4eed7d30dbdb 100644 (file)
@@ -29,7 +29,7 @@ Stork is available as source code, but also as native deb and RPM packages, whic
 to install on most popular systems. For more details, please see the
 `Stork ARM <https://stork.readthedocs.io>`_ or the `Stork project page <https://gitlab.isc.org/isc-projects/stork>`_.
 The former has a nice collection of screenshots that is frequently updated, to give users
-an impression of what is currently available. Stork is in the midst of full development with
+an idea of what is currently available. Stork is in the midst of full development with
 monthly releases, so please check back frequently.
 
 .. _grafana: