[gentoo-commits] gentoo commit in xml/htdocs/proj/en/webapps: webapp-eclass.xml

[Renat Lumpau (rl03)]

rl03        07/12/04 00:36:37

  Modified:             webapp-eclass.xml
  Log:
  Minor revisions, bug #188949

Revision  Changes    Path
1.13                 xml/htdocs/proj/en/webapps/webapp-eclass.xml

file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/webapps/webapp-eclass.xml?rev=1.13&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/webapps/webapp-eclass.xml?rev=1.13&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/en/webapps/webapp-eclass.xml?r1=1.12&r2=1.13

Index: webapp-eclass.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/en/webapps/webapp-eclass.xml,v
retrieving revision 1.12
retrieving revision 1.13
diff -u -r1.12 -r1.13
--- webapp-eclass.xml	19 Feb 2007 18:58:49 -0000	1.12
+++ webapp-eclass.xml	4 Dec 2007 00:36:36 -0000	1.13
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/webapps/webapp-eclass.xml,v 1.12 2007/02/19 18:58:49 rl03 Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/en/webapps/webapp-eclass.xml,v 1.13 2007/12/04 00:36:36 rl03 Exp $ -->
 
 <guide link="/proj/en/webapps/webapp-eclass.xml" lang="en">
 <title>webapp.eclass Documentation</title>
@@ -10,7 +10,7 @@
 </author>
 
 <abstract>
-The goal of this guide is to teach the reader how to create and maintain ebuilds
+The goal of this guide is to show the reader how to create and maintain ebuilds
 for web applications. It presents an overview of webapp.eclass and then
 discusses three ebuilds of increasing complexity and functionality.
 </abstract>
@@ -19,8 +19,8 @@
 <!-- See http://creativecommons.org/licenses/by-sa/2.5 -->
 <license/>
 
-<version>1.1</version>
-<date>2006-07-09</date>
+<version>1.2</version>
+<date>2007-12-03</date>
 
 <chapter>
 <title>Introduction</title>
@@ -30,15 +30,15 @@
 
 <p>
 <c>webapp.eclass</c> and <c>webapp-config</c> provide a standardized way to
-maintain web applications on Gentoo. Server administrators can use the
+maintain web applications in Gentoo. Server administrators can use the
 <c>webapp-config</c> utility to install, upgrade, and remove software.
 <c>webapp-config</c> relies on a package manager such as Portage to prepare
-the application for installation into multiple virtual hosts. On Gentoo, this
+the application for installation into multiple virtual hosts. In Gentoo, this
 is done by an ebuild that uses <c>webapp.eclass</c>.
 </p>
 
 <p>
-The goal of this guide is to teach the reader how to create and maintain
+The goal of this guide is to show the reader how to create and maintain
 ebuilds for web applications. It presents an overview of
 <c>webapp.eclass</c> and then discusses three ebuilds of increasing complexity
 and functionality. Using the <c>webapp-config</c> utility is beyond the scope
@@ -62,7 +62,7 @@
 <c>webapp-config</c> is under active development. Be sure to install the latest
 version; as of the time of this writing, it is 1.50.14. You can follow the
 development process on our <uri
-link="http://www.vhost-tools.org/">website</uri>.
+link="http://sourceforge.net/projects/webapp-config/">website</uri>.
 </p>
 
 </body>
@@ -83,7 +83,7 @@
 
 <p>
 By default, <c>webapp.eclass</c> will be found under
-<path>/usr/portage/eclass/</path>. By definition, the source code is the
+<path>/usr/portage/eclass/</path>. The source code is the
 ultimate documentation and should be consulted whenever something does not
 perform as expected or further clarification is required.
 </p>
@@ -261,9 +261,7 @@
 Many web-applications written in PHP require that the PHP binary have certain
 capabilities built-in; common requirements include support for sessions and a
 specific database engine. This is typically accomplished by using the
-<c>depend.php</c> eclass; unfortunately, the author is not aware of any existing
-documentation for that eclass. The reader is referred to the eclass itself for
-further information and encouraged to consult relevant ebuilds in Portage.
+<c>depend.php</c> eclass. Please consult that eclass for further information.
 </p>
 
 <warn>
@@ -271,19 +269,19 @@
 ebuilds available. Relying on CPAN is not acceptable.
 </warn>
 
-<p>
+<warn>
 A common mistake with specifying dependencies for web applications is to
 <c>RDEPEND</c> on a database engine such as MySQL or
 PostgreSQL.  Many, if not all, web applications are able to connect to a remote
-database server. Thus, a local database should not be required.
-</p>
+database server. Thus, the ebuild should never explicitly <c>RDEPEND</c> on a database
+such as <path>dev-db/mysql</path> or <path>dev-db/postgresql</path>. Instead,
+consider <c>RDEPEND</c>ing on the appropriate language bindings.
+</warn>
 
 <note>
-Currently, it is not possible to depend on a generic webserver. Instead, you
-must explicitly specify the webserver (e.g., <path>net-www/apache</path>). This
-is inconvenient and has been reported in <uri
-link="http://bugs.gentoo.org/show_bug.cgi?id=11007">bug #11007</uri>; we hope
-that this issue will be resolved soon.
+Carefully consider whether the web application needs Apache (<path>www-servers/apache</path>),
+or if it can work with a generic webserver. Consider using <path>virtual/httpd-basic</path>,
+<path>virtual/httpd-cgi</path>, or <path>virtual/httpd-fastcgi</path> instead.
 </note>
 
 <p>



-- 
gentoo-commits@g.o mailing list