You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by mi...@apache.org on 2020/07/03 12:29:55 UTC
svn commit: r1879471 - in /httpd/httpd/trunk/docs/manual:
developer/new_api_2_6.xml developer/new_api_2_6.xml.meta
new_features_2_6.xml new_features_2_6.xml.meta
Author: minfrin
Date: Fri Jul 3 12:29:55 2020
New Revision: 1879471
URL: http://svn.apache.org/viewvc?rev=1879471&view=rev
Log:
Add skeleton for new features docs for 2.6.
Added:
httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml
- copied, changed from r1879470, httpd/httpd/trunk/docs/manual/developer/new_api_2_4.xml
httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml.meta
- copied, changed from r1879470, httpd/httpd/trunk/docs/manual/developer/new_api_2_4.xml.meta
httpd/httpd/trunk/docs/manual/new_features_2_6.xml
- copied, changed from r1879470, httpd/httpd/trunk/docs/manual/new_features_2_4.xml
httpd/httpd/trunk/docs/manual/new_features_2_6.xml.meta
- copied, changed from r1879470, httpd/httpd/trunk/docs/manual/new_features_2_4.xml.meta
Copied: httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml (from r1879470, httpd/httpd/trunk/docs/manual/developer/new_api_2_4.xml)
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml?p2=httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml&p1=httpd/httpd/trunk/docs/manual/developer/new_api_2_4.xml&r1=1879470&r2=1879471&rev=1879471&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/developer/new_api_2_4.xml (original)
+++ httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml Fri Jul 3 12:29:55 2020
@@ -20,18 +20,18 @@
limitations under the License.
-->
-<manualpage metafile="new_api_2_4.xml.meta">
+<manualpage metafile="new_api_2_6.xml.meta">
-<title>API Changes in Apache HTTP Server 2.4 since 2.2</title>
+<title>API Changes in Apache HTTP Server 2.6 since 2.4</title>
<summary>
<p>This document describes changes to the Apache HTTPD API from
- version 2.2 to 2.4, that may be of interest to module/application
+ version 2.4 to 2.6, that may be of interest to module/application
developers and core hacks. As of the first GA release of the
- 2.4 branch API compatibility is preserved for the life of the
- 2.4 branch. (The
- <a href="http://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x/VERSIONING">VERSIONING</a>
- description for the 2.4 release provides more information about API
+ 2.6 branch API compatibility is preserved for the life of the
+ 2.6 branch. (The
+ <a href="http://svn.apache.org/repos/asf/httpd/httpd/branches/2.6.x/VERSIONING">VERSIONING</a>
+ description for the 2.6 release provides more information about API
compatibility.)</p>
<p>API changes fall into two categories: APIs that are altogether new,
@@ -39,7 +39,7 @@
further divided into those where all changes are backwards-compatible
(so existing modules can ignore them), and those that might
require attention by maintainers. As with the transition from
- HTTPD 2.0 to 2.2, existing modules and applications will require
+ HTTPD 2.2 to 2.4, existing modules and applications will require
recompiling and may call for some attention, but most should not
require any substantial updating (although some may be able to
take advantage of API changes to offer significant improvements).</p>
@@ -52,512 +52,45 @@
<section id="api_changes">
<title>Changed APIs</title>
- <section id="ap_expr">
- <title>ap_expr (NEW!)</title>
- <p>Introduces a new API to parse and evaluate boolean and algebraic
- expressions, including provision for a standard syntax and
- customised variants.</p>
- </section>
-
- <section id="ap_listen">
- <title>ap_listen (changed; backwards-compatible)</title>
- <p>Introduces a new API to enable httpd child processes to serve
- different purposes.</p>
- </section>
-
- <section id="ap_mpm">
- <title>ap_mpm (changed)</title>
- <p><code>ap_mpm_run</code> is replaced by a new <code>mpm</code> hook.
- Also <code>ap_graceful_stop_signalled</code> is lost, and
- <code>ap_mpm_register_timed_callback</code> is new.</p>
- </section>
-
- <section id="ap_regex">
- <title>ap_regex (changed)</title>
- <p>In addition to the existing regexp wrapper, a new higher-level API
- <code>ap_rxplus</code> is now provided. This provides the capability to
- compile Perl-style expressions like <code>s/regexp/replacement/flags</code>
- and to execute them against arbitrary strings. Support for regexp
- backreferences is also added.</p>
- </section>
-
- <section id="ap_slotmem">
- <title>ap_slotmem (NEW!)</title>
- <p>Introduces an API for modules to allocate and manage memory slots,
- most commonly for shared memory.</p>
- </section>
-
- <section id="ap_socache">
- <title>ap_socache (NEW!)</title>
- <p>API to manage a shared object cache.</p>
- </section>
-
- <section id="heartbeat">
- <title>heartbeat (NEW!)</title>
- <p>common structures for heartbeat modules</p>
- </section>
-
- <section id="ap_parse_htaccess">
- <title>ap_parse_htaccess (changed)</title>
- <p>The function signature for <code>ap_parse_htaccess</code> has been
- changed. A <code>apr_table_t</code> of individual directives allowed
- for override must now be passed (override remains).</p>
- </section>
-
- <section id="http_config">
- <title>http_config (changed)</title>
- <ul>
- <li>Introduces per-module, per-directory loglevels, including macro wrappers.</li>
- <li>New <code>AP_DECLARE_MODULE</code> macro to declare all modules.</li>
- <li>New <code>APLOG_USE_MODULE</code> macro necessary for per-module loglevels in
- multi-file modules.</li>
- <li>New API to retain data across module unload/load</li>
- <li>New <code>check_config</code> hook</li>
- <li>New <code>ap_process_fnmatch_configs()</code> function to process wildcards</li>
- <li>Change <code>ap_configfile_t</code>, <code>ap_cfg_getline()</code>,
- <code>ap_cfg_getc()</code> to return error codes, and add
- <code>ap_pcfg_strerror()</code> for retrieving an error description.</li>
- <li>Any config directive permitted in ACCESS_CONF context must now
- correctly handle being called from an .htaccess file via the new
- <directive module="core">AllowOverrideList</directive> directive.
- ap_check_cmd_context() accepts a new flag NOT_IN_HTACCESS to detect
- this case.</li>
- </ul>
- </section>
-
- <section id="http_core">
- <title>http_core (changed)</title>
- <ul>
- <li>REMOVED <code>ap_default_type</code>, <code>ap_requires</code>, all
- 2.2 authnz API</li>
- <li>Introduces Optional Functions for logio and authnz</li>
- <li>New function <code>ap_get_server_name_for_url</code> to support IPv6
- literals.</li>
- <li>New function <code>ap_register_errorlog_handler</code> to register error log
- format string handlers.</li>
- <li>Arguments of <code>error_log</code> hook have changed. Declaration has moved to
- <code>http_core.h</code>.</li>
- <li>New function <code>ap_state_query</code> to determine if the server is in the
- initial configuration preflight phase or not. This is both easier to
- use and more correct than the old method of creating a pool userdata
- entry in the process pool.</li>
- <li>New function <code>ap_get_conn_socket</code> to get the socket descriptor for a
- connection. This should be used instead of accessing the core
- connection config directly.</li>
- </ul>
- </section>
-
- <section id="httpd">
- <title>httpd (changed)</title>
- <ul>
- <li>Introduce per-directory, per-module loglevel</li>
- <li>New loglevels <code>APLOG_TRACEn</code></li>
- <li>Introduce errorlog ids for requests and connections</li>
- <li>Support for mod_request kept_body</li>
- <li>Support buffering filter data for async requests</li>
- <li>New <code>CONN_STATE</code> values</li>
- <li>Function changes: <code>ap_escape_html</code> updated;
- <code>ap_unescape_all</code>, <code>ap_escape_path_segment_buffer</code></li>
- <li>Modules that load other modules later than the <code>EXEC_ON_READ</code> config
- reading stage need to call <code>ap_reserve_module_slots()</code> or
- <code>ap_reserve_module_slots_directive()</code> in their
- <code>pre_config hook</code>.</li>
- <li>The useragent IP address per request can now be tracked
- independently of the client IP address of the connection, for
- support of deployments with load balancers.</li>
- </ul>
- </section>
-
- <section id="http_log">
- <title>http_log (changed)</title>
- <ul>
- <li>Introduce per-directory, per-module loglevel</li>
- <li>New loglevels <code>APLOG_TRACEn</code></li>
- <li><code>ap_log_*error</code> become macro wrappers (backwards-compatible if
- <code>APLOG_MARK</code> macro is used, except that is no longer possible to
- use <code>#ifdef</code> inside the argument list)</li>
- <li>piped logging revamped</li>
- <li><code>module_index</code> added to error_log hook</li>
- <li>new function: <code>ap_log_command_line</code></li>
- </ul>
- </section>
-
- <section id="http_request">
- <title>http_request (changed)</title>
- <ul>
- <li>New auth_internal API and auth_provider API</li>
- <li>New <code>EOR</code> bucket type</li>
- <li>New function <code>ap_process_async_request</code></li>
- <li>New flags <code>AP_AUTH_INTERNAL_PER_CONF</code> and
- <code>AP_AUTH_INTERNAL_PER_URI</code></li>
- <li>New <code>access_checker_ex</code> hook to apply additional access control
- and/or bypass authentication.</li>
- <li>New functions <code>ap_hook_check_access_ex</code>,
- <code>ap_hook_check_access</code>, <code>ap_hook_check_authn</code>,
- <code>ap_hook_check_authz</code> which accept
- <code>AP_AUTH_INTERNAL_PER_*</code> flags</li>
- <li>DEPRECATED direct use of <code>ap_hook_access_checker</code>,
- <code>access_checker_ex</code>, <code>ap_hook_check_user_id</code>,
- <code>ap_hook_auth_checker</code></li>
- </ul>
- <p>When possible, registering all access control hooks (including
- authentication and authorization hooks) using <code>AP_AUTH_INTERNAL_PER_CONF</code>
- is recommended. If all modules' access control hooks are registered
- with this flag, then whenever the server handles an internal
- sub-request that matches the same set of access control configuration
- directives as the initial request (which is the common case), it can
- avoid invoking the access control hooks another time.</p>
- <p>If your module requires the old behavior and must perform access
- control checks on every sub-request with a different URI from the
- initial request, even if that URI matches the same set of access
- control configuration directives, then use
- <code>AP_AUTH_INTERNAL_PER_URI</code>.</p>
- </section>
-
- <section id="mod_auth">
- <title>mod_auth (NEW!)</title>
- <p>Introduces the new provider framework for authn and authz</p>
- </section>
-
- <section id="mod_cache">
- <title>mod_cache (changed)</title>
- <p>Introduces a <code>commit_entity()</code> function to the cache provider
- interface, allowing atomic writes to cache. Add a <code>cache_status()</code>
- hook to report the cache decision. All private structures and functions were
- removed.</p>
- </section>
-
- <section id="mod_core">
- <title>mod_core (NEW!)</title>
- <p>This introduces low-level APIs to send arbitrary headers,
- and exposes functions to handle HTTP OPTIONS and TRACE.</p>
- </section>
-
- <section id="mod_cache_disk">
- <title>mod_cache_disk (changed)</title>
- <p>Changes the disk format of the disk cache to support atomic cache
- updates without locking. The device/inode pair of the body file is
- embedded in the header file, allowing confirmation that the header
- and body belong to one another.</p>
- </section>
-
- <section id="mod_disk_cache">
- <title>mod_disk_cache (renamed)</title>
- <p>The mod_disk_cache module has been renamed to mod_cache_disk in
- order to be consistent with the naming of other modules within the
- server.</p>
- </section>
-
- <section id="mod_request">
- <title>mod_request (NEW!)</title>
- <p>The API for <module>mod_request</module>, to make input data
- available to multiple application/handler modules where required,
- and to parse HTML form data.</p>
- </section>
-
- <section id="mpm_common">
- <title>mpm_common (changed)</title>
- <ul>
- <li>REMOVES: <code>accept</code>, <code>lockfile</code>, <code>lock_mech</code>,
- <code>set_scoreboard</code> (locking uses the new ap_mutex API)</li>
- <li>NEW API to drop privileges (delegates this platform-dependent
- function to modules)</li>
- <li>NEW Hooks: <code>mpm_query</code>, <code>timed_callback</code>, and
- <code>get_name</code></li>
- <li>CHANGED interfaces: <code>monitor</code> hook,
- <code>ap_reclaim_child_processes</code>,
- <code>ap_relieve_child_processes</code></li>
- </ul>
- </section>
-
- <section id="scoreboard">
- <title>scoreboard (changed)</title>
- <p><code>ap_get_scoreboard_worker</code> is made non-backwards-compatible
- as an alternative version is introduced. Additional proxy_balancer
- support. Child status stuff revamped.</p>
- </section>
-
- <section id="util_cookies">
- <title>util_cookies (NEW!)</title>
- <p>Introduces a new API for managing HTTP Cookies.</p>
- </section>
-
- <section id="util_ldap">
- <title>util_ldap (changed)</title>
- <p><em>no description available</em></p>
- </section>
-
- <section id="util_mutex">
- <title>util_mutex (NEW!)</title>
- <p>A wrapper for APR proc and global mutexes in httpd, providing
- common configuration for the underlying mechanism and location
- of lock files.</p>
- </section>
-
- <section id="util_script">
- <title>util_script (changed)</title>
- <p>NEW: <code>ap_args_to_table</code></p>
- </section>
-
- <section id="util_time">
- <title>util_time (changed)</title>
- <p>NEW: <code>ap_recent_ctime_ex</code></p>
+ <section id="ap_fill_me_in">
+ <title>ap_fill_me_in (NEW!)</title>
+ <p>Introduces a new API to fill me in.</p>
</section>
</section>
<section id="upgrading">
- <title>Specific information on upgrading modules from 2.2</title>
+ <title>Specific information on upgrading modules from 2.4</title>
- <section id="upgrading_logging">
- <title>Logging</title>
- <p>In order to take advantage of per-module loglevel configuration, any
- source file that calls the <code>ap_log_*</code> functions should declare
- which module it belongs to. If the module's module_struct is called
- <code>foo_module</code>, the following code can be used to remain
- backward compatible with HTTPD 2.0 and 2.2:</p>
- <example>
- #include <http_log.h><br/>
- <br/>
- #ifdef APLOG_USE_MODULE<br/>
- APLOG_USE_MODULE(foo);<br/>
- #endif
- </example>
- <p>Note: This is absolutely required for C++-language modules. It
- can be skipped for C-language modules, though that breaks
- module-specific log level support for files without it.</p>
- <p>The number of parameters of the <code>ap_log_*</code> functions and the
- definition of <code>APLOG_MARK</code> has changed. Normally, the change
- is completely transparent. However, changes are required if a
- module uses <code>APLOG_MARK</code> as a parameter to its own functions
- or if a module calls <code>ap_log_*</code> without passing
- <code>APLOG_MARK</code>. A module which uses wrappers
- around <code>ap_log_*</code> typically uses both of these constructs.</p>
-
- <p>The easiest way to change code which passes <code>APLOG_MARK</code> to
- its own functions is to define and use a different macro that expands to
- the parameters required by those functions, as <code>APLOG_MARK</code>
- should only be used when calling <code>ap_log_*</code>
- directly. In this way, the code will remain compatible with HTTPD 2.0
- and 2.2.</p>
-
- <p>Code which calls <code>ap_log_*</code> without passing
- <code>APLOG_MARK</code> will necessarily differ between 2.4 and earlier
- releases, as 2.4 requires a new third argument,
- <code>APLOG_MODULE_INDEX</code>.</p>
-
- <example>
- /* code for httpd 2.0/2.2 */<br />
- ap_log_perror(file, line, APLOG_ERR, 0, p, "Failed to allocate dynamic lock structure");<br />
- <br />
- /* code for httpd 2.4 */<br />
- ap_log_perror(file, line, APLOG_MODULE_INDEX, APLOG_ERR, 0, p, "Failed to allocate dynamic lock structure");<br />
- <br />
- </example>
-
- <p><code>ap_log_*error</code> are now implemented as macros. This means
- that it is no longer possible to use <code>#ifdef</code> inside the
- argument list of <code>ap_log_*error</code>, as this would cause
- undefined behavor according to C99.</p>
-
- <p>A <code>server_rec</code> pointer must be passed to
- <code>ap_log_error()</code> when called after startup. This
- was always appropriate, but there are even more limitations with
- a <code>NULL</code> <code>server_rec</code> in 2.4 than in
- previous releases. Beginning with 2.3.12, the global variable
- <code>ap_server_conf</code> can always be used as
- the <code>server_rec</code> parameter, as it will be
- <code>NULL</code> only when it is valid to pass <code>NULL</code>
- to <code>ap_log_error()</code>. <code>ap_server_conf</code>
- should be used only when a more appropriate <code>server_rec</code>
- is not available.</p>
-
- <p>Consider the following changes to take advantage of the new
- <code>APLOG_TRACE1..8</code> log levels:</p>
- <ul>
- <li>Check current use of <code>APLOG_DEBUG</code> and
- consider if one of the <code>APLOG_TRACEn</code> levels is
- more appropriate.</li>
- <li>If your module currently has a mechanism for configuring
- the amount of debug logging which is performed, consider
- eliminating that mechanism and relying on the use of
- different <code>APLOG_TRACEn</code> levels. If expensive
- trace processing needs to be bypassed depending on the
- configured log level, use the <code>APLOGtrace<em>n</em></code>
- and <code>APLOGrtrace<em>n</em></code> macros to first check
- if tracing is enabled.</li>
- </ul>
-
- <p>Modules sometimes add process id and/or thread id to their log
- messages. These ids are now logged by default, so it may not
- be necessary for the module to log them explicitly. (Users may
- remove them from the error log format, but they can be
- instructed to add it back if necessary for problem diagnosis.)</p>
+ <section id="upgrading_fillmein">
+ <title>Fill me in</title>
+ <p>In order to take advantage of fill me in.</p>
</section>
<section id="upgrading_byfunction">
<title>If your module uses these existing APIs...</title>
<dl>
- <dt><code>ap_default_type()</code></dt>
- <dd>This is no longer available; Content-Type must be configured
- explicitly or added by the application.</dd>
-
- <dt><code>ap_get_server_name()</code></dt>
- <dd>If the returned server name is used in a URL,
- use <code>ap_get_server_name_for_url()</code> instead. This new
- function handles the odd case where the server name is an IPv6
- literal address.</dd>
-
- <dt><code>ap_get_server_version()</code></dt>
- <dd>For logging purposes, where detailed information is
- appropriate, use <code>ap_get_server_description()</code>.
- When generating output, where the amount of information
- should be configurable by ServerTokens, use
- <code>ap_get_server_banner()</code>.</dd>
-
- <dt><code>ap_graceful_stop_signalled()</code></dt>
- <dd>Replace with a call
- to <code>ap_mpm_query(AP_MPMQ_MPM_STATE)</code> and checking for
- state <code>AP_MPMQ_STOPPING</code>.</dd>
-
- <dt><code>ap_max_daemons_limit</code>, <code>ap_my_generation</code>,
- and <code>ap_threads_per_child</code></dt>
- <dd>Use <code>ap_mpm_query()</code> query codes
- <code>AP_MPMQ_MAX_DAEMON_USED</code>, <code>AP_MPMQ_GENERATION</code>,
- and <code>AP_MPMQ_MAX_THREADS</code>, respectively.</dd>
-
- <dt><code>ap_mpm_query()</code></dt>
- <dd>Ensure that it is not used until after the register-hooks
- hook has completed. Otherwise, an MPM built as a DSO
- would not have had a chance to enable support for this
- function.</dd>
-
- <dt><code>ap_requires()</code></dt>
- <dd>The core server now provides better infrastructure for handling
- <directive module="mod_authz_core">Require</directive> configuration.
- Register an auth provider function for each supported entity using
- <code>ap_register_auth_provider()</code>. The function will be
- called as necessary during <directive>Require</directive>
- processing. (Consult bundled modules for detailed examples.)</dd>
-
- <dt><code>ap_server_conf->process->pool</code>
- userdata</dt>
- <dd>
- Optional:
- <ul>
- <li>If your module uses this to determine which pass of the
- startup hooks is being run,
- use <code>ap_state_query(AP_SQ_MAIN_STATE)</code>.</li>
- <li>If your module uses this to maintain data across the
- unloading and reloading of your module, use
- <code>ap_retained_data_create()</code> and
- <code>ap_retained_data_get()</code>.</li>
- </ul>
- </dd>
-
- <dt><code>apr_global_mutex_create()</code>,
- <code>apr_proc_mutex_create()</code></dt>
- <dd>Optional: See <code>ap_mutex_register()</code>,
- <code>ap_global_mutex_create()</code>, and
- <code>ap_proc_mutex_create()</code>; these allow your
- mutexes to be configurable with
- the <directive module="core">Mutex</directive> directive;
- you can also remove any configuration mechanisms in your
- module for such mutexes
- </dd>
-
- <dt><code>CORE_PRIVATE</code></dt>
- <dd>This is now unnecessary and ignored.</dd>
-
- <dt><code>dav_new_error()</code>
- and <code>dav_new_error_tag()</code></dt>
- <dd>Previously, these assumed that <code>errno</code> contained
- information describing the failure. Now,
- an <code>apr_status_t</code> parameter must be provided. Pass
- 0/APR_SUCCESS if there is no such error information, or a valid
- <code>apr_status_t</code> value otherwise.</dd>
-
- <dt><code>mpm_default.h</code>, <code>DEFAULT_LOCKFILE</code>,
- <code>DEFAULT_THREAD_LIMIT</code>, <code>DEFAULT_PIDLOG</code>,
- etc.</dt>
- <dd>The header file and most of the default configuration
- values set in it are no longer visible to modules. (Most can
- still be overridden at build time.) <code>DEFAULT_PIDLOG</code>
- and <code>DEFAULT_REL_RUNTIMEDIR</code> are now universally
- available via <code>ap_config.h</code>.</dd>
-
- <dt><code>unixd_config</code></dt>
- <dd>This has been renamed to ap_unixd_config.</dd>
-
- <dt><code>conn_rec->remote_ip</code> and
- <code>conn_rec->remote_addr</code></dt>
- <dd>These fields have been renamed in order to distinguish between
- the client IP address of the connection and the useragent IP address
- of the request (potentially overridden by a load balancer or proxy).
- References to either of these fields must be updated with one of the
- following options, as appropriate for the module:
- <ul>
- <li>When you require the IP address of the user agent, which
- might be connected directly to the server, or might optionally be
- separated from the server by a transparent load balancer or
- proxy, use <code>request_rec->useragent_ip</code> and
- <code>request_rec->useragent_addr</code>.</li>
- <li>When you require the IP address of the client that is
- connected directly to the server, which might be the useragent or
- might be the load balancer or proxy itself, use
- <code>conn_rec->client_ip</code> and
- <code>conn_rec->client_addr</code>.</li>
- </ul>
- </dd>
+ <dt><code>ap_fillmein()</code></dt>
+ <dd>This is no longer available;</dd>
+
</dl>
</section>
<section id="upgrading_byfeature">
<title>If your module interfaces with this feature...</title>
<dl>
- <dt>suEXEC</dt>
- <dd>Optional: If your module logs an error
- when <code>ap_unixd_config.suexec_enabled</code> is 0,
- also log the value of the new
- field <code>suexec_disabled_reason</code>, which contains an
- explanation of why it is not available.</dd>
-
- <dt>Extended status data in the scoreboard</dt>
- <dd>In previous releases, <code>ExtendedStatus</code> had to be
- set to <code>On</code>, which in turn required that
- mod_status was loaded. In 2.4, just
- set <code>ap_extended_status</code> to <code>1</code> in a
- pre-config hook and the extended status data will be
- available.</dd>
+ <dt>fillmin</dt>
+ <dd>Optional: If your module fills me in.</dd>
+
</dl>
</section>
<section id="upgrading_newfeatures">
<title>Does your module...</title>
<dl>
- <dt>Parse query args</dt>
- <dd>Consider if <code>ap_args_to_table()</code> would be
- helpful.</dd>
-
- <dt>Parse form data...</dt>
- <dd>Use <code>ap_parse_form_data()</code>.</dd>
-
- <dt>Check for request header fields <code>Content-Length</code>
- and <code>Transfer-Encoding</code> to see if a body was
- specified</dt>
- <dd>Use <code>ap_request_has_body()</code>.</dd>
-
- <dt>Implement cleanups which clear pointer variables</dt>
- <dd>Use <code>ap_pool_cleanup_set_null()</code>.</dd>
-
- <dt>Create run-time files such as shared memory files, pid files,
- etc.</dt>
- <dd>Use <code>ap_runtime_dir_relative()</code> so that the global
- configuration for the location of such files, either by the
- <code>DEFAULT_REL_RUNTIMEDIR</code> compile setting or the
- <directive module="core">DefaultRuntimeDir</directive> directive,
- will be respected. <em>Apache httpd 2.4.2 and above.</em></dd>
+ <dt>Fill me in</dt>
+ <dd>Consider if filling me in.</dd>
</dl>
</section>
Copied: httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml.meta (from r1879470, httpd/httpd/trunk/docs/manual/developer/new_api_2_4.xml.meta)
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml.meta?p2=httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml.meta&p1=httpd/httpd/trunk/docs/manual/developer/new_api_2_4.xml.meta&r1=1879470&r2=1879471&rev=1879471&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/developer/new_api_2_4.xml.meta (original)
+++ httpd/httpd/trunk/docs/manual/developer/new_api_2_6.xml.meta Fri Jul 3 12:29:55 2020
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!-- GENERATED FROM XML: DO NOT EDIT -->
-<metafile reference="new_api_2_4.xml">
- <basename>new_api_2_4</basename>
+<metafile reference="new_api_2_6.xml">
+ <basename>new_api_2_6</basename>
<path>/developer/</path>
<relpath>..</relpath>
Copied: httpd/httpd/trunk/docs/manual/new_features_2_6.xml (from r1879470, httpd/httpd/trunk/docs/manual/new_features_2_4.xml)
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/new_features_2_6.xml?p2=httpd/httpd/trunk/docs/manual/new_features_2_6.xml&p1=httpd/httpd/trunk/docs/manual/new_features_2_4.xml&r1=1879470&r2=1879471&rev=1879471&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/new_features_2_4.xml (original)
+++ httpd/httpd/trunk/docs/manual/new_features_2_6.xml Fri Jul 3 12:29:55 2020
@@ -20,80 +20,22 @@
limitations under the License.
-->
-<manualpage metafile="new_features_2_4.xml.meta">
+<manualpage metafile="new_features_2_6.xml.meta">
-<title>Overview of new features in Apache HTTP Server 2.4</title>
+<title>Overview of new features in Apache HTTP Server 2.6</title>
<summary>
<p>This document describes some of the major changes between the
- 2.2 and 2.4 versions of the Apache HTTP Server. For new features since
- version 2.0, see the <a href="new_features_2_2.html">2.2 new features</a>
+ 2.4 and 2.6 versions of the Apache HTTP Server. For new features since
+ version 2.2, see the <a href="new_features_2_4.html">2.4 new features</a>
document.</p>
</summary>
<section id="core">
<title>Core Enhancements</title>
<dl>
- <dt>Run-time Loadable MPMs</dt>
- <dd>Multiple MPMs can now be <a href="mpm.html#dynamic">built
- as loadable modules</a> at compile time.
- The MPM of choice can be configured at run time via <directive
- module="mod_so">LoadModule</directive> directive.</dd>
-
- <dt>Event MPM</dt>
- <dd>The <a href="mod/event.html">Event MPM</a> is no longer experimental
- but is now fully supported.</dd>
-
- <dt>Asynchronous support</dt>
- <dd>Better support for asynchronous read/write for supporting MPMs and
- platforms.</dd>
-
- <dt>Per-module and per-directory LogLevel configuration</dt>
- <dd>The <directive module="core">LogLevel</directive> can now be
- configured per module and per directory. New levels <code>trace1</code>
- to <code>trace8</code> have been added above the <code>debug</code> log
- level.</dd>
-
- <dt>Per-request configuration sections</dt>
- <dd><directive module="core" type="section">If</directive>,
- <directive module="core" type="section">ElseIf</directive>,
- and <directive module="core" type="section">Else</directive>
- sections can be used to set the configuration based on per-request
- criteria.</dd>
-
- <dt>General-purpose expression parser</dt>
- <dd>A new expression parser allows to specify
- <a href="expr.html">complex conditions</a> using a common syntax
- in directives like
- <directive module="mod_setenvif">SetEnvIfExpr</directive>,
- <directive module="mod_rewrite">RewriteCond</directive>,
- <directive module="mod_headers">Header</directive>,
- <directive module="core" type="section">If</directive>,
- and others.
- </dd>
-
- <dt>KeepAliveTimeout in milliseconds</dt>
- <dd>It is now possible to specify <directive module="core"
- >KeepAliveTimeout</directive> in milliseconds.
- </dd>
-
- <dt>NameVirtualHost directive</dt>
- <dd>No longer needed and is now deprecated.</dd>
-
- <dt>Override Configuration</dt>
- <dd>The new <directive module="core">AllowOverrideList</directive>
- directive allows more fine grained control which directives are
- allowed in <code>.htaccess</code> files. </dd>
-
- <dt>Config file variables</dt>
- <dd>It is now possible to <directive module="core">Define</directive>
- variables in the configuration, allowing a clearer representation
- if the same value is used at many places in the configuration.
- </dd>
-
- <dt>Reduced memory usage</dt>
- <dd>Despite many new features, 2.4.x tends to use less memory than
- 2.2.x.</dd>
+ <dt>Fill me in</dt>
+ <dd></dd>
</dl>
</section>
@@ -101,107 +43,8 @@
<section id="newmods">
<title>New Modules</title>
<dl>
- <dt><module>mod_proxy_fcgi</module></dt>
- <dd>FastCGI Protocol backend for <module>mod_proxy</module></dd>
-
- <dt><module>mod_proxy_scgi</module></dt>
- <dd>SCGI Protocol backend for <module>mod_proxy</module></dd>
-
- <dt><module>mod_proxy_express</module></dt>
- <dd>Provides dynamically configured mass reverse proxies for
- <module>mod_proxy</module></dd>
-
- <dt><module>mod_remoteip</module></dt>
- <dd>Replaces the apparent client remote IP address and hostname for the request
- with the IP address list presented by a proxies or a load balancer via
- the request headers.</dd>
-
- <dt><module>mod_heartmonitor</module>,
- <module>mod_lbmethod_heartbeat</module></dt>
- <dd>Allow <module>mod_proxy_balancer</module> to base loadbalancing decisions
- on the number of active connections on the backend servers.</dd>
-
- <dt><module>mod_proxy_html</module></dt>
- <dd>Formerly a third-party module, this supports fixing of HTML
- links in a reverse proxy situation, where the backend generates
- URLs that are not valid for the proxy's clients.</dd>
-
- <dt><module>mod_sed</module></dt>
- <dd>An advanced replacement of <module>mod_substitute</module>, allows
- to edit the response body with the full power of sed.</dd>
-
- <dt><module>mod_auth_form</module></dt>
- <dd>Enables form-based authentication.</dd>
-
- <dt><module>mod_session</module></dt>
- <dd>Enables the use of session state for clients, using cookie or
- database storage.</dd>
-
- <dt><module>mod_allowmethods</module></dt>
- <dd>New module to restrict certain HTTP methods without interfering with
- authentication or authorization.</dd>
-
- <dt><module>mod_lua</module></dt>
- <dd>Embeds the <a href="http://www.lua.org/">Lua</a> language into httpd,
- for configuration and small business logic functions. (Experimental)</dd>
-
- <dt><module>mod_log_debug</module></dt>
- <dd>Allows the addition of customizable debug logging at different phases of the
- request processing.</dd>
-
- <dt><module>mod_buffer</module></dt>
- <dd>Provides for buffering the input and output filter stacks</dd>
-
- <dt><module>mod_data</module></dt>
- <dd>Convert response body into an RFC2397 data URL</dd>
-
- <dt><module>mod_ratelimit</module></dt>
- <dd>Provides Bandwidth Rate Limiting for Clients</dd>
-
- <dt><module>mod_request</module></dt>
- <dd>Provides Filters to handle and make available HTTP request bodies</dd>
-
- <dt><module>mod_reflector</module></dt>
- <dd>Provides Reflection of a request body as a response via the output filter stack.</dd>
-
- <dt><module>mod_slotmem_shm</module></dt>
- <dd>Provides a Slot-based shared memory provider (ala the scoreboard).</dd>
-
- <dt><module>mod_xml2enc</module></dt>
- <dd>Formerly a third-party module, this supports internationalisation
- in libxml2-based (markup-aware) filter modules.</dd>
-
- <dt><module>mod_macro</module> (available since 2.4.5)</dt>
- <dd>Provide macros within configuration files.</dd>
-
- <dt><module>mod_proxy_wstunnel</module> (available since 2.4.5)</dt>
- <dd>Support web-socket tunnels.</dd>
-
- <dt><module>mod_authnz_fcgi</module> (available since 2.4.10)</dt>
- <dd>Enable FastCGI authorizer applications to authenticate and/or
- authorize clients.</dd>
-
- <dt><module>mod_http2</module> (available since 2.4.17)</dt>
- <dd>Support for the HTTP/2 transport layer.</dd>
-
- <dt><module>mod_proxy_http2</module> (available since 2.4.19)</dt>
- <dd>HTTP/2 Protocol backend for <module>mod_proxy</module></dd>
-
- <dt><module>mod_proxy_hcheck</module> (available since 2.4.21)</dt>
- <dd>Support independent dynamic health checks for remote proxiy backend servers.</dd>
-
- <dt><module>mod_brotli</module> (available since 2.4.26)</dt>
- <dd>Support the Brotli compression algorithm.</dd>
-
- <dt><module>mod_md</module> (available since 2.4.30)</dt>
- <dd>Support the ACME protocol to automate certificate provisionning.</dd>
-
- <dt><module>mod_socache_redis</module> (available since 2.4.39)</dt>
- <dd>Support <a href="http://redis.io/">Redis</a> based shared object cache provider.</dd>
-
- <dt><module>mod_systemd</module> (available since 2.4.42)</dt>
- <dd>systemd integration. It allows httpd to be used in a service with the systemd
- <code>Type=notify</code>.</dd>
+ <dt><module>mod_example</module></dt>
+ <dd>Fill me in for <module>mod_example</module>.</dd>
</dl>
</section>
@@ -209,122 +52,8 @@
<section id="module">
<title>Module Enhancements</title>
<dl>
- <dt><module>mod_ssl</module></dt>
-
- <dd><module>mod_ssl</module> can now be configured to use an
- OCSP server to check the validation status of a client
- certificate. The default responder is configurable, along with
- the decision on whether to prefer the responder designated in
- the client certificate itself.</dd>
-
- <dd><module>mod_ssl</module> now also supports OCSP stapling, where the
- server pro-actively obtains an OCSP verification of its certificate and
- transmits that to the client during the handshake. </dd>
-
- <dd><module>mod_ssl</module> can now be configured to share SSL Session
- data between servers through memcached</dd>
-
- <dd>EC keys are now supported in addition to RSA and DSA.</dd>
-
- <dd>Support for TLS-SRP (available in 2.4.4 and later).</dd>
-
- <dt><module>mod_proxy</module></dt>
-
- <dd>The <directive module="mod_proxy">ProxyPass</directive> directive
- is now most optimally configured within a
- <directive module="core">Location</directive> or
- <directive module="core">LocationMatch</directive>
- block, and offers a significant performance advantage over the traditional
- two-parameter syntax when present in large numbers.</dd>
- <dd>The source address used for proxy requests is now configurable.</dd>
- <dd>Support for Unix domain sockets to the backend (available in 2.4.7
- and later).</dd>
-
- <dt><module>mod_proxy_balancer</module></dt>
-
- <dd>More runtime configuration changes for BalancerMembers via balancer-manager</dd>
-
- <dd>Additional BalancerMembers can be added at runtime via balancer-manager</dd>
-
- <dd>Runtime configuration of a subset of Balancer parameters</dd>
-
- <dd>BalancerMembers can be set to 'Drain' so that they only respond to existing sticky
- sessions, allowing them to be taken gracefully offline.</dd>
-
- <dd>Balancer settings can be persistent after restarts.</dd>
-
- <dt><module>mod_cache</module></dt>
-
- <dd>The <module>mod_cache</module> CACHE filter can be optionally inserted
- at a given point in the filter chain to provide fine control over caching.
- </dd>
-
- <dd><module>mod_cache</module> can now cache HEAD requests.</dd>
-
- <dd>Where possible, <module>mod_cache</module> directives can now be set
- per directory, instead of per server.</dd>
-
- <dd>The base URL of cached URLs can be customised, so that a cluster of
- caches can share the same endpoint URL prefix.</dd>
-
- <dd><module>mod_cache</module> is now capable of serving stale cached
- data when a backend is unavailable (error 5xx).</dd>
-
- <dd><module>mod_cache</module> can now insert HIT/MISS/REVALIDATE into
- an X-Cache header.</dd>
-
- <dt><module>mod_include</module></dt>
- <dd>Support for the 'onerror' attribute within an 'include' element,
- allowing an error document to be served on error instead of the default
- error string.</dd>
-
- <dt><module>mod_cgi</module>, <module>mod_include</module>,
- <module>mod_isapi</module>, ...</dt>
- <dd>Translation of headers to environment variables is more strict than
- before to mitigate some possible cross-site-scripting attacks via header
- injection. Header names containing invalid characters (including underscores)
- are no longer converted to environment variables. <a href="env.html">Environment Variables
- in Apache</a> has some pointers on how to work around broken legacy
- clients which require such headers. (This affects all modules which
- use these environment variables.)</dd>
-
- <dt><module>mod_authz_core</module> Authorization Logic Containers</dt>
-
- <dd>Advanced authorization logic may now be specified using the
- <directive module="mod_authz_core">Require</directive> directive
- and the related container directives, such as
- <directive module="mod_authz_core"
- type="section">RequireAll</directive>.</dd>
-
- <dt><module>mod_rewrite</module></dt>
- <dd><module>mod_rewrite</module> adds the <code>[QSD]</code>
- (Query String Discard) and <code>[END]</code> flags for
- <directive module="mod_rewrite">RewriteRule</directive> to
- simplify common rewriting scenarios.</dd>
- <dd>Adds the possibility to use complex boolean expressions in <directive
- module="mod_rewrite">RewriteCond</directive>.</dd>
- <dd>Allows the use of SQL queries as <directive
- module="mod_rewrite">RewriteMap</directive> functions.</dd>
-
- <dt><module>mod_ldap</module>, <module>mod_authnz_ldap</module></dt>
- <dd><module>mod_authnz_ldap</module> adds support for nested groups.</dd>
- <dd><module>mod_ldap</module> adds
- <directive module="mod_ldap">LDAPConnectionPoolTTL</directive>,
- <directive module="mod_ldap">LDAPTimeout</directive>, and
- other improvements in the handling of timeouts.
- This is especially useful for setups where a
- stateful firewall drops idle connections to the LDAP server.</dd>
- <dd><module>mod_ldap</module> adds
- <directive module="mod_ldap">LDAPLibraryDebug</directive> to log
- debug information provided by the used LDAP toolkit.</dd>
-
- <dt><module>mod_info</module></dt>
- <dd><module>mod_info</module> can now dump the pre-parsed configuration
- to stdout during server startup.</dd>
-
- <dt><module>mod_auth_basic</module></dt>
- <dd>New generic mechanism to fake basic authentication (available in
- 2.4.5 and later).</dd>
+ <dt><module>mod_example</module></dt>
+ <dd>Fill me in.</dd>
</dl>
</section>
@@ -332,53 +61,17 @@
<section id="programs">
<title>Program Enhancements</title>
<dl>
- <dt><program>fcgistarter</program></dt>
- <dd>New FastCGI daemon starter utility</dd>
+ <dt><program>fillmein</program></dt>
+ <dd>Fill me in</dd>
- <dt><program>htcacheclean</program></dt>
- <dd>Current cached URLs can now be listed, with optional metadata
- included.</dd>
- <dd>Allow explicit deletion of individual cached URLs from the
- cache.</dd>
- <dd>File sizes can now be rounded up to the given block size, making
- the size limits map more closely to the real size on disk.</dd>
- <dd>Cache size can now be limited by the number of inodes, instead
- of or in addition to being limited by the size of the files on
- disk.</dd>
-
- <dt><program>rotatelogs</program></dt>
- <dd>May now create a link to the current log file.</dd>
- <dd>May now invoke a custom post-rotate script.</dd>
-
- <dt><program>htpasswd</program>, <program>htdbm</program></dt>
- <dd>Support for the bcrypt algorithm (available in 2.4.4 and later).
- </dd>
</dl>
</section>
<section id="documentation">
<title>Documentation</title>
<dl>
- <dt>mod_rewrite</dt>
- <dd>The <module>mod_rewrite</module> documentation has been
- rearranged and almost completely rewritten, with a focus on
- examples and common usage, as well as on showing you when other
- solutions are more appropriate. The <a href="rewrite/">Rewrite
- Guide</a> is now a top-level section with much more detail and
- better organization.</dd>
-
- <dt>mod_ssl</dt>
- <dd>The <module>mod_ssl</module> documentation has been greatly
- enhanced, with more examples at the getting started level, in
- addition to the previous focus on technical details.</dd>
-
- <dt>Caching Guide</dt>
- <dd>The <a href="caching.html">Caching Guide</a> has been rewritten
- to properly distinguish between the RFC2616 HTTP/1.1 caching
- features provided by <module>mod_cache</module>, and the generic
- key/value caching provided by the <a href="socache.html">socache</a>
- interface, as well as to cover specialised caching provided by
- mechanisms such as <module>mod_file_cache</module>.</dd>
+ <dt>Fill me in</dt>
+ <dd>The <module>mod_example</module> documentation fill me in.</dd>
</dl>
</section>
@@ -386,53 +79,14 @@
<section id="developer">
<title>Module Developer Changes</title>
<dl>
- <dt>Check Configuration Hook Added</dt>
+ <dt>Fill Me In Hook Added</dt>
- <dd>A new hook, <code>check_config</code>, has been added which runs
- between the <code>pre_config</code> and <code>open_logs</code>
- hooks. It also runs before the <code>test_config</code> hook
- when the <code>-t</code> option is passed to
- <program>httpd</program>. The <code>check_config</code> hook
- allows modules to review interdependent configuration directive
- values and adjust them while messages can still be logged to the
- console. The user can thus be alerted to misconfiguration problems
- before the core <code>open_logs</code> hook function redirects
- console output to the error log.</dd>
-
- <dt>Expression Parser Added</dt>
-
- <dd>We now have a general-purpose expression parser, whose API is
- exposed in <var>ap_expr.h</var>. This is adapted from the
- expression parser previously implemented in
- <module>mod_ssl</module>.</dd>
-
- <dt>Authorization Logic Containers</dt>
-
- <dd>Authorization modules now register as a provider, via
- ap_register_auth_provider(), to support advanced authorization logic,
- such as <directive module="mod_authz_core" type="section"
- >RequireAll</directive>.</dd>
-
- <dt>Small-Object Caching Interface</dt>
-
- <dd>The <var>ap_socache.h</var> header exposes a provider-based
- interface for caching small data objects, based on the previous
- implementation of the <module>mod_ssl</module> session cache.
- Providers using a shared-memory cyclic buffer, disk-based dbm
- files, and a memcache distributed cache are currently
- supported.</dd>
-
- <dt>Cache Status Hook Added</dt>
-
- <dd>The <module>mod_cache</module> module now includes a new
- <code>cache_status</code> hook, which is called when the caching
- decision becomes known. A default implementation is provided
- which adds an optional <code>X-Cache</code> and
- <code>X-Cache-Detail</code> header to the response.</dd>
- </dl>
+ <dd>A new hook, <code>fill_me_in</code>, has been added which fills
+ me in.</dd>
+ </dl>
<p>The developer documentation contains a
- <a href="developer/new_api_2_4.html">detailed list of API changes</a>.</p>
+ <a href="developer/new_api_2_6.html">detailed list of API changes</a>.</p>
</section>
</manualpage>
Copied: httpd/httpd/trunk/docs/manual/new_features_2_6.xml.meta (from r1879470, httpd/httpd/trunk/docs/manual/new_features_2_4.xml.meta)
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/new_features_2_6.xml.meta?p2=httpd/httpd/trunk/docs/manual/new_features_2_6.xml.meta&p1=httpd/httpd/trunk/docs/manual/new_features_2_4.xml.meta&r1=1879470&r2=1879471&rev=1879471&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/new_features_2_4.xml.meta (original)
+++ httpd/httpd/trunk/docs/manual/new_features_2_6.xml.meta Fri Jul 3 12:29:55 2020
@@ -1,15 +1,12 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!-- GENERATED FROM XML: DO NOT EDIT -->
-<metafile reference="new_features_2_4.xml">
- <basename>new_features_2_4</basename>
+<metafile reference="new_features_2_6.xml">
+ <basename>new_features_2_6</basename>
<path>/</path>
<relpath>.</relpath>
<variants>
<variant>en</variant>
- <variant outdated="yes">es</variant>
- <variant>fr</variant>
- <variant outdated="yes">tr</variant>
</variants>
</metafile>