husted 02/04/01 03:20:57
Modified: xdocs/site guides.xml
Added: xdocs/site packageversioning.xml
Log:
Add draft packageversioning document; link from guides; trim headlines.
Revision Changes Path
1.7 +42 -34 jakarta-site2/xdocs/site/guides.xml
Index: guides.xml
===================================================================
RCS file: /home/cvs/jakarta-site2/xdocs/site/guides.xml,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -r1.6 -r1.7
--- guides.xml 28 Mar 2002 17:45:40 -0000 1.6
+++ guides.xml 1 Apr 2002 11:20:57 -0000 1.7
@@ -21,36 +21,42 @@
<li><a
href="http://www.mail-archive.com/[email protected]/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>
@@ -62,32 +68,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>
@@ -106,9 +112,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>
@@ -119,7 +125,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>
@@ -141,22 +147,22 @@
</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 [EMAIL PROTECTED]</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>
@@ -191,7 +197,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; [EMAIL PROTECTED]</li>
<li>who we are</li>
<li>mentoring</li>
@@ -203,8 +209,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>
@@ -230,15 +238,15 @@
<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>
1.1 jakarta-site2/xdocs/site/packageversioning.xml
Index: packageversioning.xml
===================================================================
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">ajack</author>
</properties>
<body>
<section name="Package Versioning">
<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>
</section>
</body>
</document>
--
To unsubscribe, e-mail: <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>
