Browse Source

[3063] Minor corrections in Maintenance Guide.

Tomek Mrugalski 11 years ago
parent
commit
7fef2d7ffd
1 changed files with 6 additions and 2 deletions
  1. 6 2
      src/lib/hooks/hooks_maintenance.dox

+ 6 - 2
src/lib/hooks/hooks_maintenance.dox

@@ -31,7 +31,7 @@
 
 
  @section hooksmgObjects Hooks Framework Objects
  @section hooksmgObjects Hooks Framework Objects
 
 
- The relationships betweeh the various objects in the hooks framework
+ The relationships between the various objects in the hooks framework
  is shown below:
  is shown below:
 
 
  @image html HooksUml.png "High-Level Class Diagram of the Hooks Framework"
  @image html HooksUml.png "High-Level Class Diagram of the Hooks Framework"
@@ -116,9 +116,13 @@
  a copy of the vector is taken before the iteration starts.  The @ref
  a copy of the vector is taken before the iteration starts.  The @ref
  hooksmgCalloutManager iterates over this copy while any changes made
  hooksmgCalloutManager iterates over this copy while any changes made
  by the callout registration functions affect the relevant callout vector.
  by the callout registration functions affect the relevant callout vector.
+ Such approach was chosen because of performance considerations.
 
 
  @subsection hooksmgServerObjects Server-Side Objects
  @subsection hooksmgServerObjects Server-Side Objects
 
 
+ Those objects are not accessible by user libraries. Please do not
+ attempt to use them if you are developing user callouts.
+
  @subsubsection hooksmgServerHooks Server Hooks
  @subsubsection hooksmgServerHooks Server Hooks
 
 
  The singleton @ref isc::hooks::ServerHooks object is used to register
  The singleton @ref isc::hooks::ServerHooks object is used to register
@@ -195,7 +199,7 @@
  The @ref isc::hooks::CalloutManager is the core of the framework insofar
  The @ref isc::hooks::CalloutManager is the core of the framework insofar
  as the registration and calling of callouts is concerned.
  as the registration and calling of callouts is concerned.
 
 
- It maintains a "hook vector - a vector with one element for
+ It maintains a "hook vector" - a vector with one element for
  each registered hook. Each element in this vector is itself a
  each registered hook. Each element in this vector is itself a
  vector (the callout vector), each element of which is a pair of
  vector (the callout vector), each element of which is a pair of
  (library index, callback pointer). When a callout is registered, the
  (library index, callback pointer). When a callout is registered, the