]> granicus.if.org Git - apache/commitdiff
1st step of man changes for slotmem refactor
authorJim Jagielski <jim@apache.org>
Fri, 15 May 2009 14:37:10 +0000 (14:37 +0000)
committerJim Jagielski <jim@apache.org>
Fri, 15 May 2009 14:37:10 +0000 (14:37 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@775157 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/mod/mod_plainmem.xml
docs/manual/mod/mod_sharedmem.xml
docs/manual/mod/mod_slotmem.html [deleted file]
docs/manual/mod/mod_slotmem.html.en [deleted file]
docs/manual/mod/mod_slotmem.xml [deleted file]
docs/manual/mod/mod_slotmem.xml.meta [deleted file]

index 1fc088288ba914d3d48089800501620d192c9ed0..be327fbbd32a917ab2059cd274f10a84c2476292 100644 (file)
  limitations under the License.
 -->
 
-<modulesynopsis metafile="mod_plainmem.xml.meta">
+<modulesynopsis metafile="mod_slotmem_plain.xml.meta">
 
-<name>mod_plainmem</name>
+<name>mod_slotmem_shm</name>
 <description>Slot-based shared memory provider.</description>
 <status>Extension</status>
-<sourcefile>mod_plainmem.c</sourcefile>
-<identifier>plainmem_module</identifier>
+<sourcefile>mod_slotmem_shm.c</sourcefile>
+<identifier>mod_slotmem_shm_module</identifier>
 
 <summary>
-    <p><code>mod_plainmem</code> is a memory provider which
+    <p><code>mod_slotmem_shm</code> is a memory provider which
     provides for creation and access to a plain memory segment
-    in which the datasets are organized in "slots." Although
-    it can be used directly, normally <module>mod_slotmem</module>
-    is used as a front-end.
+    in which the datasets are organized in "slots."
     </p>
 
     <p>If the memory needs to be shared between threads and
     processes, a better provider would be
-    <module>mod_sharedmem</module>.
+    <module>mod_slotmem_plain</module>.
     </p>
 
     <p><code>mod_plainmem</code> provides the following
     </p>
 
     <dl>
-      <dt>apr_status_t slotmem_do(ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
+      <dt>apr_status_t do(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
       <dd>call the callback on all worker slots</dd>
 
-      <dt>apr_status_t slotmem_create(ap_slotmem_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
+      <dt>apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
       <dd>create a new slotmem with each item size is item_size.</dd>
 
-      <dt>apr_status_t slotmem_attach(ap_slotmem_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
+      <dt>apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
       <dd>attach to an existing slotmem.</dd>
 
-      <dt>apr_status_t slotmem_mem(ap_slotmem_t *s, int item_id, void**mem)</dt>
-      <dd>get the memory associated with this worker slot.</dd>
+      <dt>apr_status_t dptr(ap_slotmem_instance_t *s, int item_id, void**mem)</dt>
+      <dd>get the direct pointer to the memory associated with this worker slot.</dd>
 
-      <dt>apr_status_t slotmem_lock(ap_slotmem_t *s)</dt>
+      <dt>apr_status_t lock(ap_slotmem_instance_t *s)</dt>
       <dd>lock the memory segment</dd>
 
-      <dt>(apr_status_t slotmem_unlock(ap_slotmem_t *s)</dt>
+      <dt>(apr_status_t unlock(ap_slotmem_instance_t *s)</dt>
       <dd>unlock the memory segment</dd>
     </dl>
 
index 6b9b24417954f60e4adc818ea0cdae21209d06a3..3d5e01ac862d46cfd35ec4c2382aef47b762f126 100644 (file)
  limitations under the License.
 -->
 
-<modulesynopsis metafile="mod_sharedmem.xml.meta">
+<modulesynopsis metafile="mod_slotmem_shm.xml.meta">
 
-<name>mod_sharedmem</name>
+<name>mod_slotmem_shm</name>
 <description>Slot-based shared memory provider.</description>
 <status>Extension</status>
-<sourcefile>mod_sharedmem.c</sourcefile>
-<identifier>sharedmem_module</identifier>
+<sourcefile>mod_slotmem_shm.c</sourcefile>
+<identifier>mod_slotmem_shm_module</identifier>
 
 <summary>
-    <p><code>mod_sharedmem</code> is a memory provider which
+    <p><code>mod_slotmem_shm</code> is a memory provider which
     provides for creation and access to a shared memory segment
-    in which the datasets are organized in "slots." Although
-    it can be used directly, normally <module>mod_slotmem</module>
-    is used as a front-end.
+    in which the datasets are organized in "slots."
     </p>
 
     <p><code>mod_sharedmem</code> provides the following
     </p>
 
     <dl>
-      <dt>apr_status_t slotmem_do(ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
+      <dt>apr_status_t do(ap_slotmem_instance_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
       <dd>call the callback on all worker slots</dd>
 
-      <dt>apr_status_t slotmem_create(ap_slotmem_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
+      <dt>apr_status_t create(ap_slotmem_instance_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
       <dd>create a new slotmem with each item size is item_size.</dd>
 
-      <dt>apr_status_t slotmem_attach(ap_slotmem_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
+      <dt>apr_status_t attach(ap_slotmem_instance_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
       <dd>attach to an existing slotmem.</dd>
 
-      <dt>apr_status_t slotmem_mem(ap_slotmem_t *s, int item_id, void**mem)</dt>
-      <dd>get the memory associated with this worker slot.</dd>
+      <dt>apr_status_t dptr(ap_slotmem_instance_t *s, int item_id, void**mem)</dt>
+      <dd>get the direct pointer to the memory associated with this worker slot.</dd>
 
-      <dt>apr_status_t slotmem_lock(ap_slotmem_t *s)</dt>
+      <dt>apr_status_t lock(ap_slotmem_instance_t *s)</dt>
       <dd>lock the memory segment</dd>
 
-      <dt>(apr_status_t slotmem_unlock(ap_slotmem_t *s)</dt>
+      <dt>(apr_status_t unlock(ap_slotmem_instance_t *s)</dt>
       <dd>unlock the memory segment</dd>
     </dl>
 
diff --git a/docs/manual/mod/mod_slotmem.html b/docs/manual/mod/mod_slotmem.html
deleted file mode 100644 (file)
index 0c8ad80..0000000
+++ /dev/null
@@ -1,5 +0,0 @@
-# GENERATED FROM XML -- DO NOT EDIT
-
-URI: mod_slotmem.html.en
-Content-Language: en
-Content-type: text/html; charset=ISO-8859-1
diff --git a/docs/manual/mod/mod_slotmem.html.en b/docs/manual/mod/mod_slotmem.html.en
deleted file mode 100644 (file)
index 3724aaf..0000000
+++ /dev/null
@@ -1,83 +0,0 @@
-<?xml version="1.0" encoding="ISO-8859-1"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
-        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-              This file is generated from xml source: DO NOT EDIT
-        XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
-      -->
-<title>mod_slotmem - Apache HTTP Server</title>
-<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
-<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
-<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
-<link href="../images/favicon.ico" rel="shortcut icon" /></head>
-<body>
-<div id="page-header">
-<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
-<p class="apache">Apache HTTP Server Version 2.3</p>
-<img alt="" src="../images/feather.gif" /></div>
-<div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
-<div id="path">
-<a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.3</a> &gt; <a href="./">Modules</a></div>
-<div id="page-content">
-<div id="preamble"><h1>Apache Module mod_slotmem</h1>
-<div class="toplang">
-<p><span>Available Languages: </span><a href="../en/mod/mod_slotmem.html" title="English">&nbsp;en&nbsp;</a></p>
-</div>
-<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Slot-based memory implementation API.</td></tr>
-<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
-<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>slotmem_module</td></tr>
-<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_slotmem.c</td></tr></table>
-<h3>Summary</h3>
-
-    <p><code>mod_slotmem</code> provides an interface to a
-    memory allocation implementation which is based on the
-    concept of datasets being in various "slots" within
-    a larger memory segment. As such, it is similar in
-    concept to a generic table or array. The real use of
-    the module is as a front-end to various providers
-    (such as <code class="module"><a href="../mod/mod_sharedmem.html">mod_sharedmem</a></code>) which deal
-    with the actual implementations. This allows modules
-    to use a single API for memory usage, to matter what
-    the underlying implementation is.
-    </p>
-
-    <p><code>mod_slotmem</code> provides the following
-    API functions:
-    </p>
-
-    <dl>
-      <dt>ap_slotmem_storage_method *ap_slotmem_method(const char *provider)</dt>
-      <dd>obtain the provider method desired</dd>
-
-      <dt>apr_status_t ap_slotmem_do(ap_slotmem_storage_method *sm, ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
-      <dd>call the callback on all worker slots</dd>
-
-      <dt>apr_status_t ap_slotmem_create(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
-      <dd>create a new slotmem with each item size is item_size.</dd>
-
-      <dt>apr_status_t ap_slotmem_attach(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
-      <dd>attach to an existing slotmem.</dd>
-
-      <dt>apr_status_t ap_slotmem_mem(ap_slotmem_storage_method *sm, ap_slotmem_t *s, int item_id, void**mem)</dt>
-      <dd>get the memory associated with this worker slot.</dd>
-
-      <dt>apr_status_t ap_slotmem_lock(ap_slotmem_storage_method *sm, ap_slotmem_t *s)</dt>
-      <dd>lock the memory segment</dd>
-
-      <dt>(apr_status_t ap_slotmem_unlock(ap_slotmem_storage_method *sm, ap_slotmem_t *s)</dt>
-      <dd>unlock the memory segment</dd>
-    </dl>
-
-</div>
-<div id="quickview"><h3 class="directives">Directives</h3>
-<p>This module provides no
-            directives.</p>
-</div>
-
-</div>
-<div class="bottomlang">
-<p><span>Available Languages: </span><a href="../en/mod/mod_slotmem.html" title="English">&nbsp;en&nbsp;</a></p>
-</div><div id="footer">
-<p class="apache">Copyright 2009 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
-<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
-</body></html>
\ No newline at end of file
diff --git a/docs/manual/mod/mod_slotmem.xml b/docs/manual/mod/mod_slotmem.xml
deleted file mode 100644 (file)
index 8d6b885..0000000
+++ /dev/null
@@ -1,73 +0,0 @@
-<?xml version="1.0"?>
-<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
-<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
-<!-- $LastChangedRevision$ -->
-
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements.  See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License.  You may obtain a copy of the License at
-
-     http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-
-<modulesynopsis metafile="mod_slotmem.xml.meta">
-
-<name>mod_slotmem</name>
-<description>Slot-based memory implementation API.</description>
-<status>Extension</status>
-<sourcefile>mod_slotmem.c</sourcefile>
-<identifier>slotmem_module</identifier>
-
-<summary>
-    <p><code>mod_slotmem</code> provides an interface to a
-    memory allocation implementation which is based on the
-    concept of datasets being in various "slots" within
-    a larger memory segment. As such, it is similar in
-    concept to a generic table or array. The real use of
-    the module is as a front-end to various providers
-    (such as <module>mod_sharedmem</module>) which deal
-    with the actual implementations. This allows modules
-    to use a single API for memory usage, to matter what
-    the underlying implementation is.
-    </p>
-
-    <p><code>mod_slotmem</code> provides the following
-    API functions:
-    </p>
-
-    <dl>
-      <dt>ap_slotmem_storage_method *ap_slotmem_method(const char *provider)</dt>
-      <dd>obtain the provider method desired</dd>
-
-      <dt>apr_status_t ap_slotmem_do(ap_slotmem_storage_method *sm, ap_slotmem_t *s, ap_slotmem_callback_fn_t *func, void *data, apr_pool_t *pool)</dt>
-      <dd>call the callback on all worker slots</dd>
-
-      <dt>apr_status_t ap_slotmem_create(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t item_size, int item_num, apr_pool_t *pool)</dt>
-      <dd>create a new slotmem with each item size is item_size.</dd>
-
-      <dt>apr_status_t ap_slotmem_attach(ap_slotmem_storage_method *sm, ap_slotmem_t **new, const char *name, apr_size_t *item_size, int *item_num, apr_pool_t *pool)</dt>
-      <dd>attach to an existing slotmem.</dd>
-
-      <dt>apr_status_t ap_slotmem_mem(ap_slotmem_storage_method *sm, ap_slotmem_t *s, int item_id, void**mem)</dt>
-      <dd>get the memory associated with this worker slot.</dd>
-
-      <dt>apr_status_t ap_slotmem_lock(ap_slotmem_storage_method *sm, ap_slotmem_t *s)</dt>
-      <dd>lock the memory segment</dd>
-
-      <dt>(apr_status_t ap_slotmem_unlock(ap_slotmem_storage_method *sm, ap_slotmem_t *s)</dt>
-      <dd>unlock the memory segment</dd>
-    </dl>
-
-</summary>
-
-</modulesynopsis>
diff --git a/docs/manual/mod/mod_slotmem.xml.meta b/docs/manual/mod/mod_slotmem.xml.meta
deleted file mode 100644 (file)
index 253bca1..0000000
+++ /dev/null
@@ -1,12 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" ?>
-<!-- GENERATED FROM XML: DO NOT EDIT -->
-
-<metafile>
-  <basename>mod_slotmem</basename>
-  <path>/mod/</path>
-  <relpath>..</relpath>
-
-  <variants>
-    <variant>en</variant>
-  </variants>
-</metafile>