From a80281eda5cb9b6061c6b4480cac4d0e0effc649 Mon Sep 17 00:00:00 2001 From: Daniel Gruno Date: Sat, 14 Apr 2012 06:54:08 +0000 Subject: [PATCH] Get the rest up to speed as well git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1326058 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/developer/documenting.xml | 4 ++-- docs/manual/developer/hooks.xml | 23 +++++++++++------------ docs/manual/developer/request.xml | 12 ++++++------ docs/manual/developer/thread_safety.xml | 4 ++-- 4 files changed, 21 insertions(+), 22 deletions(-) diff --git a/docs/manual/developer/documenting.xml b/docs/manual/developer/documenting.xml index b398cd3cba..77631189d3 100644 --- a/docs/manual/developer/documenting.xml +++ b/docs/manual/developer/documenting.xml @@ -23,10 +23,10 @@ Developer Documentation -Documenting Apache 2.0 +Documenting code in Apache 2.4 -

Apache 2.0 uses Doxygen to +

Apache 2.4 uses Doxygen to document the APIs and global variables in the code. This will explain the basics of how to document using Doxygen.

 diff --git a/docs/manual/developer/hooks.xml b/docs/manual/developer/hooks.xml index b1218ce1a8..46d778c307 100644 --- a/docs/manual/developer/hooks.xml +++ b/docs/manual/developer/hooks.xml @@ -23,7 +23,7 @@ Developer Documentation -Apache 2.0 Hook Functions +Hook Functions in the Apache HTTP Server 2.x Warning @@ -31,10 +31,10 @@ date.

 -

In general, a hook function is one that Apache will call at - some point during the processing of a request. Modules can - provide functions that are called, and specify when they get - called in comparison to other modules.

+

In general, a hook function is one that the Apache HTTP Server + will call at some point during the processing of a request. + Modules can provide functions that are called, and specify when + they get called in comparison to other modules.
Creating a hook function @@ -110,8 +110,8 @@

The first hook that does not return DECLINED stops the loop and its return value is returned from the hook - caller. Note that DECLINED is the tradition Apache - hook return meaning "I didn't do anything", but it can be + caller. Note that DECLINED is the traditional + hook return value meaning "I didn't do anything", but it can be whatever suits you.

Alternatively, all hooks can be run until an error occurs. @@ -163,7 +163,7 @@

Add a hook registering function -

During initialisation, Apache will call each modules hook +

During initialisation, the server will call each modules hook registering function, which is included in the module structure:

@@ -198,9 +198,9 @@ order relative to each other, but, of course, all modules using APR_HOOK_FIRST will be run before APR_HOOK_MIDDLE which are before APR_HOOK_LAST. Modules that don't care - when they are run should use APR_HOOK_MIDDLE. (I spaced - these out so people could do stuff like APR_HOOK_FIRST-2 - to get in slightly earlier, but is this wise? - Ben)

+ when they are run should use APR_HOOK_MIDDLE. These + values are spaced out, so that positions like APR_HOOK_FIRST-2 + are possible to hook slightly earlier than other functions.

Note that there are two more values, APR_HOOK_REALLY_FIRST and APR_HOOK_REALLY_LAST. These @@ -229,7 +229,6 @@ ordering set by APR_HOOK_ORDER is preserved, as far as is possible.

-

Ben Laurie, 15th August 1999

 diff --git a/docs/manual/developer/request.xml b/docs/manual/developer/request.xml index 6e707b9ac5..ae2613d16d 100644 --- a/docs/manual/developer/request.xml +++ b/docs/manual/developer/request.xml @@ -23,7 +23,7 @@ Developer Documentation -Request Processing in Apache 2.0 +Request Processing in the Apache HTTP Server 2.x Warning @@ -31,15 +31,15 @@ revision!

 -

Several changes in Apache 2.0 affect the internal request +

Several changes in 2.0 and above affect the internal request processing mechanics. Module authors need to be aware of these changes so they may take advantage of the optimizations and security enhancements.

The first major change is to the subrequest and redirect mechanisms. There were a number of different code paths in - Apache 1.3 to attempt to optimize subrequest or redirect - behavior. As patches were introduced to 2.0, these + the Apache HTTP Server 1.3 to attempt to optimize subrequest + or redirect behavior. As patches were introduced to 2.0, these optimizations (and the server behavior) were quickly broken due to this duplication of code. All duplicate code has been folded back into ap_process_request_internal() to prevent @@ -50,7 +50,7 @@ and correct implementation of the HTTP server RFC. Additional goals include security, scalability and optimization. New methods were sought to optimize the server (beyond the - performance of Apache 1.3) without introducing fragile or + performance of 1.3) without introducing fragile or insecure code.

 @@ -63,7 +63,7 @@

To streamline requests, the module author can take advantage of the hooks offered to drop out of the request cycle early, or - to bypass core Apache hooks which are irrelevant (and costly in + to bypass core hooks which are irrelevant (and costly in terms of CPU.)

diff --git a/docs/manual/developer/thread_safety.xml b/docs/manual/developer/thread_safety.xml index c3c0ca6255..4c92753f9e 100644 --- a/docs/manual/developer/thread_safety.xml +++ b/docs/manual/developer/thread_safety.xml @@ -23,10 +23,10 @@ Developer Documentation -Apache 2.0 Thread Safety Issues +Apache HTTP Server 2.x Thread Safety Issues -

When using any of the threaded mpms in Apache 2.0 it is important +

When using any of the threaded mpms in the Apache HTTP Server 2.x it is important that every function called from Apache be thread safe. When linking in 3rd party extensions it can be difficult to determine whether the resulting server will be thread safe. Casual testing generally won't tell you this -- 2.40.0