svn commit: r560946 - /commons/proper/commons-build/trunk/downloads/README.txt

[ni...@apache.org]

Author: niallp
Date: Mon Jul 30 05:33:34 2007
New Revision: 560946

URL: http://svn.apache.org/viewvc?view=rev&rev=560946
Log:
Add a readme

Added:
    commons/proper/commons-build/trunk/downloads/README.txt   (with props)

Added: commons/proper/commons-build/trunk/downloads/README.txt
URL: http://svn.apache.org/viewvc/commons/proper/commons-build/trunk/downloads/README.txt?view=auto&rev=560946
==============================================================================
--- commons/proper/commons-build/trunk/downloads/README.txt (added)
+++ commons/proper/commons-build/trunk/downloads/README.txt Mon Jul 30 05:33:34 2007
@@ -0,0 +1,41 @@
+The downloads.xml file in this directory is processed by the stylesheets in this
+directory to generate cgi and html pages for downloading the Commons components
+listed in the downloads.xml file.
+
+Whenever a Commons component has a new release, the downloads.xml file must be
+updated.
+
+If a Commons component is removed (e.g. goes TLP), then the CGI and HTML files need
+to be deleted once the details have been removed from downloads.xml
+
+Generating the Download pages
+=============================
+
+1) Generate .cgi and .xml files
+
+In the parent directory run
+
+   ant -f build-downloads.xml
+
+This generates the .xml and .cgi files in the appropriate maven directories
+
+2) Generate the site using maven1
+
+   maven site
+
+This generates .html pages from the .xdoc files (in target\docs\downloads)
+
+
+*** NOTE ***
+============
+The .cgi files need to have permissions set to allow execution on the server - to
+change permissions run the following in the downloads directory:
+
+   chmod 775 *.cgi
+
+
+TODO
+====
+Integrate "build-downloads.xml" into the maven build - this has been commented out of
+maven.xml as it currently fails with:
+    "Provider for javax.xml.transform.TransformerFactory cannot be found"

Propchange: commons/proper/commons-build/trunk/downloads/README.txt
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: commons/proper/commons-build/trunk/downloads/README.txt
------------------------------------------------------------------------------
    svn:keywords = Date Author Id Revision HeadURL