[project @ Added docs to xmlconfig.py and updated packagexml.py to include docs in output XML]

1 files changed, 34 insertions, 1 deletions

diff --git a/admin/xmlconfig.py b/admin/xmlconfig.py
index 5744a8b..dc3cf44 100644
--- a/admin/xmlconfig.py
+++ b/admin/xmlconfig.py
@@ -5,6 +5,8 @@ package.xml file.  Use the 'packagexml.py' program to generate a
 package.xml file for a release of this library.
 """
 
+# This is a list of dicts describing the project leads.  This will be
+# used to generate <lead> XML elements.
 leads = [
     {'name': 'Jonathan Daugherty',
      'user': 'cygnus',
@@ -16,12 +18,43 @@ leads = [
      'active': 'yes'}
     ]
 
+# This is the XML file containing %(...)s formatters.  You'll probably
+# never want to change this unless you make a copy of package.xml and
+# change it somehow.
 template = 'package.xml'
 
-package_name = 'OpenID'
+# The package name.
+package_name = 'Auth_OpenID'
+
+# The package description.
 package_description = 'An implementation of the OpenID single sign-on authentication protocol.'
+
+# Package summary.
 package_summary = 'PHP OpenID'
+
+# License string.
 license_name = 'LGPL'
+
+# License URI.
 license_uri = 'http://www.gnu.org/copyleft/lesser.txt'
+
+# Director(ies) containing package source, relative to the admin/
+# directory.  All .php files in these directories will be included in
+# the <contents> element of the output XML and will be assigned the
+# role 'php'.
 contents_dirs = ['../Auth']
+
+# Director(ies) containing package documentation.  All files and
+# subdirectories in these directories will be included in the
+# <contents> element in the output XML and will be assigned the role
+# 'doc'.
+docs_dirs = ['../doc']
+
+# The HTTP package base URI.  This is the place on the web where the
+# PEAR-installable tarballs will live, and this (plus the package
+# tarball name) will be the URL that users pass to "pear install".
+package_base_uri = 'http://localhost/'
+
+# The release stability.  Maybe this should be a commandline parameter
+# since it might differ from release to release.
 release_stability = 'stable'