You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by rj...@apache.org on 2014/10/03 18:02:06 UTC
svn commit: r1629244 - in /httpd/httpd/trunk/docs/manual/mod: allmodules.xml
mod_example_hooks.xml mod_example_hooks.xml.fr mod_example_hooks.xml.meta
Author: rjung
Date: Fri Oct 3 16:02:05 2014
New Revision: 1629244
URL: http://svn.apache.org/r1629244
Log:
Adjust content of some docs file for the old
switch form mod_example to mod_example_hooks.
Modified:
httpd/httpd/trunk/docs/manual/mod/allmodules.xml
httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml
httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.fr
httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.meta
Modified: httpd/httpd/trunk/docs/manual/mod/allmodules.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/allmodules.xml?rev=1629244&r1=1629243&r2=1629244&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/allmodules.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/allmodules.xml Fri Oct 3 16:02:05 2014
@@ -47,7 +47,7 @@
<modulefile>mod_dumpio.xml</modulefile>
<modulefile>mod_echo.xml</modulefile>
<modulefile>mod_env.xml</modulefile>
- <modulefile>mod_example.xml</modulefile>
+ <modulefile>mod_example_hooks.xml</modulefile>
<modulefile>mod_expires.xml</modulefile>
<modulefile>mod_ext_filter.xml</modulefile>
<modulefile>mod_file_cache.xml</modulefile>
Modified: httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml?rev=1629244&r1=1629243&r2=1629244&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml Fri Oct 3 16:02:05 2014
@@ -20,40 +20,40 @@
limitations under the License.
-->
-<modulesynopsis metafile="mod_example.xml.meta">
+<modulesynopsis metafile="mod_example_hooks.xml.meta">
-<name>mod_example</name>
+<name>mod_example_hooks</name>
<description>Illustrates the Apache module API</description>
<status>Experimental</status>
-<sourcefile>mod_example.c</sourcefile>
-<identifier>example_module</identifier>
+<sourcefile>mod_example_hooks.c</sourcefile>
+<identifier>example_hooks_module</identifier>
<summary>
- <p>Some files in the <code>modules/experimental</code> directory
+ <p>The files in the <code>modules/examples</code> directory
under the Apache distribution directory tree are provided as an
example to those that wish to write modules that use the Apache
API.</p>
- <p>The main file is <code>mod_example.c</code>, which
+ <p>The main file is <code>mod_example_hooks.c</code>, which
illustrates all the different callback mechanisms and call
syntaxes. By no means does an add-on module need to include
routines for all of the callbacks - quite the contrary!</p>
<p>The example module is an actual working module. If you link
- it into your server, enable the "example-handler" handler for a
+ it into your server, enable the "example-hooks-handler" handler for a
location, and then browse to that location, you will see a
display of some of the tracing the example module did as the
various callbacks were made.</p>
</summary>
-<section id="compiling"><title>Compiling the example module</title>
+<section id="compiling"><title>Compiling the example_hooks module</title>
- <p>To include the example module in your server, follow the
+ <p>To include the example_hooks module in your server, follow the
steps below:</p>
<ol>
<li>
- Run <program>configure</program> with <code>--enable-example</code>
+ Run <program>configure</program> with <code>--enable-example-hooks</code>
option.</li>
<li>Make the server (run "<code>make</code>").</li>
@@ -62,7 +62,7 @@
<p>To add another module of your own:</p>
<ol type="A">
- <li><code>cp modules/experimental/mod_example.c
+ <li><code>cp modules/examples/mod_example_hooks.c
modules/new_module/<em>mod_myexample.c</em></code></li>
<li>Modify the file.</li>
@@ -70,9 +70,9 @@
<li>Create <code>modules/new_module/config.m4</code>.
<ol>
<li>Add <code>APACHE_MODPATH_INIT(new_module)</code>.</li>
- <li>Copy APACHE_MODULE line with "example" from
- <code>modules/experimental/config.m4</code>.</li>
- <li>Replace the first argument "example" with <em>myexample</em>.</li>
+ <li>Copy APACHE_MODULE line with "example_hooks" from
+ <code>modules/examples/config.m4</code>.</li>
+ <li>Replace the first argument "example_hooks" with <em>myexample</em>.</li>
<li>Replace the second argument with brief description of your module.
It will be used in <code>configure --help</code>.</li>
<li>If your module needs additional C compiler flags, linker flags or
@@ -95,13 +95,13 @@
</ol>
</section>
-<section id="using"><title>Using the <code>mod_example</code> Module</title>
+<section id="using"><title>Using the <code>mod_example_hooks</code> Module</title>
- <p>To activate the example module, include a block similar to
+ <p>To activate the example_hooks module, include a block similar to
the following in your <code>httpd.conf</code> file:</p>
<highlight language="config">
-<Location /example-info>
- SetHandler example-handler
+<Location /example-hooks-info>
+ SetHandler example-hooks-handler
</Location>
</highlight>
@@ -109,7 +109,7 @@
href="core.html#accessfilename"><code>.htaccess</code></a> file
and then request the file "test.example" from that location:</p>
<highlight language="config">
- AddHandler example-handler .example
+ AddHandler example-hooks-handler .example
</highlight>
<p>After reloading/restarting your server, you should be able
@@ -130,7 +130,7 @@ API</description>
<p>The <directive>Example</directive> directive just sets a demonstration
flag which the example module's content handler displays. It
takes no arguments. If you browse to an URL to which the
- example content-handler applies, you will get a display of the
+ example-hooks content-handler applies, you will get a display of the
routines within the module and how and in what order they were
called to service the document request. The effect of this
directive one can observe under the point "<code>Example
Modified: httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.fr
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.fr?rev=1629244&r1=1629243&r2=1629244&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.fr (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.fr Fri Oct 3 16:02:05 2014
@@ -22,41 +22,41 @@
limitations under the License.
-->
-<modulesynopsis metafile="mod_example.xml.meta">
+<modulesynopsis metafile="mod_example_hooks.xml.meta">
-<name>mod_example</name>
+<name>mod_example_hooks</name>
<description>Illustration de l'API des modules Apache</description>
<status>Experimental</status>
-<sourcefile>mod_example.c</sourcefile>
-<identifier>example_module</identifier>
+<sourcefile>mod_example_hooks.c</sourcefile>
+<identifier>example_hooks_module</identifier>
<summary>
<p>Certains fichiers situés dans le répertoire
- <code>modules/experimental</code> de l'arborescence de la
+ <code>modules/examples</code> de l'arborescence de la
distribution d'Apache sont fournis à titre d'exemples pour ceux qui
souhaitent écrire des modules qui utilisent l'API d'Apache.</p>
- <p>Le fichier principal est <code>mod_example.c</code>, qui
+ <p>Le fichier principal est <code>mod_example_hooks.c</code>, qui
constitue une illustration exhaustive des différents mécanismes et
syntaxes d'appels. En aucun cas un module additionnel n'aura à
inclure des routines pour tous les appels - il n'en nécessitera au
contraire qu'un petit nombre !</p>
- <p>Le module example fonctionne réellement. Si vous le chargez dans
- votre serveur, activez le gestionnaire "example-handler" dans une
+ <p>Le module example_hooks fonctionne réellement. Si vous le chargez dans
+ votre serveur, activez le gestionnaire "example-hooks-handler" dans une
section location, et essayez d'accéder à la zone du site web
correspondante, vous verrez s'afficher certaines sorties que le
- module example produit au cours des différents appels.</p>
+ module example_hooks produit au cours des différents appels.</p>
</summary>
-<section id="compiling"><title>Compilation du module example</title>
+<section id="compiling"><title>Compilation du module example_hooks</title>
- <p>Pour inclure le module example dans votre serveur, effectuez les
+ <p>Pour inclure le module example_hooks dans votre serveur, effectuez les
étapes suivantes :</p>
<ol>
<li>Exécutez <program>configure</program> avec l'option
- <code>--enable-example</code>.</li>
+ <code>--enable-example-hooks</code>.</li>
<li>Compilez le serveur (exécutez la commande
"<code>make</code>").</li>
@@ -65,7 +65,7 @@
<p>Pour ajouter votre propre module :</p>
<ol type="A">
- <li><code>cp modules/experimental/mod_example.c
+ <li><code>cp modules/examples/mod_example_hooks.c
modules/nouveau_module/<em>mod_monexemple.c</em></code></li>
<li>Modifiez le fichier.</li>
@@ -73,9 +73,9 @@
<li>Créez <code>modules/nouveau_module/config.m4</code>.
<ol>
<li>Ajoutez <code>APACHE_MODPATH_INIT(nouveau_module)</code>.</li>
- <li>Copiez la ligne APACHE_MODULE contenant "example" depuis
- <code>modules/experimental/config.m4</code>.</li>
- <li>Remplacez le premier argument "example" par
+ <li>Copiez la ligne APACHE_MODULE contenant "example_hooks" depuis
+ <code>modules/examples/config.m4</code>.</li>
+ <li>Remplacez le premier argument "example-hooks" par
<em>monexemple</em>.</li>
<li>Remplacez le second argument par une brève description de
votre module. Cette description sera utilisée par la commande
@@ -105,13 +105,13 @@
</section>
<section id="using"><title>Utilisation du module
-<code>mod_example</code></title>
+<code>mod_example_hooks</code></title>
- <p>Pour activer le module example, ajoutez à votre fichier
+ <p>Pour activer le module example_hooks, ajoutez à votre fichier
<code>httpd.conf</code> un bloc du style :</p>
<highlight language="config">
-<Location /example-info>
- SetHandler example-handler
+<Location /example-hooks-info>
+ SetHandler example-hooks-handler
</Location>
</highlight>
@@ -121,7 +121,7 @@
correspondant :</p>
<highlight language="config">
- AddHandler example-handler .example
+ AddHandler example-hooks-handler .example
</highlight>
@@ -142,9 +142,9 @@ Apache</description>
<usage>
<p>La directive <directive>Example</directive> n'a pour fonction que
de définir un drapeau de démonstration que le gestionnaire de
- contenu du module example va afficher. Elle ne possède aucun
+ contenu du module example_hooks va afficher. Elle ne possède aucun
argument. Si vous naviguez vers une URL à laquelle le gestionnaire
- de contenu example s'applique, vous verrez s'afficher les routines
+ de contenu example_hooks s'applique, vous verrez s'afficher les routines
du module, ainsi que l'ordre dans lequel elles ont été appelées pour
servir le document demandé. On peut observer l'effet de cette
directive dans la phrase "<code>Example
Modified: httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.meta
URL: http://svn.apache.org/viewvc/httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.meta?rev=1629244&r1=1629243&r2=1629244&view=diff
==============================================================================
--- httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.meta (original)
+++ httpd/httpd/trunk/docs/manual/mod/mod_example_hooks.xml.meta Fri Oct 3 16:02:05 2014
@@ -1,8 +1,8 @@
<?xml version="1.0" encoding="UTF-8" ?>
<!-- GENERATED FROM XML: DO NOT EDIT -->
-<metafile reference="mod_example.xml">
- <basename>mod_example</basename>
+<metafile reference="mod_example_hooks.xml">
+ <basename>mod_example_hooks</basename>
<path>/mod/</path>
<relpath>..</relpath>