[gentoo-doc-cvs] cvs commit: apache-developer.xml

["Sven Vermeulen" <swift@lark.gentoo.org>]

swift       05/08/01 15:52:23

  Modified:    xml/htdocs/doc/en apache-upgrading.xml metadoc.xml
  Added:       xml/htdocs/doc/en apache-developer.xml
  Log:
  #99539 - Apache developer documentation

Revision  Changes    Path
1.2       +2 -2      xml/htdocs/doc/en/apache-upgrading.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/apache-upgrading.xml?rev=1.2&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/apache-upgrading.xml?rev=1.2&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/apache-upgrading.xml.diff?r1=1.1&r2=1.2&cvsroot=gentoo

Index: apache-upgrading.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/apache-upgrading.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- apache-upgrading.xml	1 Aug 2005 15:17:11 -0000	1.1
+++ apache-upgrading.xml	1 Aug 2005 15:52:23 -0000	1.2
@@ -16,7 +16,7 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>2.1</version>
+<version>2.2</version>
 <date>2005-08-01</date>
 
 <chapter>
@@ -66,7 +66,7 @@
 This document details how to upgrade without breaking your system. If you are 
 a  developer or would like to know what we changed, or how ebuilds need to be 
 modified to take advantage of our eclass, then check the <uri 
-link="/proj/en/developer.xml">Apache Developer Reference</uri>.
+link="apache-developer.xml">Apache Developer Reference</uri>.
 </p>
 
 </body>



1.92      +6 -1      xml/htdocs/doc/en/metadoc.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.92&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml?rev=1.92&content-type=text/plain&cvsroot=gentoo
diff : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/metadoc.xml.diff?r1=1.91&r2=1.92&cvsroot=gentoo

Index: metadoc.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v
retrieving revision 1.91
retrieving revision 1.92
diff -u -r1.91 -r1.92
--- metadoc.xml	1 Aug 2005 15:17:11 -0000	1.91
+++ metadoc.xml	1 Aug 2005 15:52:23 -0000	1.92
@@ -1,5 +1,5 @@
 <?xml version='1.0' encoding="UTF-8"?>
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.91 2005/08/01 15:17:11 swift Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/doc/en/metadoc.xml,v 1.92 2005/08/01 15:52:23 swift Exp $ -->
 <!DOCTYPE metadoc SYSTEM "/dtd/metadoc.dtd">
 
 <metadoc lang="en">
@@ -361,6 +361,7 @@
     <file id="shb-uptodate">/doc/en/security/shb-uptodate.xml</file>
     <file id="apache-troubleshooting">/doc/en/apache-troubleshooting.xml</file>
     <file id="apache-upgrading">/doc/en/apache-upgrading.xml</file>
+    <file id="apache-developer">/doc/en/apache-developer.xml</file>
   </files>
   <docs>
     <doc id="name-logo">
@@ -989,5 +990,9 @@
       <memberof>sysadmin_specific</memberof>
       <fileid>apache-upgrading</fileid>
     </doc>
+    <doc id="apache-developer">
+      <memberof>gentoodev_docs</memberof>
+      <fileid>apache-developer</fileid>
+    </doc>
   </docs>
 </metadoc>



1.1                  xml/htdocs/doc/en/apache-developer.xml

file : http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/apache-developer.xml?rev=1.1&content-type=text/x-cvsweb-markup&cvsroot=gentoo
plain: http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/doc/en/apache-developer.xml?rev=1.1&content-type=text/plain&cvsroot=gentoo

Index: apache-developer.xml
===================================================================
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
<guide link="apache-developer.xml" lang="en">
<title>Apache Developer Documentation</title>

<author title="Author">
  <mail link="vericgar@gentoo.org">Michael Stewart</mail>
</author>

<abstract>
This document provides details about the new eclasses available for developers 
of packages that relate to Apache.
</abstract>

<!-- The content of this document is licensed under the CC-BY-SA license -->
<!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
<license/>

<version>2.1</version>
<date>2005-08-01</date>

<chapter>
<title>About this document</title>
<section>
<body>

<p>
This document details the <uri link="#apache-module">new eclasses</uri>, <uri 
link="#changes">what we changed</uri> from the previous style of apache and 
how ebuilds need to be <uri link="#ebuild-update">modified</uri> to take 
advantage of our new eclasses. If you are a user looking for information on 
how to upgrade, please use the <uri link="apache-upgrading.xml">Upgrading 
Apache</uri> document.
</p>

</body>
</section>
</chapter>

<chapter id="changes">
<title>What Has Changed</title>
<section>
<title>Overview</title>
<body>

<p>
We have made many changes to the way Apache and its modules install and work 
on Gentoo. This eases the maintenance burden and more closely follows upstream 
practices. Our changes are:
</p>

<ul>
  <li>Fixed many <uri link="#buglist">bugs</uri></li>
  <li>Changed installation and configuration paths</li>
  <li>
    Created <uri link="#depend-apache">depend.apache</uri> and <uri	
    link="#apache-module">apache-module</uri> eclasses
  </li>
  <li>
    Combined apache.conf and commonapache.conf into one file that is very 
    similar to how upstream distributes it
  </li>
  <li>
    Split <c>apr</c> and <c>apr-utils</c> out of apache so some packages no 
    longer require apache
  </li>
  <li>Updated and version bumped nearly every module</li>
  <li>Made more MPMs available</li>
  <li>Added lingerd support</li>
  <li>Fixed large file support</li>
  <li><e>Much more I'm sure I'm forgetting...</e></li>
</ul>

</body>
</section>
<section>
<title>Apache Path Locations</title>
<body>

<p>
In order to more closely follow how upstream and other distributions install 
apache, the following paths have changed:
</p>

</body>
</section>
<section>
<title>Apache 1.x</title>
<body>

<table>
<tr>
  <th>Use</th>
  <th>Old Path</th>
  <th>New Path</th>
</tr>
<tr>
  <ti>Server Root</ti>
  <ti><path>/etc/apache/</path></ti>
  <ti><path>/usr/lib/apache/</path></ti>
</tr>
<tr>
  <ti>Configuration Directory</ti>
  <ti><path>/etc/apache/conf/</path></ti>
  <ti><path>/etc/apache/</path></ti>
</tr>
<tr>
  <ti>Configuration</ti>
  <ti><path>/etc/apache/conf/apache.conf</path></ti>
  <ti><path>/etc/apache/httpd.conf</path></ti>
</tr>
<tr>
  <ti>Configuration</ti>
  <ti><path>/etc/apache/conf/commonapache.conf</path></ti>
  <ti><path>/etc/apache/httpd.conf</path></ti>
</tr>
<tr>
  <ti>Vhosts Configuration</ti>
  <ti><path>/etc/apache/conf/vhosts/</path></ti>
  <ti><path>/etc/apache/vhosts.d/</path></ti>
</tr>
<tr>
  <ti>Modules Configuration</ti>
  <ti><path>/etc/apache/conf/addon-modules/</path></ti>
  <ti><path>/etc/apache/modules.d/</path></ti>
</tr>
<tr>
  <ti>Module Binaries</ti>
  <ti><path>/usr/lib/apache-extramodules/</path></ti>
  <ti><path>/usr/lib/apache/modules/</path></ti>
</tr>
</table>

</body>
</section>
<section>
<title>Apache 2.x</title>
<body>

<table>
<tr>
  <th>Use</th>
  <th>Old Path</th>
  <th>New Path</th>
</tr>
<tr>
  <ti>Server Root</ti>
  <ti><path>/etc/apache2/</path></ti>
  <ti><path>/usr/lib/apache2/</path></ti>
</tr>
<tr>
  <ti>Configuration Directory</ti>
  <ti><path>/etc/apache2/conf/</path></ti>
  <ti><path>/etc/apache2/</path></ti>
</tr>
<tr>
  <ti>Configuration</ti>
  <ti><path>/etc/apache2/conf/apache2.conf</path></ti>
  <ti><path>/etc/apache2/httpd.conf</path></ti>
</tr>
<tr>
  <ti>Configuration</ti>
  <ti><path>/etc/apache2/conf/commonapache2.conf</path></ti>
  <ti><path>/etc/apache2/httpd.conf</path></ti>
</tr>
<tr>
  <ti>Vhosts Configuration</ti>
  <ti><path>/etc/apache2/conf/vhosts/</path></ti>
  <ti><path>/etc/apache2/vhosts.d/</path></ti>
</tr>
<tr>
  <ti>Modules Configuration</ti>
  <ti><path>/etc/apache2/conf/modules.d/</path></ti>
  <ti><path>/etc/apache2/modules.d/</path></ti>
</tr>
<tr>
  <ti>Module Binaries</ti>
  <ti><path>/usr/lib/apache2-extramodules/</path></ti>
  <ti><path>/usr/lib/apache2/modules/</path></ti>
</tr>
</table>

<note>
The default configuration now automatically includes 
<path>modules.d/*.conf</path> and <path>vhosts.d/*.conf</path> by default. 
However, the directive in <path>httpd.conf</path> lists the above as 
<path>conf/modules.d/*.conf</path> and <path>conf/vhosts.d/*.conf</path>. This 
is because Apache reads the configuration using the directory 
<path>/usr/lib/apache{|2}</path> which contains a symbolic link <path>conf -> 
/etc/apache{|2}</path>.
</note>


<impo>
If you are a developer updating an ebuild to work with the changes we've made,
please do not hard-code the above paths into your ebuild - see the eclass 
documentation on appropriate variables you can use instead.
</impo>




-- 
gentoo-doc-cvs@gentoo.org mailing list