[#3242] Addressed comments, added ChangeLog entry

Minor cosmetic fixes.
isc-projects · Feb 16, 2024 · 14d348b · 14d348b
1 parent d251bf7
commit 14d348b
Show file tree

Hide file tree

Showing 11 changed files with 17 additions and 11 deletions.
diff --git a/ChangeLog b/ChangeLog
@@ -1,3 +1,9 @@
+2204.	[func]		tmark
+	The skeleton of a new open source hook library,
+	libdhcp_perfmon.so, has been added.  The library is
+	still in development and does yet provide any functionality.
+	(Gitlab #3242)
+
 Kea 2.5.5 (development) released on January 31, 2024
 
 2203.	[build]		razvan

diff --git a/doc/sphinx/arm/logging.rst b/doc/sphinx/arm/logging.rst
@@ -427,7 +427,7 @@ libraries), or hook libraries (open source or premium).
    |                                  |                                       | message carried in             |
    |                                  |                                       | the packet is parsed.          |
    +----------------------------------+---------------------------------------+--------------------------------+
-   | ``kea-dhcp4.perfmon-hooks``      | :ischooklib:`libdhcp_perfmon.so`      | Used                           |
+   | ``kea-dhcp4.perfmon-hooks``,     | :ischooklib:`libdhcp_perfmon.so`      | Used                           |
    | ``kea-dhcp6.perfmon-hooks``      | open-source hook library              | to log messages related to     |
    |                                  |                                       | performan monitoring.          |
    +----------------------------------+---------------------------------------+--------------------------------+

diff --git a/src/hooks/dhcp/bootp/libloadtests/load_unload_unittests.cc b/src/hooks/dhcp/bootp/libloadtests/load_unload_unittests.cc
@@ -49,7 +49,7 @@ TEST_F(BootpLibLoadTest, validLoad4) {
     validDaemonTest("kea-dhcp4");
 }
 
-// Simple V6 test that checks the library cannot by loaded by invalid daemons.
+// Simple test that checks the library cannot by loaded by invalid daemons.
 TEST_F(BootpLibLoadTest, invalidDaemonLoad) {
     invalidDaemonTest("kea-dhcp6", AF_INET6);
     invalidDaemonTest("kea-ctrl-agent");

diff --git a/src/hooks/dhcp/lease_cmds/libloadtests/load_unload_unittests.cc b/src/hooks/dhcp/lease_cmds/libloadtests/load_unload_unittests.cc
@@ -54,7 +54,7 @@ TEST_F(LeaseCmdsCbLibLoadTest, validLoad6) {
     validDaemonTest("kea-dhcp6", AF_INET6);
 }
 
-// Simple V6 test that checks the library cannot by loaded by invalid daemons.
+// Simple test that checks the library cannot by loaded by invalid daemons.
 TEST_F(LeaseCmdsCbLibLoadTest, invalidDaemonLoad) {
     invalidDaemonTest("kea-ctrl-agent");
     invalidDaemonTest("kea-dhcp-ddns");

diff --git a/src/hooks/dhcp/mysql_cb/libloadtests/load_unload_unittests.cc b/src/hooks/dhcp/mysql_cb/libloadtests/load_unload_unittests.cc
@@ -54,7 +54,7 @@ TEST_F(MySqlCbLibLoadTest, validLoad6) {
     validDaemonTest("kea-dhcp6", AF_INET6);
 }
 
-// Simple V6 test that checks the library cannot by loaded by invalid daemons.
+// Simple test that checks the library cannot by loaded by invalid daemons.
 TEST_F(MySqlCbLibLoadTest, invalidDaemonLoad) {
     invalidDaemonTest("kea-ctrl-agent");
     invalidDaemonTest("kea-dhcp-ddns");

diff --git a/src/hooks/dhcp/perfmon/Makefile.am b/src/hooks/dhcp/perfmon/Makefile.am
@@ -1,4 +1,4 @@
-SUBDIRS = . tests libloadtests
+SUBDIRS = . libloadtests tests
 
 AM_CPPFLAGS  = -I$(top_builddir)/src/lib -I$(top_srcdir)/src/lib
 AM_CPPFLAGS += $(BOOST_INCLUDES)

diff --git a/src/hooks/dhcp/perfmon/libloadtests/load_unload_unittests.cc b/src/hooks/dhcp/perfmon/libloadtests/load_unload_unittests.cc
@@ -31,7 +31,7 @@ using namespace isc::process;
 
 namespace {
 
-/// @brief Test fixture for testing loading and unloading the stat cmds library
+/// @brief Test fixture for testing loading and unloading the perfmon library
 class PerfMonLibLoadTest : public isc::test::LibLoadTest {
 public:
     /// @brief Constructor
@@ -54,7 +54,7 @@ TEST_F(PerfMonLibLoadTest, validLoad6) {
     validDaemonTest("kea-dhcp6", AF_INET6);
 }
 
-// Simple V6 test that checks the library cannot by loaded by invalid daemons.
+// Simple test that checks the library cannot by loaded by invalid daemons.
 TEST_F(PerfMonLibLoadTest, invalidDaemonLoad) {
     invalidDaemonTest("kea-ctrl-agent");
     invalidDaemonTest("kea-dhcp-ddns");

diff --git a/src/hooks/dhcp/perfmon/perfmon.dox b/src/hooks/dhcp/perfmon/perfmon.dox
@@ -25,7 +25,7 @@ PerfMon (or perfmon) is a Hook library that can be loaded by
 either kea-dhcp4 and kea-dhcp6 servers to extend them with the
 ability to track and report performance related data.
 
-The initial purpose of this library is provide supplemental data and
+The initial purpose of this library is to provide supplemental data and
 commands for monitoring the performance of kea-dhcp4 and kea-dhcp6
 servers in real time.
 

diff --git a/src/hooks/dhcp/perfmon/perfmon_log.h b/src/hooks/dhcp/perfmon/perfmon_log.h
@@ -16,7 +16,7 @@ namespace perfmon {
 
 extern isc::log::Logger perfmon_logger;
 
-} // end of isc::perfmon
+} // end of isc::perfmon namespace
 } // end of isc namespace
 
 

diff --git a/src/hooks/dhcp/pgsql_cb/libloadtests/load_unload_unittests.cc b/src/hooks/dhcp/pgsql_cb/libloadtests/load_unload_unittests.cc
@@ -54,7 +54,7 @@ TEST_F(PgSqlCbLibLoadTest, validLoad6) {
     validDaemonTest("kea-dhcp6", AF_INET6);
 }
 
-// Simple V6 test that checks the library cannot by loaded by invalid daemons.
+// Simple test that checks the library cannot by loaded by invalid daemons.
 TEST_F(PgSqlCbLibLoadTest, invalidDaemonLoad) {
     invalidDaemonTest("kea-ctrl-agent");
     invalidDaemonTest("kea-dhcp-ddns");

diff --git a/src/hooks/dhcp/stat_cmds/libloadtests/load_unload_unittests.cc b/src/hooks/dhcp/stat_cmds/libloadtests/load_unload_unittests.cc
@@ -54,7 +54,7 @@ TEST_F(StatCmdsCbLibLoadTest, validLoad6) {
     validDaemonTest("kea-dhcp6", AF_INET6);
 }
 
-// Simple V6 test that checks the library cannot by loaded by invalid daemons.
+// Simple test that checks the library cannot by loaded by invalid daemons.
 TEST_F(StatCmdsCbLibLoadTest, invalidDaemonLoad) {
     invalidDaemonTest("kea-ctrl-agent");
     invalidDaemonTest("kea-dhcp-ddns");