diff options
author | Andrei Pavel <andrei@isc.org> | 2022-11-25 22:51:51 +0100 |
---|---|---|
committer | Andrei Pavel <andrei@isc.org> | 2022-11-25 23:17:08 +0100 |
commit | 03423adcd288c90ee0a338ab5d48609aea82e3ea (patch) | |
tree | 984d01344b1aa2ebce9214ad143c4bb9604c8fe7 | |
parent | [#2650] make bump-lib-versions.sh write ChangeLog entry too (diff) | |
download | kea-03423adcd288c90ee0a338ab5d48609aea82e3ea.tar.xz kea-03423adcd288c90ee0a338ab5d48609aea82e3ea.zip |
[#2651] release changes
47 files changed, 119 insertions, 117 deletions
diff --git a/.gitlab/issue_templates/release_checklist.md b/.gitlab/issue_templates/release_checklist.md index a37cce4ab6..c0ee46f88b 100644 --- a/.gitlab/issue_templates/release_checklist.md +++ b/.gitlab/issue_templates/release_checklist.md @@ -39,17 +39,17 @@ For new stable releases or maintenance releases, please don't use `kea-dev` buil The following steps may involve changing files in the repository. 1. [ ] Run [update-code-for-release.py](https://gitlab.isc.org/isc-private/qa-dhcp/-/blob/master/kea/build/update-code-for-release.py) <br> - Example command: `GITLAB_TOKEN='...' ./update-code-for-release.py 1.9.7 'Apr 28, 2021' ~/isc/repos/kea/` <br> - Help: `GITLAB_TOKEN="..." update-code-for-release.py --help`<br> + Example command: `GITLAB_TOKEN='...' ./update-code-for-release.py 1.9.7 ~/isc/repos/kea/` <br> + Help: `GITLAB_TOKEN="..." ./update-code-for-release.py --help`<br> This script makes the following changes and actions: 1. run prepare_kea_release.sh that does: - 1.1. add release entries in ChangeLogs - 1.2. update Kea version in configure.ac - 1.3. update copyright years in files that were changed in current year - 1.4. sort message files - 1.5. regenerate message files headers + 1. add release entries in ChangeLogs + 1. update Kea version in configure.ac + 1. update copyright years in files that were changed in current year + 1. sort message files + 1. regenerate message files headers 2. regenerate parsers using Bison from Docker<br> - using with --upload: + With `--upload`: 3. create an issue in GitLab for release changes in kea repo 4. create branches and merge requests for kea and kea-premium 5. commit the changes in both repos @@ -1,3 +1,5 @@ +Kea 2.3.3 (development) released on November 30, 2022 + 2078. [build] andrei The library version numbers have been bumped for the Kea 2.3.3 development release. @@ -15,7 +17,7 @@ 2076. [doc] razvan Add documentation for template classes and the new parameter 'template-test' which evaluates to a string value. This indicates - if the class is spaning classes with the name containing the + if the class is spawning classes with the name containing the evaluated value: 'SPAWN_<template-class-name>_<evaluated-value>' only if the value is not empty string. This will also add the packet to the <template-class-name> class. diff --git a/doc/examples/agent/comments.json b/doc/examples/agent/comments.json index 6f40bdbb20..10c82e3fa3 100644 --- a/doc/examples/agent/comments.json +++ b/doc/examples/agent/comments.json @@ -41,7 +41,7 @@ { "dhcp4": { - "comment": "control socket for DHCP4 server", + "comment": "control socket for DHCPv4 server", "socket-type": "unix", "socket-name": "/tmp/kea4-ctrl-socket" } diff --git a/doc/examples/agent/simple.json b/doc/examples/agent/simple.json index 6c5af60e71..f48a5ecca4 100644 --- a/doc/examples/agent/simple.json +++ b/doc/examples/agent/simple.json @@ -84,7 +84,7 @@ // This is how the Agent can communicate with the DHCPv4 server. "dhcp4": { - "comment": "socket to DHCP4 server", + "comment": "socket to DHCPv4 server", "socket-type": "unix", "socket-name": "/tmp/kea4-ctrl-socket" }, diff --git a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json index ff094a3387..e6f2f6d066 100644 --- a/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json +++ b/doc/examples/kea4/ha-load-balancing-server1-mt-with-tls.json @@ -136,7 +136,7 @@ // further. The default value is 60000ms (60 seconds). "sync-timeout": 60000, // To not experience performance degradation when the Kea server is - // processing packets on multiple threads, the High Availablility module + // processing packets on multiple threads, the High Availability module // must have multi-threading enabled. "multi-threading": { "enable-multi-threading": true, diff --git a/doc/examples/kea4/ha-load-balancing-server2-mt.json b/doc/examples/kea4/ha-load-balancing-server2-mt.json index 5f01cf4caf..51be49a82c 100644 --- a/doc/examples/kea4/ha-load-balancing-server2-mt.json +++ b/doc/examples/kea4/ha-load-balancing-server2-mt.json @@ -135,7 +135,7 @@ // further. The default value is 60000ms (60 seconds). "sync-timeout": 60000, // To not experience performance degradation when the Kea server is - // processing packets on multiple threads, the High Availablility module + // processing packets on multiple threads, the High Availability module // must have multi-threading enabled. "multi-threading": { "enable-multi-threading": true, diff --git a/doc/examples/netconf/simple-dhcp4.json b/doc/examples/netconf/simple-dhcp4.json index 56407b2da9..3e2105e2af 100644 --- a/doc/examples/netconf/simple-dhcp4.json +++ b/doc/examples/netconf/simple-dhcp4.json @@ -61,7 +61,7 @@ }, // Comment is optional. You can put some notes here. - "comment": "Kea DHCP4 server serving network on floor 13" + "comment": "Kea DHCPv4 server serving network on floor 13" } }, diff --git a/doc/examples/netconf/simple-dhcp6.json b/doc/examples/netconf/simple-dhcp6.json index ef07dd8f71..4393f67606 100644 --- a/doc/examples/netconf/simple-dhcp6.json +++ b/doc/examples/netconf/simple-dhcp6.json @@ -62,7 +62,7 @@ }, // Comment is optional. You can put some notes here. - "comment": "Kea DHCP6 server serving network on floor 13" + "comment": "Kea DHCPv6 server serving network on floor 13" } }, diff --git a/doc/examples/template-ha-mt-tls/info.md b/doc/examples/template-ha-mt-tls/info.md index 02e9f60e31..d87f70c7c3 100644 --- a/doc/examples/template-ha-mt-tls/info.md +++ b/doc/examples/template-ha-mt-tls/info.md @@ -55,7 +55,7 @@ The whole subnet is split into dynamic pools: To deploy this setup, follow the steps provided in the power user home setup with the following distinctions: 1. Install CA only if the administrator is planning to manage Kea using RESTful API. - Otherwise, the High Availablility Kea server with multi-threading does not require CA to run. + Otherwise, the High Availability Kea server with multi-threading does not require CA to run. 2. Alter the following to match the local setup: diff --git a/doc/examples/template-ha-mt-tls/kea-ca-1.conf b/doc/examples/template-ha-mt-tls/kea-ca-1.conf index 127e786924..38aed10613 100644 --- a/doc/examples/template-ha-mt-tls/kea-ca-1.conf +++ b/doc/examples/template-ha-mt-tls/kea-ca-1.conf @@ -40,7 +40,7 @@ // This is how the Agent can communicate with the DHCPv4 server. "dhcp4": { - "comment": "socket to DHCP4 server", + "comment": "socket to DHCPv4 server", "socket-type": "unix", "socket-name": "/tmp/kea4-ctrl-socket" }, diff --git a/doc/examples/template-ha-mt-tls/kea-ca-2.conf b/doc/examples/template-ha-mt-tls/kea-ca-2.conf index c7e42b0299..1f08beaffe 100644 --- a/doc/examples/template-ha-mt-tls/kea-ca-2.conf +++ b/doc/examples/template-ha-mt-tls/kea-ca-2.conf @@ -40,7 +40,7 @@ // This is how the Agent can communicate with the DHCPv4 server. "dhcp4": { - "comment": "socket to DHCP4 server", + "comment": "socket to DHCPv4 server", "socket-type": "unix", "socket-name": "/tmp/kea4-ctrl-socket" }, diff --git a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf index c586f80377..e50d548322 100644 --- a/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf +++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-1.conf @@ -134,7 +134,7 @@ "sync-timeout": 60000, // Multi-threading parameters. // To not experience performance degradation when the Kea server is - // processing packets on multiple threads, the High Availablility module + // processing packets on multiple threads, the High Availability module // must have multi-threading enabled. "multi-threading": { "enable-multi-threading": true, diff --git a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf index 893bb9a700..2b17262f98 100644 --- a/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf +++ b/doc/examples/template-ha-mt-tls/kea-dhcp4-2.conf @@ -134,7 +134,7 @@ "sync-timeout": 60000, // Multi-threading parameters. // To not experience performance degradation when the Kea server is - // processing packets on multiple threads, the High Availablility module + // processing packets on multiple threads, the High Availability module // must have multi-threading enabled. "multi-threading": { "enable-multi-threading": true, diff --git a/doc/examples/template-power-user-home/kea-ca-1.conf b/doc/examples/template-power-user-home/kea-ca-1.conf index d7749aee34..2620ea007e 100644 --- a/doc/examples/template-power-user-home/kea-ca-1.conf +++ b/doc/examples/template-power-user-home/kea-ca-1.conf @@ -16,7 +16,7 @@ // This is how the Agent can communicate with the DHCPv4 server. "dhcp4": { - "comment": "socket to DHCP4 server", + "comment": "socket to DHCPv4 server", "socket-type": "unix", "socket-name": "/tmp/kea4-ctrl-socket" }, diff --git a/doc/examples/template-power-user-home/kea-ca-2.conf b/doc/examples/template-power-user-home/kea-ca-2.conf index 59e4967bad..dccf5d9d87 100644 --- a/doc/examples/template-power-user-home/kea-ca-2.conf +++ b/doc/examples/template-power-user-home/kea-ca-2.conf @@ -16,7 +16,7 @@ // This is how the Agent can communicate with the DHCPv4 server. "dhcp4": { - "comment": "socket to DHCP4 server", + "comment": "socket to DHCPv4 server", "socket-type": "unix", "socket-name": "/tmp/kea4-ctrl-socket" }, diff --git a/doc/sphinx/arm/classify.rst b/doc/sphinx/arm/classify.rst index b2d9bb0ffe..3bb57c4371 100644 --- a/doc/sphinx/arm/classify.rst +++ b/doc/sphinx/arm/classify.rst @@ -790,7 +790,7 @@ ASCII, then the spawned class will use the ``SPAWN_Client-ID_foobar`` name effectively associating the regular class to the packet. In this second case, both ``SPAWN_Client-ID_foobar`` and ``Client-ID`` classes will be associated with the packet. -The ``test`` expression on the regular classs ``SPAWN_Client-ID_foobar`` is not +The ``test`` expression on the regular class ``SPAWN_Client-ID_foobar`` is not mandatory and can be omitted, but it is used here with a different match expression for example purposes. @@ -836,7 +836,7 @@ is not mandatory that the flag be set to ``true``. options, are associated with the spawned class. This permits configuring limits which apply for all packets associated with a class spawned at runtime, according to the ``template-test`` expression in the parent template - class. For a more detaild description on how to configure limits using the + class. For a more detailed description on how to configure limits using the limits hooks library see the :ref:`hooks-limits-configuration`. For example, using the configuration below, ingress DHCPv6 packets that have client ID values (in the format expressed by the Kea evaluator) ``foobar`` diff --git a/doc/sphinx/arm/config.rst b/doc/sphinx/arm/config.rst index cb29dcc2b8..c54380ee6d 100644 --- a/doc/sphinx/arm/config.rst +++ b/doc/sphinx/arm/config.rst @@ -195,7 +195,7 @@ User context can be added and edited in structures supported by commands. We encourage Kea users to utilize these functions to store information used by other systems and custom hooks. -For example, the `subnet4-update` command can be used to add user context data +For example, the ``subnet4-update`` command can be used to add user context data to an existing subnet. :: @@ -214,7 +214,7 @@ The same can be done with many other commands like lease6-add etc. Kea also uses user context to store non-standard data. Currently, only :ref:`dhcp4-store-extended-info` uses this feature. -When enabled, it adds the ISC key in `user-context` to differentiate automatically +When enabled, it adds the ISC key in ``user-context`` to differentiate automatically added content. Example of relay information stored in a lease: diff --git a/doc/sphinx/arm/dhcp6-srv.rst b/doc/sphinx/arm/dhcp6-srv.rst index d07163ef91..bda1c1ad18 100644 --- a/doc/sphinx/arm/dhcp6-srv.rst +++ b/doc/sphinx/arm/dhcp6-srv.rst @@ -2667,7 +2667,7 @@ servers set to 2001:db8:0::1 and 2001:db8:2::1. This example shows a configuration using an automatically generated ``VENDOR_CLASS_`` class. The administrator of the network has decided that addresses in the range 2001:db8:1::1 to 2001:db8:1::ffff are to be -managed by the DHCP6 server and that only clients belonging to the +managed by the DHCPv6 server and that only clients belonging to the eRouter1.0 client class are allowed to use that pool. :: diff --git a/doc/sphinx/arm/ext-netconf.rst b/doc/sphinx/arm/ext-netconf.rst index 4234cd508f..a1c9ce3822 100644 --- a/doc/sphinx/arm/ext-netconf.rst +++ b/doc/sphinx/arm/ext-netconf.rst @@ -564,7 +564,7 @@ Kea sources. // This is how kea-netconf can communicate with the DHCPv4 server. "dhcp4": { - "comment": "DHCP4 server", + "comment": "DHCPv4 server", "model": "kea-dhcp4-server", "control-socket": { diff --git a/doc/sphinx/arm/hooks-flex-id.rst b/doc/sphinx/arm/hooks-flex-id.rst index 664d9c1729..2c11807d17 100644 --- a/doc/sphinx/arm/hooks-flex-id.rst +++ b/doc/sphinx/arm/hooks-flex-id.rst @@ -238,7 +238,7 @@ from incoming IPv6 packets. This parameter is ignored by the Kea DHCPv4 server. If the packet contains only one IA_NA, the IAID value will be changed to ``0`` and stored as such in the lease storage. Similarly if the packet contains only one IA_PD, the IAID value will be changed to ``0`` and stored as such in the -lease storage. The IAID is restored to its intitial value in the response back +lease storage. The IAID is restored to its initial value in the response back to the client. The change is visible in the identifier expression if the IAID is part of the expression. diff --git a/doc/sphinx/arm/hooks.rst b/doc/sphinx/arm/hooks.rst index 3b7ef06bd7..dad0be72d6 100644 --- a/doc/sphinx/arm/hooks.rst +++ b/doc/sphinx/arm/hooks.rst @@ -22,7 +22,7 @@ to load those libraries. Hook libraries are loaded by individual Kea processes, not by Kea as a whole. This means, among other things, that it is possible to associate one set -of libraries with the DHCP4 server and a different set with the DHCP6 +of libraries with the DHCPv4 server and a different set with the DHCPv6 server. It is also possible for a process to load diff --git a/doc/sphinx/arm/install.rst b/doc/sphinx/arm/install.rst index e360bd9cf6..33b77b2ef7 100644 --- a/doc/sphinx/arm/install.rst +++ b/doc/sphinx/arm/install.rst @@ -88,7 +88,7 @@ during upgrade depending on which packages were originally installed: If your goal is to have the entire Kea software suite installed, it is recommended that you simply ``apt install isc-kea`` after upgrading, which -will install all of the relevent subpackages that make up Kea. +will install all of the relevant subpackages that make up Kea. This upgrade path hiccup is not present on RPM and Alpine systems, however if you experience issues with upgrading past 2.3.1, please inform us on the diff --git a/platforms.rst b/platforms.rst index cea1652fed..6958dd810f 100644 --- a/platforms.rst +++ b/platforms.rst @@ -20,10 +20,10 @@ Regularly Tested Platforms Kea is officially supported on Alpine, CentOS, Fedora, Ubuntu, Debian, and FreeBSD systems. Kea-|release| builds have been tested on: -* Alpine — 3.13, 3.14, 3.15, 3.16 +* Alpine — 3.14, 3.15, 3.16 * CentOS — 7 * Debian — 10, 11 -* Fedora — 35, 36 +* Fedora — 36 * FreeBSD — 12, 13 * RHEL — 8, 9 * Ubuntu — 18.04, 20.04, 22.04 @@ -38,29 +38,29 @@ 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 -* macOS — 10.15, 11, 12 +* macOS — 11, 12, 13 Community-Maintained -------------------- -These systems may not all have the required dependencies for building Kea -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 are -assessed against the risk of adverse effect on officially supported -platforms. +These systems have once been regularly tested, but official support for it has +been abandoned, usually due to discontinued support on their own part. Older +versions may not have the required dependencies for building Kea easily +available, although it is possible in many cases to compile on 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 are assessed against the risk of +adverse effect on officially supported platforms. These include platforms past their respective EOL dates, such as: -* Alpine — 3.10 (1 May 2021), 3.11, 3.12 -* CentOS — 6 (30 November 2020), 8 (31 December 2021) -* Debian — 8 (30 June 2020), 9 (June 30, 2022) -* Fedora — 31, 32, 33, 34 -* FreeBSD — 10 (31 October 2018) -* macOS — 10.13, 10.14 -* Ubuntu — 14.04, 18.10, 19.04, 19.10, 21.04 +* Alpine — 3.10, 3.11, 3.12, 3.13 (EOL 01 November 2022) +* CentOS — 6, 8 (EOL 31 December 2021) +* Debian — 8, 9 (EOL 30 June 2022) +* Fedora — 31, 32, 33, 34, 35 (EOL 13 December 2022) +* FreeBSD — 10, 11 (EOL 30 September 2021) +* macOS — 10.13, 10.14, 10.15 (EOL 12 September 2022) +* Ubuntu — 14.04, 18.10, 19.04, 19.10, 21.04 (EOL 20 January 2022) Unsupported Platforms --------------------- diff --git a/src/bin/agent/agent.dox b/src/bin/agent/agent.dox index 9e1f69d471..b8386777fb 100644 --- a/src/bin/agent/agent.dox +++ b/src/bin/agent/agent.dox @@ -1,4 +1,4 @@ -// Copyright (C) 2017 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2017-2022 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 @@ -122,7 +122,7 @@ It was eventually decided to not implement the secure layer within Kea for the f burden on Kea maintenance. In the installations where securing command channel is critical (most of the -installations?), a reverse HTTP proxy can be setup using one of the third +installations?), a reverse HTTP proxy can be set up using one of the third party HTTP server implementations, e.g. Apache, nginx etc. */ diff --git a/src/bin/dhcp6/dhcp6.dox b/src/bin/dhcp6/dhcp6.dox index 46c6a24af8..661125349a 100644 --- a/src/bin/dhcp6/dhcp6.dox +++ b/src/bin/dhcp6/dhcp6.dox @@ -1,4 +1,4 @@ -// Copyright (C) 2012-2018 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2012-2022 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 diff --git a/src/bin/netconf/netconf_messages.mes b/src/bin/netconf/netconf_messages.mes index 18b9a58e51..0516385a0e 100644 --- a/src/bin/netconf/netconf_messages.mes +++ b/src/bin/netconf/netconf_messages.mes @@ -75,6 +75,12 @@ This warning message indicates that a module used by Kea is not at the right revision in the sysrepo repository. The name, expected and available revisions of the module are printed. +% NETCONF_NOTIFICATION_RECEIVED Received notification of type %1 for module %1: %2 +This informational message logs any YANG notification that has been signaled +by the server, sent to kea-netconf which then was forwarded to subscribed +clients. To achieve this, kea-netconf subscribes itself as a client to all +notifications for the configured module. + % NETCONF_NOT_SUBSCRIBED_TO_NOTIFICATIONS subscribing to notifications for %1 server with %2 module failed: %3 The warning message indicates that kea-netconf got an error subscribing to notifications for a Kea server. The most probable cause is probably that the @@ -82,12 +88,6 @@ model that kea-netconf subscribed to does not have any notification nodes, but there may be other more unxpected causes as well. The server name, module name and the error are printed. -% NETCONF_NOTIFICATION_RECEIVED Received notification of type %1 for module %1: %2 -This informational message logs any YANG notification that has been signaled -by the server, sent to kea-netconf which then was forwarded to subscribed -clients. To achieve this, kea-netconf subscribes itself as a client to all -notifications for the configured module. - % NETCONF_RUN_EXIT application is exiting the event loop This is a debug message issued when kea-netconf exits its event loop. This is a normal step during kea-netconf shutdown. diff --git a/src/hooks/dhcp/high_availability/ha_service.cc b/src/hooks/dhcp/high_availability/ha_service.cc index f23b603393..a3951dc7cb 100644 --- a/src/hooks/dhcp/high_availability/ha_service.cc +++ b/src/hooks/dhcp/high_availability/ha_service.cc @@ -2996,7 +2996,7 @@ HAService::verifyAsyncResponse(const HttpResponsePtr& response, int& rcode) { // The empty status can occur for the lease6-bulk-apply command. In that // case, the response may contain conflicted or erred leases within the // arguments, rather than globally. For other error cases let's construct - // the error message from tyhe global values. + // the error message from the global values. if (rcode != CONTROL_RESULT_EMPTY) { // Include an error text if available. if (args && args->getType() == Element::string) { diff --git a/src/hooks/dhcp/high_availability/tests/ha_impl_unittest.cc b/src/hooks/dhcp/high_availability/tests/ha_impl_unittest.cc index 38c1d9a02a..514128183a 100644 --- a/src/hooks/dhcp/high_availability/tests/ha_impl_unittest.cc +++ b/src/hooks/dhcp/high_availability/tests/ha_impl_unittest.cc @@ -1,4 +1,4 @@ -// Copyright (C) 2018-2021 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2018-2022 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 diff --git a/src/lib/asiodns/io_fetch.cc b/src/lib/asiodns/io_fetch.cc index 2e29b47ab0..980a6009b6 100644 --- a/src/lib/asiodns/io_fetch.cc +++ b/src/lib/asiodns/io_fetch.cc @@ -1,4 +1,4 @@ -// Copyright (C) 2011-2021 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2011-2022 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 @@ -247,8 +247,8 @@ IOFetch::operator()(boost::system::error_code ec, size_t length) { } } - // If we timeout, we stop, which will can cancel outstanding I/Os and - // shutdown everything. + // If we timeout, we stop, which cancels outstanding I/O operations and + // shuts down everything. if (data_->timeout != -1) { data_->timer.expires_from_now(boost::posix_time::milliseconds( data_->timeout)); diff --git a/src/lib/d2srv/d2_config.h b/src/lib/d2srv/d2_config.h index 6162ec5ea1..cb141ad6b7 100644 --- a/src/lib/d2srv/d2_config.h +++ b/src/lib/d2srv/d2_config.h @@ -1,4 +1,4 @@ -// Copyright (C) 2013-2021 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2013-2022 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 @@ -266,14 +266,14 @@ typedef boost::shared_ptr<D2Params> D2ParamsPtr; class TSIGKeyInfo : public isc::data::UserContext, public isc::data::CfgToElement { public: /// @brief Defines string values for the supported TSIG algorithms - //@{ + /// @{ static const char* HMAC_MD5_STR; static const char* HMAC_SHA1_STR; static const char* HMAC_SHA256_STR; static const char* HMAC_SHA224_STR; static const char* HMAC_SHA384_STR; static const char* HMAC_SHA512_STR; - //}@ + /// @} /// @brief Constructor /// diff --git a/src/lib/dhcp/option_definition.h b/src/lib/dhcp/option_definition.h index a9316acf2c..08a5126313 100644 --- a/src/lib/dhcp/option_definition.h +++ b/src/lib/dhcp/option_definition.h @@ -1,4 +1,4 @@ -// Copyright (C) 2012-2021 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2012-2022 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 @@ -345,7 +345,7 @@ public: /// @brief Return array type indicator. /// /// The method returns the bool value to indicate whether the option is a - /// a single value or an array of values. + /// single value or an array of values. /// /// @return true if option comprises an array of values. bool getArrayType() const { return (array_type_); } diff --git a/src/lib/dhcp/pkt.h b/src/lib/dhcp/pkt.h index 7c8c302506..77e9a2b0f1 100644 --- a/src/lib/dhcp/pkt.h +++ b/src/lib/dhcp/pkt.h @@ -379,7 +379,7 @@ public: /// Kea configuration. To prevent this, option copying should be /// enabled prior to passing the pointer to a packet to a hook library. /// - /// Note that only only does this method causes the server to copy + /// Not only does this method cause the server to copy /// an option, but the copied option also replaces the original /// option within the packet. The option can be then freely modified /// and the modifications will only affect the instance of this diff --git a/src/lib/dhcp/tests/protocol_util_unittest.cc b/src/lib/dhcp/tests/protocol_util_unittest.cc index 45c2fd5d6d..c89bf0f932 100644 --- a/src/lib/dhcp/tests/protocol_util_unittest.cc +++ b/src/lib/dhcp/tests/protocol_util_unittest.cc @@ -278,7 +278,7 @@ TEST(ProtocolUtilTest, writeEthernetHeaderBroadcast) { HWAddrPtr remote_hw_addr(new HWAddr(dest_hw_addr, 6, 1)); ASSERT_NO_THROW(pkt->setRemoteHWAddr(remote_hw_addr)); - // Set the broadcast flasg. + // Set the broadcast flags. pkt->setFlags(pkt->getFlags() | Pkt4::FLAG_BROADCAST_MASK); // Construct the ethernet header using HW addresses stored @@ -331,7 +331,7 @@ TEST(ProtocolUtilTest, writeEthernetHeaderBroadcastRelayed) { HWAddrPtr remote_hw_addr(new HWAddr(dest_hw_addr, 6, 1)); ASSERT_NO_THROW(pkt->setRemoteHWAddr(remote_hw_addr)); - // Set the broadcast flasg. + // Set the broadcast flags. pkt->setFlags(pkt->getFlags() | Pkt4::FLAG_BROADCAST_MASK); // Set a gateway address: the broadcast flag is now for diff --git a/src/lib/dhcpsrv/cfgmgr.h b/src/lib/dhcpsrv/cfgmgr.h index 0302cf54e1..d34b1c5e87 100644 --- a/src/lib/dhcpsrv/cfgmgr.h +++ b/src/lib/dhcpsrv/cfgmgr.h @@ -1,4 +1,4 @@ -// Copyright (C) 2012-2019 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2012-2022 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 @@ -160,7 +160,7 @@ public: /// @brief Removes staging configuration. /// /// This function should be called when there is a staging configuration - /// (likely created in the previous configuration attempt) but the entirely + /// (likely created in the previous configuration attempt) but the entire /// new configuration should be created. It removes the existing staging /// configuration and the next call to @c CfgMgr::getStagingCfg will return a /// fresh (default) configuration. diff --git a/src/lib/dhcpsrv/client_class_def.h b/src/lib/dhcpsrv/client_class_def.h index ca7f013d2c..4e8e981314 100644 --- a/src/lib/dhcpsrv/client_class_def.h +++ b/src/lib/dhcpsrv/client_class_def.h @@ -318,7 +318,7 @@ public: /// If incoming packet is associated with the template class, the name of /// generated spawned class is prepended with this prefix. /// For example, a packet that associates with the template class "FOO" by - /// evaluating the templeta class expression to BAR will cause the packet to + /// evaluating the template class expression to BAR will cause the packet to /// be assigned to class SPAWN_FOO_BAR. static const std::string SPAWN_CLASS_PREFIX; }; diff --git a/src/lib/dhcpsrv/dhcpsrv_messages.mes b/src/lib/dhcpsrv/dhcpsrv_messages.mes index f1e2ce9917..d2105472d9 100644 --- a/src/lib/dhcpsrv/dhcpsrv_messages.mes +++ b/src/lib/dhcpsrv/dhcpsrv_messages.mes @@ -395,14 +395,14 @@ and the fact tables are enabled or disabled are displayed. The code has issued a begin transaction call. For the memory file database, this is a no-op. -% DHCPSRV_MEMFILE_BUILD_EXTENDED_INFO_TABLES6_ERROR building extended info tables got an exception on the lease for %1: %2 -A debug message issued when the server is building extended info tables and -receives an exception processing a lease. - % DHCPSRV_MEMFILE_BUILD_EXTENDED_INFO_TABLES6 building extended info tables saw %1 leases, extended info sanity checks modified %2 / updated %3 leases and %4 leases were entered into tables Extended info tables build was finished. Some statistics are displayed, the updated in database is returned to the command interface. +% DHCPSRV_MEMFILE_BUILD_EXTENDED_INFO_TABLES6_ERROR building extended info tables got an exception on the lease for %1: %2 +A debug message issued when the server is building extended info tables and +receives an exception processing a lease. + % DHCPSRV_MEMFILE_COMMIT committing to memory file database The code has issued a commit call. For the memory file database, this is a no-op. diff --git a/src/lib/dhcpsrv/memfile_lease_mgr.cc b/src/lib/dhcpsrv/memfile_lease_mgr.cc index a36bc056ec..1e5677e46b 100644 --- a/src/lib/dhcpsrv/memfile_lease_mgr.cc +++ b/src/lib/dhcpsrv/memfile_lease_mgr.cc @@ -2444,8 +2444,9 @@ Memfile_LeaseMgr::getLeaseLimit(ConstElementPtr parent, Lease::Type ltype, size_ } namespace { + std::string -idtoText(const OptionBuffer& id) { +idToText(const OptionBuffer& id) { std::stringstream tmp; tmp << std::hex; bool delim = false; @@ -2460,6 +2461,7 @@ idtoText(const OptionBuffer& id) { } return (tmp.str()); } + } // anonymous namespace Lease4Collection @@ -2479,7 +2481,7 @@ Memfile_LeaseMgr::getLeases4ByRelayId(const OptionBuffer& relay_id, DHCPSRV_MEMFILE_GET_RELAYID4) .arg(page_size.page_size_) .arg(lower_bound_address.toText()) - .arg(idtoText(relay_id)) + .arg(idToText(relay_id)) .arg(qry_start_time) .arg(qry_end_time); @@ -2525,7 +2527,7 @@ Memfile_LeaseMgr::getLeases4ByRemoteId(const OptionBuffer& remote_id, DHCPSRV_MEMFILE_GET_REMOTEID4) .arg(page_size.page_size_) .arg(lower_bound_address.toText()) - .arg(idtoText(remote_id)) + .arg(idToText(remote_id)) .arg(qry_start_time) .arg(qry_end_time); @@ -2690,7 +2692,7 @@ Memfile_LeaseMgr::getLeases6ByRemoteId(const OptionBuffer& remote_id, DHCPSRV_MEMFILE_GET_REMOTEID6) .arg(page_size.page_size_) .arg(lower_bound_address.toText()) - .arg(idtoText(remote_id)) + .arg(idToText(remote_id)) .arg(link_addr.toText()) .arg(static_cast<unsigned>(link_len)); diff --git a/src/lib/dhcpsrv/pool.cc b/src/lib/dhcpsrv/pool.cc index 04788b8b52..f5a88d0430 100644 --- a/src/lib/dhcpsrv/pool.cc +++ b/src/lib/dhcpsrv/pool.cc @@ -1,4 +1,4 @@ -// Copyright (C) 2012-2020 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2012-2022 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 diff --git a/src/lib/dhcpsrv/tests/iterative_allocation_state_unittest.cc b/src/lib/dhcpsrv/tests/iterative_allocation_state_unittest.cc index 6de62eddb0..8b0bd24356 100644 --- a/src/lib/dhcpsrv/tests/iterative_allocation_state_unittest.cc +++ b/src/lib/dhcpsrv/tests/iterative_allocation_state_unittest.cc @@ -171,4 +171,4 @@ TEST(IterativeAllocationStateTest, poolLastAllocated6) { EXPECT_FALSE(state->isLastAllocatedValid()); } -} // end of anonymouns namespace +} // anonymous namespace diff --git a/src/lib/dhcpsrv/tests/memfile_lease_extended_info_unittest.cc b/src/lib/dhcpsrv/tests/memfile_lease_extended_info_unittest.cc index e12fb91ce2..f9e26d2f61 100644 --- a/src/lib/dhcpsrv/tests/memfile_lease_extended_info_unittest.cc +++ b/src/lib/dhcpsrv/tests/memfile_lease_extended_info_unittest.cc @@ -1241,7 +1241,7 @@ TEST_F(MemfileExtendedInfoTest, updateLease6ignore) { // Note that with persist when the database is reloaded the user context // is still there so tables will be updated: the ACTION_IGNORE setting - // has no persistent effect: instead clenup the user context before + // has no persistent effect: instead cleanup the user context before // calling updateLease6... } diff --git a/src/lib/log/message_initializer.h b/src/lib/log/message_initializer.h index 491a578ed0..7f40f9b0ee 100644 --- a/src/lib/log/message_initializer.h +++ b/src/lib/log/message_initializer.h @@ -1,4 +1,4 @@ -// Copyright (C) 2011-2015,2017 Internet Systems Consortium, Inc. ("ISC") +// Copyright (C) 2011-2022 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 @@ -38,7 +38,7 @@ typedef boost::shared_ptr<LoggerDuplicatesList> LoggerDuplicatesListPtr; /// This is a helper class to add a set of message IDs and associated text to /// the global dictionary. /// -/// It should be declared outside an execution unit and initialized with a +/// It should be declared outside an execution unit and initialized with /// an array of values, alternating identifier, associated text and ending with /// a NULL, e.g. /// diff --git a/src/lib/pgsql/pgsql_exchange.h b/src/lib/pgsql/pgsql_exchange.h index c6172c10a9..22ec7afe0c 100644 --- a/src/lib/pgsql/pgsql_exchange.h +++ b/src/lib/pgsql/pgsql_exchange.h @@ -764,7 +764,6 @@ public: /// will be stored. /// @param buffer_size size of the output buffer /// @param[out] bytes_converted number of bytes converted - /// value /// /// @throw DbOperationError if the value cannot be fetched or is /// invalid. diff --git a/src/lib/tcp/tcp_connection.h b/src/lib/tcp/tcp_connection.h index f64abf740e..bf37bb0114 100644 --- a/src/lib/tcp/tcp_connection.h +++ b/src/lib/tcp/tcp_connection.h @@ -307,7 +307,7 @@ public: /// @brief Returns an empty end point. /// - /// @return an unitialized endpoint. + /// @return an uninitialized endpoint. static const boost::asio::ip::tcp::endpoint& NO_ENDPOINT() { static boost::asio::ip::tcp::endpoint endpoint; return (endpoint); diff --git a/src/lib/tcp/tcp_messages.mes b/src/lib/tcp/tcp_messages.mes index 158244d9d9..7c97369c7a 100644 --- a/src/lib/tcp/tcp_messages.mes +++ b/src/lib/tcp/tcp_messages.mes @@ -6,6 +6,20 @@ $NAMESPACE isc::tcp +% MT_TCP_LISTENER_MGR_STARTED MtTcpListenerMgr started with %1 threads, listening on %2:%3, use TLS: %4 +This debug messages is issued when an MtTcpListenerMgr has been started to +accept connections. Arguments detail the number of threads that the listener +is using, the address and port at which it is listening, and if TLS is used +or not. + +% MT_TCP_LISTENER_MGR_STOPPED MtTcpListenerMgr for %1:%2 stopped. +This debug messages is issued when the MtTcpListenerMgr, listening +at the given address and port, has completed shutdown. + +% MT_TCP_LISTENER_MGR_STOPPING Stopping MtTcpListenerMgr for %1:%2 +This debug messages is issued when the MtTcpListenerMgr, listening +at the given address and port, has begun to shutdown. + % TCP_CLIENT_REQUEST_RECEIVED received TCP request from %1 This debug message is issued when the server finished receiving a TCP request from the remote endpoint. The address of the remote endpoint is @@ -26,6 +40,10 @@ with the remote endpoint. The first argument specifies the address of the remote endpoint. The second argument specifies request timeout in seconds. +% TCP_CONNECTION_REJECTED_BY_FILTER connection from %1 has been denied by the connection filter. +This debug message is issued when the server's connection filter rejects +a new connection based on the client's ip address. + % TCP_CONNECTION_SHUTDOWN shutting down TCP connection from %1 This debug message is issued when one of the TCP connections is shut down. The connection can be stopped as a result of an error or after the @@ -61,9 +79,11 @@ transaction. This is proven to occur when the system clock is moved manually or as a result of synchronization with a time server. Any ongoing transactions will be interrupted. New transactions should be conducted normally. -% TCP_CONNECTION_REJECTED_BY_FILTER connection from %1 has been denied by the connection filter. -This debug message is issued when the server's connection filter rejects -a new connection based on the client's ip address. +% TCP_REQUEST_RECEIVED_FAILED An unexpected error occurred processing a request from %1, error: %2 +This error message is issued when an unexpected error occurred while the +server attempted to process a received request. The first argument specifies +the address of the remote endpoint. The second argument describes the nature +error. % TCP_REQUEST_RECEIVE_START start receiving request from %1 with timeout %2 This debug message is issued when the server starts receiving new request @@ -71,12 +91,6 @@ over the established connection. The first argument specifies the address of the remote endpoint. The second argument specifies request timeout in seconds. -% TCP_REQUEST_RECEIVED_FAILED An unexpected error occurred processing a request from %1, error: %2 -This error message is issued when an unexpected error occurred while the -server attempted to process a received request. The first argument specifies -the address of the remote endpoint. The second argument describes the nature -error. - % TCP_SERVER_RESPONSE_SEND sending TCP response %1 to %2 This debug message is issued when the server is starting to send a TCP response to a remote endpoint. The first argument holds basic information @@ -90,17 +104,3 @@ first argument specifies an address of the remote endpoint to which the response is being sent. The second argument provides a response in the textual form. The response is truncated by the logger if it is too large to be printed. - -% MT_TCP_LISTENER_MGR_STARTED MtTcpListenerMgr started with %1 threads, listening on %2:%3, use TLS: %4 -This debug messages is issued when an MtTcpListenerMgr has been started to -accept connections. Arguments detail the number of threads that the listener -is using, the address and port at which it is listening, and if TLS is used -or not. - -% MT_TCP_LISTENER_MGR_STOPPED MtTcpListenerMgr for %1:%2 stopped. -This debug messages is issued when the MtTcpListenerMgr, listening -at the given address and port, has completed shutdown. - -% MT_TCP_LISTENER_MGR_STOPPING Stopping MtTcpListenerMgr for %1:%2 -This debug messages is issued when the MtTcpListenerMgr, listening -at the given address and port, has begun to shutdown. diff --git a/src/lib/tcp/tests/tcp_test_listener.h b/src/lib/tcp/tests/tcp_test_listener.h index a09db5f3fa..5522484a84 100644 --- a/src/lib/tcp/tests/tcp_test_listener.h +++ b/src/lib/tcp/tests/tcp_test_listener.h @@ -290,7 +290,7 @@ protected: /// @brief Id to use for the next connection. size_t next_connection_id_; - /// @brief Callback connection invokes in requestReceived to construct a respsonse. + /// @brief Callback connection invokes in requestReceived to construct a response. TcpTestConnection::ResponseHandler response_handler_; public: diff --git a/src/lib/util/buffer.h b/src/lib/util/buffer.h index 3e569b2994..4f918566af 100644 --- a/src/lib/util/buffer.h +++ b/src/lib/util/buffer.h @@ -282,7 +282,7 @@ protected: /// /// Note to developers: it may make more sense to introduce an abstract base /// class for the \c OutputBuffer and define the simple implementation as a -/// a concrete derived class. That way we can provide flexibility for future +/// concrete derived class. That way we can provide flexibility for future /// extension such as more efficient buffer implementation or allowing users /// to have their own customized version without modifying the source code. /// We in fact considered that option, but at the moment chose the simpler diff --git a/src/lib/yang/translator.h b/src/lib/yang/translator.h index 2cb38a33eb..5413824b40 100644 --- a/src/lib/yang/translator.h +++ b/src/lib/yang/translator.h @@ -202,9 +202,8 @@ public: /// in the sysrepo datastore by calling Session::getData(). It should be /// used sparingly in production code. It is primarily meant for unit tests. /// - /// @param xpath the xpath to be travelled - /// @param f the function to be called on the node itself and each - /// descendant + /// @param xpath the xpath of the root node belonging to the the tree being traversed + /// @param f the function to be called on the node itself and each descendant template <typename functor_t> void forAll(std::string const& xpath, functor_t f) const { std::optional<libyang::DataNode> const& data_node(session_.getData(xpath)); |