]> git.ipfire.org Git - thirdparty/apache/httpd.git/commitdiff
Add skeleton for new features docs for 2.6.
authorGraham Leggett <minfrin@apache.org>
Fri, 3 Jul 2020 12:29:55 +0000 (12:29 +0000)
committerGraham Leggett <minfrin@apache.org>
Fri, 3 Jul 2020 12:29:55 +0000 (12:29 +0000)
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1879471 13f79535-47bb-0310-9956-ffa450edef68

docs/manual/developer/new_api_2_6.xml [new file with mode: 0644]
docs/manual/developer/new_api_2_6.xml.meta [new file with mode: 0644]
docs/manual/new_features_2_6.xml [new file with mode: 0644]
docs/manual/new_features_2_6.xml.meta [new file with mode: 0644]

diff --git a/docs/manual/developer/new_api_2_6.xml b/docs/manual/developer/new_api_2_6.xml
new file mode 100644 (file)
index 0000000..3c87831
--- /dev/null
@@ -0,0 +1,100 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "../style/manualpage.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.
+-->
+
+<manualpage metafile="new_api_2_6.xml.meta">
+
+<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.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.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,
+     and existing APIs that are expanded or changed.  The latter are
+     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.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>
+  <p>For the purpose of this document, the API is split according
+     to the public header files.  These headers are themselves the
+     reference documentation, and can be used to generate a browsable
+     HTML reference with <code>make docs</code>.</p>
+</summary>
+
+<section id="api_changes">
+  <title>Changed APIs</title>
+
+  <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.4</title>
+
+  <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_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>fillmin</dt>
+      <dd>Optional: If your module fills me in.</dd>
+
+    </dl>
+  </section>
+
+  <section id="upgrading_newfeatures">
+    <title>Does your module...</title>
+    <dl>
+    <dt>Fill me in</dt>
+    <dd>Consider if filling me in.</dd>
+
+    </dl>
+  </section>
+
+</section>
+
+</manualpage>
diff --git a/docs/manual/developer/new_api_2_6.xml.meta b/docs/manual/developer/new_api_2_6.xml.meta
new file mode 100644 (file)
index 0000000..f79dc30
--- /dev/null
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile reference="new_api_2_6.xml">
+  <basename>new_api_2_6</basename>
+  <path>/developer/</path>
+  <relpath>..</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>
diff --git a/docs/manual/new_features_2_6.xml b/docs/manual/new_features_2_6.xml
new file mode 100644 (file)
index 0000000..5298b7d
--- /dev/null
@@ -0,0 +1,92 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE manualpage SYSTEM "./style/manualpage.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.
+-->
+
+<manualpage metafile="new_features_2_6.xml.meta">
+
+<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.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>Fill me in</dt>
+      <dd></dd>
+
+    </dl>
+  </section>
+
+  <section id="newmods">
+    <title>New Modules</title>
+    <dl>
+      <dt><module>mod_example</module></dt>
+      <dd>Fill me in for <module>mod_example</module>.</dd>
+
+    </dl>
+  </section>
+
+  <section id="module">
+    <title>Module Enhancements</title>
+    <dl>
+      <dt><module>mod_example</module></dt>
+      <dd>Fill me in.</dd>
+
+    </dl>
+  </section>
+
+  <section id="programs">
+    <title>Program Enhancements</title>
+    <dl>
+        <dt><program>fillmein</program></dt>
+        <dd>Fill me in</dd>
+
+    </dl>
+  </section>
+
+  <section id="documentation">
+    <title>Documentation</title>
+    <dl>
+        <dt>Fill me in</dt>
+        <dd>The <module>mod_example</module> documentation fill me in.</dd>
+
+    </dl>
+  </section>
+
+  <section id="developer">
+    <title>Module Developer Changes</title>
+    <dl>
+      <dt>Fill Me In Hook Added</dt>
+
+      <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_6.html">detailed list of API changes</a>.</p>
+  </section>
+
+</manualpage>
diff --git a/docs/manual/new_features_2_6.xml.meta b/docs/manual/new_features_2_6.xml.meta
new file mode 100644 (file)
index 0000000..e67ecdb
--- /dev/null
@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<!-- GENERATED FROM XML: DO NOT EDIT -->
+
+<metafile reference="new_features_2_6.xml">
+  <basename>new_features_2_6</basename>
+  <path>/</path>
+  <relpath>.</relpath>
+
+  <variants>
+    <variant>en</variant>
+  </variants>
+</metafile>