Move the examples README from experimental to

examples. Correct some basic errors in the file.

No functional change.

Backport of r1201198 from trunk.

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/branches/2.4.x@1201199 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/modules/experimental/README b/modules/examples/README
similarity index 61%
rename from modules/experimental/README
rename to modules/examples/README
index b911e5d0cfb177c3dfa31c39a0d4d89574d8a2ae..02b1c919edee26deeb356a485b080801a498c849 100644 (file)
--- a/modules/experimental/README
+++ b/modules/examples/README
@@ -1,38 +1,38 @@
 README for Apache 2.0 Example Module
 [April, 1997, updated May 2000]
 
-The files in the src/modules/example directory under the Apache
+The files in the src/modules/examples directory under the Apache
 distribution directory tree are provided as an example to those that
 wish to write modules that use the Apache API.
 
-The main file is mod_example.c, which illustrates all the different
+The main file is mod_example_hooks.c, which illustrates all the different
 callback mechanisms and call syntaces.  By no means does an add-on
 module need to include routines for all of the callbacks - quite the
 contrary!
 
 The example module is an actual working module.  If you link it into
-your server, enable the "example-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.
+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.
 
-To include the example module in your server add --enable-example to the
-other ./configure arguments executed from the httpd source tree. After
-that run 'make'.
+To include the example module in your server add --enable-example-hooks
+to the other ./configure arguments executed from the httpd source tree.
+After that run 'make'.
 
 To add another module of your own:
 
-    A. cp modules/experimental/mod_example.c modules/experimental/mod_myexample.c
+    A. cp modules/examples/mod_example_hooks.c modules/examples/mod_myexample.c
     B. Modify the file
-    C. Add an entry to modules/experimental/config.m4, e.g.
+    C. Add an entry to modules/examples/config.m4, e.g.
          APACHE_MODULE(myexample, my new module, , , no)
        The last argument specifies if the module is built by-default
     D. Build the server with --enable-myexample
 
 For windows, the process is slightly different;
 
-    A. copy modules\experimental\mod_example.c modules\experimental\mod_myexample.c
-    B. copy modules\experimental\mod_example.dsp modules\experimental\mod_myexample.dsp
-    C. replace the occurances of 'example' with your module name.
+    A. copy modules\examples\mod_example_hooks.c modules\examples\mod_myexample.c
+    B. copy modules\examples\mod_example_hooks.dsp modules\examples\mod_myexample.dsp
+    C. replace the occurances of 'example_hooks' with your module name.
     D. add the new .dsp to your Apache.dsw workspace, with dependencies
        on the libapr, libaprutil and libhttpd projects.  With the newer
        Developer Studio 2002 through 2005, when you add the new .dsp
@@ -42,13 +42,13 @@ To activate the example module, include a block similar to the
 following in your httpd.conf file:
 
     <Location /example-info>
-       SetHandler example-handler
+       SetHandler example-hooks-handler
     </Location>
 
 As an alternative, you can put the following into a .htaccess file and
 then request the file "test.example" from that location:
 
-    AddHandler example-handler .example
+    AddHandler example-hooks-handler .example
 
 After reloading/restarting your server, you should be able to browse
 to this location and see the brief display mentioned earlier.