You are viewing a plain text version of this content. The canonical link for it is here.
Posted to site-cvs@jakarta.apache.org by hu...@apache.org on 2002/04/01 13:22:03 UTC
cvs commit: jakarta-site2/docs/site packageversioning.html packageversioning-manifest.template packageversioning-build.xml guides.html
husted 02/04/01 03:22:03
Modified: docs/site guides.html
Added: docs/site packageversioning.html
packageversioning-manifest.template
packageversioning-build.xml
Log:
Add draft packageversioning document; link from guides; trim headlines.
Revision Changes Path
1.12 +42 -34 jakarta-site2/docs/site/guides.html
Index: guides.html
===================================================================
RCS file: /home/cvs/jakarta-site2/docs/site/guides.html,v
retrieving revision 1.11
retrieving revision 1.12
diff -u -r1.11 -r1.12
--- guides.html 29 Mar 2002 19:24:09 -0000 1.11
+++ guides.html 1 Apr 2002 11:22:03 -0000 1.12
@@ -157,34 +157,40 @@
<li><a href="http://www.mail-archive.com/general@jakarta.apache.org/msg02778.html">Brief History of Jakarta and the ASF</a>
<ul>
<li><a href="http://java.apache.org/main/constitution.html">The Java Apache Project Constitution</a></li>
- <li><a href="http://jakarta.apache.org/site/faqs.html#Open Source Incubators">What about an ApacheForge?</a></li>
- <li><a href="http://jakarta.apache.org/site/pmc/01-03-19-meeting-summary.html">Resolution: Jakarta</a></li>
+ <li><a href="faqs.html#Open Source Incubators">What about an ApacheForge?</a></li>
+ <li><a href="pmc/01-03-19-meeting-summary.html">Resolution: Jakarta</a></li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/whoweare.html"> Who We Are</a></li>
- <li><a href="http://jakarta.apache.org/site/jon"> Jon's Fan Club</a></li>
- <li><a href="http://jakarta.apache.org/site/acknowledgements.html"> Acknowledgements</a></li>
+ <li><a href="whoweare.html">Who We Are</a></li>
+ <li><a href="../index.html#Jakarta Subprojects">Jakarta Subprojects</a></li>
+ <li><a href="jon.html"> Jon's Fan Club</a></li>
+ <li><a href="acknowledgements.html"> Acknowledgements</a></li>
</ul>
<h2>Introduction</h2>
<ul>
<li><a href="http://www.apache.org/">Welcome! - The Apache Software Foundation</a></li>
<li><a href="http://apache.org/foundation/projects.html">Projects - The Apache Software Foundation</a></li>
- <li><a href="http://jakarta.apache.org/site/mission.html"> Mission</a>
+ <li><a href="mission.html"> Mission</a>
<ul>
<li>XML <a href="http://cvs.apache.org/viewcvs.cgi/xml-admin/charter.txt">Charter</a></li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/roles.html"> Roles and Responsibilities</a></li>
+ <li><a href="roles.html"> Roles and Responsibilities</a></li>
</ul>
<h2>User Guide</h2>
<ul>
- <li><a href="http://jakarta.apache.org/">Welcome to the Jakarta Project</a></li>
- <li><a href="http://jakarta.apache.org/site/roles.html"> Roles and Responsibilities</a>
+ <li><a href="http://jakarta.apache.org/">Welcome to the Jakarta Project</a>
+ <ul>
+ <li><a href="../index.html#Jakarta Subprojects">Jakarta Subprojects</a></li>
+ <li><a href="overview.html">Product Catalog</a></li>
+ </ul>
+ </li>
+ <li><a href="roles.html"> Roles and Responsibilities</a>
<ul>
- <li>XML <a href="http://xml.apache.org/roles.html">Roles and Responsibilities</a></li>
+ <li>XML <a href="roles.html">Roles and Responsibilities</a></li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/cvsindex.html">CVS Repository</a></li>
+ <li><a href="cvsindex.html">CVS Repository</a></li>
<li>Licensing
<ul>
<li>What you can do with Apache products.</li>
@@ -196,32 +202,32 @@
<li>Whom you should ask, what you should figure out yourself. </li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/communication.html">Communication</a></li>
+ <li><a href="communication.html">Communication</a></li>
<li>Documentation
<ul>
<li>Where to look for it.</li>
<li>What to expect, what not to expect. </li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/bugs.html">Bugzilla</a>
+ <li><a href="bugs.html">Bugzilla</a>
<ul>
<li><a href="http://scarab.tigris.org/">Scarab</a></li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/mail.html">Mailing Lists</a>
+ <li><a href="mail.html">Mailing Lists</a>
<ul>
<li>XML <a href="http://xml.apache.org/mail.html">Mailing Lists</a></li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/library.html">Reference Library</a></li>
- <li><a href="http://jakarta.apache.org/site/faqs.html">FAQs</a></li>
+ <li><a href="library.html">Reference Library</a></li>
+ <li><a href="faqs.html">FAQs</a></li>
<li><a href="http://search.apache.org/">Search Apache</a>
<ul>
<li>with Google</li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/contact.html"> Contact Information</a></li>
- <li><a href="http://jakarta.apache.org/site/getinvolved.html"> Get Involved</a></li>
+ <li><a href="contact.html"> Contact Information</a></li>
+ <li><a href="getinvolved.html"> Get Involved</a></li>
</ul>
<h2>Moderator's Guide</h2>
<p>What mailing list moderators need to know.</p>
@@ -238,9 +244,9 @@
<li>Copyright notices</li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/source.html">Source Repositories</a>
+ <li><a href="source.html">Source Repositories</a>
<ul>
- <li><a href="http://jakarta.apache.org/site/faqs.html#Coding Conventions and Standards">Product Coding Conventions</a></li>
+ <li><a href="faqs.html#Coding Conventions and Standards">Product Coding Conventions</a></li>
<li>Follow product conventions for new code.</li>
<li>Otherwise, "Adhere to the style of the original." </li>
<li>XML <a href="http://xml.apache.org/source.html">Source Repositories</a>
@@ -251,7 +257,7 @@
</li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/source.html">Product Documentation</a>
+ <li><a href="source.html">Product Documentation</a>
<ul>
<li>Subject to same procedures as source code</li>
<li>Why XML</li>
@@ -273,21 +279,21 @@
</li>
</ul>
<p><a href="http://httpd.apache.org/security_report.html">Reporting Security Problems with Apache</a></p>
- <p><a href="http://jakarta.apache.org/site/agreement.html">Contributor License Agreement</a></p>
- <p><a href="http://jakarta.apache.org/site/decisions.html">Decision Making</a> (XML <a href="http://xml.apache.org/decisions.html">Decision Making</a>)</p>
+ <p><a href="agreement.html">Contributor License Agreement</a></p>
+ <p><a href="decisions.html">Decision Making</a> (XML <a href="http://xml.apache.org/decisions.html">Decision Making</a>)</p>
<h2>Committer's Guide</h2>
<ul>
<li>CVS Access
<ul>
- <li><a href="http://jakarta.apache.org/site/cvsonunix.html">from Unix</a></li>
- <li><a href="http://jakarta.apache.org/site/cvsonwin32.html">from Windows</a></li>
+ <li><a href="cvsonunix.html">from Unix</a></li>
+ <li><a href="cvsonwin32.html">from Windows</a></li>
<li>At least one subproject committer needs access to jakarta.apache.org too - ask root@apache.org</li>
<li>A group-friendly umask (such as <code>002</code>) must be used at all times on ASF servers</li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/jars.html">JARs under CVS</a></li>
+ <li><a href="jars.html">JARs under CVS</a></li>
<li><a href="http://www.x180.net/Mutterings/OpenSource/RulesForRevEmail.html">Rules for Revolutionaries</a></li>
- <li><a href="http://jakarta.apache.org/site/proposal.html"> Proposed Changes - Jakarta Project Guidelines</a></li>
+ <li><a href="proposal.html"> Proposed Changes - Jakarta Project Guidelines</a></li>
<li>Committing HTML to Web site
<ul>
<li>site2 approach - checkin and update</li>
@@ -322,7 +328,7 @@
<li>six-month guideline; reviewing email and patches</li>
<li>pinging team and candidate</li>
<li>nominating</li>
- <li><a href="http://jakarta.apache.org/site/roles.html">welcome message</a></li>
+ <li><a href="roles.html">welcome message</a></li>
<li>granting karma; suggested username; root@apache.org</li>
<li>who we are</li>
<li>mentoring</li>
@@ -333,8 +339,10 @@
<ul>
<li>When to release, what to release.</li>
<li>Release process. </li>
- <li><a href="http://jakarta.apache.org/site/binindex.html">Release Flavors</a></li>
- <li><a href="http://jakarta.apache.org/site/jakarta-site2.html">About This Site</a></li>
+ <li><a href="binindex.html">Release Flavors</a></li>
+ <li><a href="versioning.html">Release Versioning</a></li>
+ <li><a href="packageversioning.html">Package Versioning</a></li>
+ <li><a href="jakarta-site2.html">About This Site</a></li>
<li>Release directories are removed to "archives" when they are no longer the most recent of that type. For example, an RC1 release would go under "releases" until there was either an RC2 or final release of the same version number (1.0.1 in this case). In addition, once there is a 1.0.2 final release, the 1.0.1 final release would go to "archives".</li>
<li>Credit checks; granting emeritus status</li>
<li>Needs site2 and web site access</li>
@@ -359,14 +367,14 @@
<li>Why the Apache License</li>
</ul>
</li>
- <li><a href="http://jakarta.apache.org/site/newproject.html">Jakarta Sub-Project Proposals</a></li>
- <li><a href="http://jakarta.apache.org/site/dirlayout.html"> Jakarta Directory Layout</a></li>
+ <li><a href="newproject.html">Jakarta Sub-Project Proposals</a></li>
+ <li><a href="dirlayout.html"> Jakarta Directory Layout</a></li>
<li><a href="http://www.apache.org/dev/project-creation.html">Procedures for Creating an ASF Project </a></li>
</ul>
<h2>Project Manager's Guide</h2>
<ul>
- <li><a href="http://jakarta.apache.org/site/management.html"> Project Management Committee Bylaws</a></li>
- <li><a href="http://jakarta.apache.org/site/pmc/index.html"> PMC Meeting Archive</a></li>
+ <li><a href="management.html"> Project Management Committee Bylaws</a></li>
+ <li><a href="pmc/index.html"> PMC Meeting Archive</a></li>
</ul>
<h2>System Administrator's Guide</h2>
<ul>
1.1 jakarta-site2/docs/site/packageversioning.html
Index: packageversioning.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<meta name="author" value="ajack">
<meta name="email" value="ajack@openbiz.biz">
<title>The Jakarta Site - $root.getChild("properties").getChild("title").getText()</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
<td colspan="2">
<a href="http://jakarta.apache.org"><img src="http://jakarta.apache.org/images/jakarta-logo.gif" align="left" border="0"/></a>
</td>
</tr>
</table>
<table border="0" width="100%" cellspacing="4">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td width="20%" valign="top" nowrap="true">
<p><strong>About Jakarta</strong></p>
<ul>
<li> <a href="../index.html">Welcome</a>
</li>
<li> <a href="http://jakarta.apache.org/site/news.html">News & Status</a>
</li>
<li> <a href="http://jakarta.apache.org/site/mission.html">Our Mission</a>
</li>
<li> <a href="http://jakarta.apache.org/site/faqs.html">Our FAQs</a>
</li>
<li> <a href="http://jakarta.apache.org/site/library.html">Reference Library</a>
</li>
<li> <a href="http://www.google.com/advanced_search?q=+site:jakarta.apache.org&hl=en&as_qdr=all">Search Jakarta</a>
</li>
<li> <a href="http://jakarta.apache.org/site/contact.html">Contacting Us</a>
</li>
</ul>
<p><strong>Download</strong></p>
<ul>
<li> <a href="http://jakarta.apache.org/site/binindex.html">Binaries</a>
</li>
<li> <a href="http://jakarta.apache.org/site/sourceindex.html">Source Code</a>
</li>
</ul>
<p><strong>Get Involved</strong></p>
<ul>
<li> <a href="http://jakarta.apache.org/site/getinvolved.html">How to ...</a>
</li>
<li> <a href="http://jakarta.apache.org/site/cvsindex.html">CVS Repositories</a>
</li>
<li> <a href="http://jakarta.apache.org/site/mail.html">Mailing Lists</a>
</li>
<li> <a href="http://jakarta.apache.org/site/bugs.html">Bug Database</a>
</li>
</ul>
<p><strong>SubProjects</strong></p>
<ul>
<li> <a href="../alexandria/index.html">Alexandria</a>
</li>
<li> <a href="../ant/index.html">Ant</a>
</li>
<li> <a href="../avalon/index.html">Avalon</a>
</li>
<li> <a href="../bcel/index.html">BCEL</a>
</li>
<li> <a href="../cactus/index.html">Cactus</a>
</li>
<li> <a href="../commons/index.html">Commons</a>
</li>
<li> <a href="../ecs/index.html">ECS</a>
</li>
<li> <a href="../james/index.html">James</a>
</li>
<li> <a href="../jetspeed/index.html">Jetspeed</a>
</li>
<li> <a href="../jmeter/index.html">JMeter</a>
</li>
<li> <a href="../log4j/index.html">Log4J</a>
</li>
<li> <a href="../lucene/index.html">Lucene</a>
</li>
<li> <a href="../oro/index.html">ORO</a>
</li>
<li> <a href="../poi/index.html">POI</a>
</li>
<li> <a href="../regexp/index.html">Regexp</a>
</li>
<li> <a href="../slide/index.html">Slide</a>
</li>
<li> <a href="../struts/index.html">Struts</a>
</li>
<li> <a href="../taglibs/index.html">Taglibs</a>
</li>
<li> <a href="../tomcat/index.html">Tomcat</a>
</li>
<li> <a href="../turbine/index.html">Turbine</a>
</li>
<li> <a href="../velocity/index.html">Velocity</a>
</li>
<li> <a href="../watchdog/index.html">Watchdog</a>
</li>
</ul>
<p><strong>Project Management</strong></p>
<ul>
<li> <a href="http://jakarta.apache.org/site/whoweare.html">Who We Are</a>
</li>
<li> <a href="http://jakarta.apache.org/site/guidelines.html">Project Guidelines</a>
</li>
<li> <a href="http://jakarta.apache.org/site/newproject.html">New Subprojects</a>
</li>
<li> <a href="http://jakarta.apache.org/site/jakarta-site2.html">Website Maintenance</a>
</li>
<li> <a href="http://jakarta.apache.org/site/acknowledgements.html">Acknowledgements</a>
</li>
<li> <a href="http://jakarta.apache.org/site/legal.html">Legal</a>
</li>
<li> <a href="http://jakarta.apache.org/site/jspa-position.html">Apache on the JSPA</a>
</li>
</ul>
</td>
<td width="80%" align="left" valign="top">
<table border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Package Versioning"><strong>Package Versioning</strong></a>
</font>
</td></tr>
<tr><td>
<blockquote>
<P>
The <A TARGET="_new" HREF="http://java.sun.com/j2se/1.4/docs/guide/versioning/spec/VersioningSpecification.html">Java(tm) Product Versioning Specification</A> allows users to identify the exact version information of a package within a JAR. This is particularly useful when users have a number of packages, with version interdependences, from various distributions.
</P>
<P>
These four simple steps use ANT to maintain and insert the versioning information, so all JARs shipped are correctly versioned. <B>Note:</B> This is just one method, and in future releases ANT may have built in mechanisms for this task.
</P>
<H3>Step 1: Manually create a template manifest file.</H3>
<P>Java versioning is implemented by attributes set within the manifest of the JAR.</P>
<P>
See Javasoft's documentation on: <A TARGET="_new" HREF="http://java.sun.com/j2se/1.4/docs/guide/versioning/spec/VersioningSpecification.html#JARManifestFormat">JAR Manifest Format</A>
</P>
<P>
<TABLE BORDER="1" ALIGN="CENTER">
<TR><TD><PRE>
Manifest-version: 1.0
Name: org/apache/{Apache Package}/
Implementation-Title: {Apache Package}
Implementation-Version: @version@
Implementation-Vendor: "Apache Software Foundation"
</PRE>
</TD></TR>
</TABLE>
</P>
<P>
Save this with your build.xml as a file called <B>manifest.template</B>.
</P>
<P>
<B>Note:</B> The <EM>{Apacke Package}</EM> ought be manually replaced by the package name, e.g. "log4j" or "Axis"<BR />
<B>Note:</B> The <EM>@version@</EM> is a specific keyword used later in ANT filtering, and will be dynamically updated.
</P>
<H3>Step 2: Maintain the version in your ANT build script</H3>
<P>
Set and maintain the <B>${version}</B> property.
</P>
<P>
<TABLE BORDER="1" ALIGN="CENTER">
<TR><TD><PRE><property name="version" value="1-1-1" /></PRE></TD></TR>
</TABLE>
</P>
<H3>Step 3: Create the manifest, filtering the version</H3>
<P>
This replaces <B>@version@</B> in <EM>manifest.template</EM> with <B>1-1-1</B> in <EM>manifest.mf</EM>.
</P>
<P>
<TABLE BORDER="1" ALIGN="CENTER">
<TR><TD><PRE>
<target name="manifest">
<filter token="version" value="${version}" />
<copy file="manifest.template"
tofile="manifest.mf"
overwrite="true"
filtering="true" />
</target></PRE></TD></TR>
</TABLE>
</P>
<H3>Step 4: Create your JAR, setting the manifest attribute</H3>
<P>
This sets the <B>META-INF/Manifest.mf</B> in the JAR file.
</P>
<P>
<TABLE BORDER="1" ALIGN="CENTER">
<TR><TD><PRE>
<target name="distribution" depends="<EM>...</EM> manifest <EM>...</EM>">
<jar jarfile=<EM>...</EM>
<B>manifest="manifest.mf"</B>/>
</PRE>
</TD></TR>
</TABLE>
</P>
<HR WIDTH="100%" />
<P>
Sample Files: <A HREF="manifest.template">manifest.template</A>, <A HREF="build.xml">build.xml</A>
</P>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright © 1999-2002, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
</body>
</html>
<!-- end the processing -->
1.1 jakarta-site2/docs/site/packageversioning-manifest.template
Index: packageversioning-manifest.template
===================================================================
Manifest-version: 1.0
Name: org/apache/{Apache Package}/
Implementation-Title: {Apache Package}
Implementation-Version: @version@
Implementation-Vendor: "Apache Software Foundation"
1.1 jakarta-site2/docs/site/packageversioning-build.xml
Index: packageversioning-build.xml
===================================================================
<?xml version="1.0"?>
<project name="manifest" default="manifest" basedir=".">
<property name="version" value="1-1-1" />
<target name="manifest">
<filter token="version" value="${version}" />
<copy file="manifest.template"
tofile="manifest.mf"
overwrite="true"
filtering="true" />
</target>
</project>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>