From: William A. Rowe Jr Date: Wed, 27 Jun 2001 03:34:15 +0000 (+0000) Subject: Update docs to reflect API changes and typos. X-Git-Tag: 2.0.19~39 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3b24cc7824b07037ba5085d97c22e1ee68f8e1a4;p=thirdparty%2Fapache%2Fhttpd.git Update docs to reflect API changes and typos. Harrie Hazewinkel git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@89426 13f79535-47bb-0310-9956-ffa450edef68 --- diff --git a/docs/manual/developer/debugging.html b/docs/manual/developer/debugging.html index 581f1b8c580..4cc3b02e7da 100644 --- a/docs/manual/developer/debugging.html +++ b/docs/manual/developer/debugging.html @@ -130,7 +130,7 @@ the modes available and gives instructions on activating them.

Activating Debugging Options

-

The various options for debugging memory are now enabled in the apr_general.h header file in APR. The various options are enabled by uncommenting the define for the option you wish to use. The section of the code currently looks like this (contained in src/lib/apr/inclide/apr_general.h)

+

The various options for debugging memory are now enabled in the apr_general.h header file in APR. The various options are enabled by uncommenting the define for the option you wish to use. The section of the code currently looks like this (contained in srclib/apr/include/apr_pools.h)

 /*
diff --git a/docs/manual/developer/hooks.html b/docs/manual/developer/hooks.html
index 6ab1ad6b74b..715c13626d6 100644
--- a/docs/manual/developer/hooks.html
+++ b/docs/manual/developer/hooks.html
@@ -28,13 +28,13 @@ comparison to other modules.

 
 
Declare the hook function

 
-
Use the DECLARE_HOOK macro, which needs to be given the name of the
-hook, the return type of the hook function and the arguments. For
+
Use the AP_DECLARE_HOOK macro, which needs to be given the return
+type of the hook function, the name of the hook, and the arguments. For
 example, if the hook returns an int and takes a
 request_rec * and an int and is called
 "do_something", then declare it like this:

 
-DECLARE_HOOK(int,do_something,(request_rec *r,int n))
+AP_DECLARE_HOOK(int,do_something,(request_rec *r,int n))
 
 
This should go in a header which modules will include if they want
 to use the hook.

@@ -46,8 +46,8 @@ is used to record the module functions that use the hook. This is
 declared as follows:

 
 
-HOOK_STRUCT(
-            HOOK_LINK(do_something)
+APR_HOOK_STRUCT(
+            APR_HOOK_LINK(do_something)
             ...
            )
 

@@ -64,7 +64,7 @@ this. In all cases, the calling function is called
 
If the return value of a hook is void, then all the hooks are
 called, and the caller is implemented like this:

 
-IMPLEMENT_HOOK_VOID(do_something,(request_rec *r,int
+AP_IMPLEMENT_HOOK_VOID(do_something,(request_rec *r,int
 n),(r,n))
 
 
The second and third arguments are the dummy argument declaration and
@@ -84,7 +84,7 @@ void ap_run_do_something(request_rec *r,int n)
 
If the hook returns a value, then it can either be run until the first
 hook that does something interesting, like so:

 
-IMPLEMENT_HOOK_RUN_FIRST(int,do_something,(request_rec *r,int n),(r,n),DECLINED)
+AP_IMPLEMENT_HOOK_RUN_FIRST(int,do_something,(request_rec *r,int n),(r,n),DECLINED)
 
 
The first hook that doesn't return DECLINED stops
 the loop and its return value is returned from the hook caller. Note
@@ -98,7 +98,7 @@ nothing". The first function that returns a value other than one of
 those two stops the loop, and its return is the return value. Declare
 these like so:

 
-IMPLEMENT_HOOK_RUN_ALL(int,do_something,(request_rec *r,int
+AP_IMPLEMENT_HOOK_RUN_ALL(int,do_something,(request_rec *r,int
 n),(r,n),OK,DECLINED)
 
 
Again, OK and DECLINED are the traditional
diff --git a/docs/manual/developer/modules.html b/docs/manual/developer/modules.html
index 8a265f5ec15..6237f961ea4 100644
--- a/docs/manual/developer/modules.html
+++ b/docs/manual/developer/modules.html
@@ -35,20 +35,20 @@ These now need to be of type ap_status_t and return a value of that type.  Norma
 These should now be renamed to better signify where they sit in the overall process.  So the name gets a small change from mmap_init to mmap_post_config.  The arguments passed have undergone a radical change and now look like
 

 
    
-
  • ap_context_t *p,
    • 
-
  • ap_context_t *plog,
    • 
-
  • ap_context_t *ptemp,
    • 
+
  • apr_pools_t *p,
    • 
+
  • apr_pools_t *plog,
    • 
+
  • apr_pools_t *ptemp,
    • 
 
  • server_rec *s
    • 
 

 

-Throughout Apache the old pools have been replced by the ap_context_t, though their use remains remarkably similar.
+Throughout Apache the old pools have been replced by the apr_pools_t, though their use remains remarkably similar.
 

 
 
Data Types

 

 A lot of the data types have been moved into the APR.  This means that some have had a name change, such as the one shown above.  The following is a brief list of some of the changes that you are likely to have to make.
 
    
-
  • pool becomes ap_context_t
    • 
+
  • pool becomes apr_pools_t
    • 
 
  • table becomes ap_table_t
    • 
 

 

@@ -171,26 +171,65 @@ The remainder of the old functions should be registered as hooks.  There are the
 ap_hook_post_config  (this is where the old _init routines get registered)
 
 
  • 
-ap_hook_http_method
+ap_hook_http_method  (retrieve the http method from a request.  (legacy))
 
    • 
 
  • 
-ap_hook_open_logs
+ap_hook_open_logs  (open any specified logs)
 
    • 
 
  • 
-ap_hook_auth_checker
+ap_hook_auth_checker  (check if the resource requires authorization)
 
    • 
 
  • 
-ap_hook_default_port
+ap_hook_access_checker  (check for module-specific restrictions)
 
    • 
 
  • 
-ap_hook_access_checker
+ap_hook_check_user_id  (check the user-id and password)
 
    • 
 
  • 
-ap_hook_process_connection
+ap_hook_default_port  (retrieve the default port for the server)
 
    • 
 
  • 
-ap_hook_child_init_hook
+ap_hook_pre_connection  (do any setup required just before processing, but after accepting)
 
    • 
+
  • 
+ap_hook_process_connection  (run the correct protocol)
+
    • 
+
  • 
+ap_hook_child_init  (call as soon as the child is started)
+
    • 
+
  • 
+ap_hook_create_request  (??)
+
    • 
+
  • 
+ap_hook_fixups  (last chance to modify things before generating content)
+
    • 
+
  • 
+ap_hook_handler  (generate the content)
+
    • 
+
  • 
+ap_hook_header_parser  (let's modules look at the headers, not used by most modules, because they use post_read_request for this.)
+
    • 
+
  • 
+ap_hook_insert_filter  (to insert filters into the filter chain)
+
    • 
+
  • 
+ap_hook_log_transaction  (log information about the request)
+
    • 
+
  • 
+ap_hook_optional_fn_retrieve  (retrieve any functions registered as optional)
+
    • 
+
  • 
+ap_hook_post_read_request  (called after reading the request, before any other phase)
+
    • 
+
  • 
+ap_hook_quick_handler  (??)
+
    • 
+
  • 
+ap_hook_translate_name  (translate the URI into a filename)
+
    • 
+
  • 
+ap_hook_type_checker  (determine and/or set the doc type)
+
 
 
 
diff --git a/docs/manual/developer/modules.html.en b/docs/manual/developer/modules.html.en
index 8a265f5ec15..6237f961ea4 100644
--- a/docs/manual/developer/modules.html.en
+++ b/docs/manual/developer/modules.html.en
@@ -35,20 +35,20 @@ These now need to be of type ap_status_t and return a value of that type.  Norma
 These should now be renamed to better signify where they sit in the overall process.  So the name gets a small change from mmap_init to mmap_post_config.  The arguments passed have undergone a radical change and now look like
 
    
 
      
-
    • ap_context_t *p,
      • 
-
    • ap_context_t *plog,
      • 
-
    • ap_context_t *ptemp,
      • 
+
    • apr_pools_t *p,
      • 
+
    • apr_pools_t *plog,
      • 
+
    • apr_pools_t *ptemp,
      • 
 
    • server_rec *s
      • 
 
    
 
    
-Throughout Apache the old pools have been replced by the ap_context_t, though their use remains remarkably similar.
+Throughout Apache the old pools have been replced by the apr_pools_t, though their use remains remarkably similar.
 
    
 
 
    Data Types
    
 
    
 A lot of the data types have been moved into the APR.  This means that some have had a name change, such as the one shown above.  The following is a brief list of some of the changes that you are likely to have to make.
 
      
-
    • pool becomes ap_context_t
      • 
+
    • pool becomes apr_pools_t
      • 
 
    • table becomes ap_table_t
      • 
 
    
 
    
@@ -171,26 +171,65 @@ The remainder of the old functions should be registered as hooks.  There are the
 ap_hook_post_config  (this is where the old _init routines get registered)
 
    • 
 
  • 
-ap_hook_http_method
+ap_hook_http_method  (retrieve the http method from a request.  (legacy))
 
    • 
 
  • 
-ap_hook_open_logs
+ap_hook_open_logs  (open any specified logs)
 
    • 
 
  • 
-ap_hook_auth_checker
+ap_hook_auth_checker  (check if the resource requires authorization)
 
    • 
 
  • 
-ap_hook_default_port
+ap_hook_access_checker  (check for module-specific restrictions)
 
    • 
 
  • 
-ap_hook_access_checker
+ap_hook_check_user_id  (check the user-id and password)
 
    • 
 
  • 
-ap_hook_process_connection
+ap_hook_default_port  (retrieve the default port for the server)
 
    • 
 
  • 
-ap_hook_child_init_hook
+ap_hook_pre_connection  (do any setup required just before processing, but after accepting)
 
    • 
+
  • 
+ap_hook_process_connection  (run the correct protocol)
+
    • 
+
  • 
+ap_hook_child_init  (call as soon as the child is started)
+
    • 
+
  • 
+ap_hook_create_request  (??)
+
    • 
+
  • 
+ap_hook_fixups  (last chance to modify things before generating content)
+
    • 
+
  • 
+ap_hook_handler  (generate the content)
+
    • 
+
  • 
+ap_hook_header_parser  (let's modules look at the headers, not used by most modules, because they use post_read_request for this.)
+
    • 
+
  • 
+ap_hook_insert_filter  (to insert filters into the filter chain)
+
    • 
+
  • 
+ap_hook_log_transaction  (log information about the request)
+
    • 
+
  • 
+ap_hook_optional_fn_retrieve  (retrieve any functions registered as optional)
+
    • 
+
  • 
+ap_hook_post_read_request  (called after reading the request, before any other phase)
+
    • 
+
  • 
+ap_hook_quick_handler  (??)
+
    • 
+
  • 
+ap_hook_translate_name  (translate the URI into a filename)
+
    • 
+
  • 
+ap_hook_type_checker  (determine and/or set the doc type)
+