]> git.ipfire.org Git - thirdparty/kea.git/commitdiff
[#996] Addressed comments
authorFrancis Dupont <fdupont@isc.org>
Fri, 3 Jul 2020 15:07:01 +0000 (17:07 +0200)
committerFrancis Dupont <fdupont@isc.org>
Fri, 3 Jul 2020 17:10:39 +0000 (19:10 +0200)
src/lib/asiolink/asiolink.dox
src/lib/database/database.dox
src/lib/dhcpsrv/database_backends.dox
src/lib/http/http.dox
src/lib/util/util.dox
src/lib/yang/yang.dox

index 09443f2b20525aada1307ff60d6f49233b6331a8..0c01b12685fc1b94793a9f6725ecd5569685644d 100644 (file)
@@ -49,7 +49,7 @@ The asiolink library (libkea-asiolink) encapsulates Boost ASIO tools:
 
 @section asiolinkMTConsiderations Multi-Threading Consideration for Boost ASIO Utilities
 
-By default Boost ASIO utilities are not thread safe even Boost ASIO tools
+By default Boost ASIO utilities are not thread safe even if Boost ASIO tools
 themselves are. When there is no state and the encapsulation is direct
 the thread safety property is preserved. Exceptions to the by default
 no thread safe are:
index 57d2fd7dc419b69977a9d004c16403f574726fd9..63c78825bf0646bc3a7305be69f54421da786fe4 100644 (file)
@@ -9,7 +9,7 @@
 
 @section databaseMTConsiderations Multi-Threading Consideration for Database
 
-MySQL and PostgreSQL provide connection pools which is used to make
+MySQL and PostgreSQL provide connection pools which are used to make
 lease, host and legal log backends thread safe. Cassandra/CQL is
 thread safe by design.
 
@@ -19,7 +19,7 @@ a transaction). For MySQL this means that transactions must be supported
 by the database engine (the engine selection is done in the schema).
 
 Note the InnoDB engine used by Kea for MySQL databases cancels a transaction
-when a deadlock is detected (rare but possible event) and leaves the charge
-to retry the transaction to the caller.
+when a deadlock is detected (rare but possible event) and leaves the
+responsibility to retry the transaction to the caller.
 
 */
index 0a9897f82cd3db9afa58026c8e143110ff188e36..38caab268cc7483791cb4259205267727ce9e357 100644 (file)
 @section dhcpDatabaseBackendsMTConsiderations Multi-Threading Consideration for DHCP Database Backends
 
 Lease and host database backends including the memfile for leases are Kea
-(i.e. when the multi-threading mode is true) thread safe. This extends
-to legal / forensic log backends but not to config backends which is
-used only for configuration by the main thread with packet processing
-threads stopped so has no thread safety requirements.
+thread safe (i.e. are thread safe when the multi-threading mode is true).
+This extends to legal / forensic log backends but not to config
+backends which is used only for configuration by the main thread with
+packet processing threads stopped so has no thread safety
+requirements.
 
 There are exceptions:
 
@@ -219,7 +220,7 @@ There are exceptions:
 Note for statistics queries it does not make sense to call them with
 running packet processing threads so they have no thread safety guarantees.
 
-Note too the memfile backend is not inter-process safe so must be kept
+Note too that the memfile backend is not inter-process safe so must be kept
 private to the Kea server using it.
 
   */
index 4636a7401a03a2526bb77785d274507a5ab53489..c6e49337f079ae9b564158c05aa47be5ffc95196 100644 (file)
@@ -12,8 +12,8 @@
 By default this library is not thread safe, for instance HTTP listeners
 and HTTP messages are not thread safe. Exceptions are:
 
- - HTTP client is Kea (i.e. when the multi-threading mode is treu)
-  thread safe.
+ - HTTP client is Kea thread safe (i.e. is thread safe when the
+  multi-threading mode is true).
 
  - date time is thread safe (mainly because its encapsulated POSIX time
   is private and read-only, or because all methods are instance const methods
index 8a38e7bb8b3c924edc143164a0e8a901a2204af6..8781f2f555c0704b4980d489df0c9973ca049cdf 100644 (file)
@@ -50,12 +50,12 @@ The utilities library (libkea-util) provides generic and Kea utilities:
 
  - read-write mutex (header only).
 
- - signal set: signal handling (please @c isc::process::IOSignalSet instead).
+ - signal set: signal handling (please use @c isc::process::IOSignalSet
+  instead).
 
  - staged values.
 
- - state model: event-driven deterministic finite state automaton
-  (to accept a regular language).
+ - state model: event-driven deterministic finite state machine.
 
  - stop watch: to measure code execution time.
 
index 57959a1f47a495ec24bc7041ff109d9c3c45ad6e..c9aaf9b04d4606f9b5d922684918f2afdd5faecf 100644 (file)
@@ -1,4 +1,4 @@
-K// Copyright (C) 2018-2020 Internet Systems Consortium, Inc. ("ISC")
+// Copyright (C) 2018-2020 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