Browse Source

[3857] Alterations to DSO/shared library text in hooks documentation

Stephen Morris 10 years ago
parent
commit
2075033300
2 changed files with 8 additions and 10 deletions
  1. 2 3
      src/lib/hooks/hooks_component_developer.dox
  2. 6 7
      src/lib/hooks/hooks_user.dox

+ 2 - 3
src/lib/hooks/hooks_component_developer.dox

@@ -20,9 +20,8 @@
 The hooks framework is a Kea system that simplifies the way that
 The hooks framework is a Kea system that simplifies the way that
 users can write code to modify the behavior of Kea.  Instead of
 users can write code to modify the behavior of Kea.  Instead of
 altering the Kea source code, they write functions that are compiled
 altering the Kea source code, they write functions that are compiled
-and linked into a dynamic shared object called here a shared library
+and linked into one or more dynamic shared objects, called here (for
-(even the concepts are different they are implemented in the same
+historical reasons), shared libraries.  The library is specified in the Kea
-way with a common naming).  The library is specified in the Kea
 configuration and at run time Kea dynamically loads the library
 configuration and at run time Kea dynamically loads the library
 into its address space.  At various points in the processing, the component
 into its address space.  At various points in the processing, the component
 "calls out" to functions in the library, passing to them the data is it
 "calls out" to functions in the library, passing to them the data is it

+ 6 - 7
src/lib/hooks/hooks_user.dox

@@ -50,13 +50,12 @@ to as "user code".)  At specific points in its processing
 data that the user code can examine and, if required, modify.
 data that the user code can examine and, if required, modify.
 Kea uses the modified data in the remainder of its processing.
 Kea uses the modified data in the remainder of its processing.
 
 
-In order to minimize the interaction between Kea and the user
+In order to minimize the interaction between Kea and the user code,
-code, the latter is built independently of Kea in the form of
+the latter is built independently of Kea in the form of one or more
-a dynamic shared object (or objects). Even they are conceptually
+dynamic shared objects, called here (for historical reasons), shared
-different dynamic shared objects are called here shared libraries.
+libraries.  These are made known to Kea through its configuration
-These are made known to Kea through its configuration mechanism, and
+mechanism, and Kea loads the library at run time. Libraries can be
-Kea loads the library at run time. Libraries can be unloaded and
+unloaded and reloaded as needed while Kea is running.
-reloaded as needed while Kea is running.
 
 
 Use of a defined API and the Kea configuration mechanism means that
 Use of a defined API and the Kea configuration mechanism means that
 as new versions of Kea are released, there is no need to modify
 as new versions of Kea are released, there is no need to modify