You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@turbine.apache.org by jv...@apache.org on 2002/02/21 15:14:58 UTC
cvs commit: jakarta-turbine-maven/xdocs jrcs.xml
jvanzyl 02/02/21 06:14:58
Added: xdocs jrcs.xml
Log:
- adding the documentation for jrcs
pete could you possibly convert this to an xdoc, pretty please :-)
Revision Changes Path
1.1 jakarta-turbine-maven/xdocs/jrcs.xml
Index: jrcs.xml
===================================================================
<html>
<head>
<meta name="generator" content="HTML Tidy, see www.w3.org">
<title>
JRCS - A RCS Archive Parser in Java
</title>
<link rel="stylesheet" type="text/css" href=
"../style/suigeneris.css">
</head>
<body>
<!--#include file="../software/navbar.html" -->
<hr>
<h1>
JRCS
</h1>
<h2>
An RCS Archive parser and differencing engine in Java
</h2>
<p>
<a href="../jrcs/">jrcs</a> is a library for parsing and
manipulation of RCS archive files like the ones produced by the
RCS (Revision Control System) itself and by CVS (Concurrent
Version System).
</p>
<p>
JRCS is distributed under the <a href="COPYING.html">GNU General
Public License</a> (GPL). Please read the <a href="COPYING.html">
license</a> before you proceed to download.
</p>
<p>
JRCS's home page is at <a href="http://www.suigeneris.org/jrcs/">
http://www.suigeneris.org/jrcs/</a>.
</p>
<p>
The current version of JRCS is 0.1.2
</p>
<h2>
Diff in Java
</h2>
<p>
The library also includes a differencing engine that uses a a
simple, fast, and effective algorithm that I developed. The diff
engine can be used by itself to compare the contents of any two
arrays, whatever their contents (yes, you can compare text and
everything else too).
</p>
<h2>
Download
</h2>
<p>
There are two distributions of JRCS:
</p>
<ul>
<li>
The <a href="dist/jrcs-full-0.1.2.tar.gz">full</a> (~330K)
distribution includes everything you need to use the library,
including the third party libraries <a href=
"http://www.cacas.org/java/gnu/regexp/">gnu.regexp</a>, and <a
href="http://www.junit.org">JUnit</a>. Precompiled jar files
are also included. <a href="dist/jrcs-full-0.1.2.tar.gz">
[download]</a>
</li>
<li>
The <a href="dist/jrcs-0.1.2.tar.gz">compact</a> (~160K)
distribution includes everything above except the third party
libraries, which you can get from their home sites as explained
below. <a href="dist/jrcs-0.1.2.tar.gz">[download]</a>
</li>
</ul>
<br>
<h2>
Documentation
</h2>
<p>
Both distributions of JRCS contain bare-bones API documentation
generated by JavaDoc. There's also a <a href="doc/api/">local
copy</a> of the documentation accesible from this site.
</p>
<p>
In the lack of a user manual, I recomment you examine the test
suite classes as found in the <code><jrcs>/tests</code>
directory in the distribution.
</p>
<h2>
Third party stuff used/required by JRCS
</h2>
<h3>
JUnit
</h3>
<p>
The library tests are written for the JUnit Testing Framework.
For distributions and documentation of JUnit see <a href=
"http://www.junit.org/">http://www.junit.org/</a>.
</p>
<h3>
GNU Regexp
</h3>
<p>
The GNU regexp Java library is used for RCS keyword management.
You can get a copy of gnu.regexp from <a href=
"http://www.cacas.org/java/gnu/regexp/">
http://www.cacas.org/java/gnu/regexp/</a>. A copy of gnu.regexp
is included in the full distribution of this library.
</p>
<h3>
Ant
</h3>
<p>
Jakarta Ant is used for building the JRCS library. Ant is the
Jakarta project's build tool. You can get a copy of Ant from <a
href="http://jakarta.apache.org/ant/">
http://jakarta.apache.org/ant/</a>.
</p>
<p>
You'll need to also download the optional Ant tasks if you'll be
running JavaCC (more info on JavaCC below).
</p>
<h3>
JavaCC
</h3>
<p>
The RCS parser is constructed using the JavaCC compiler compiler.
You can get a copy of JavaCC from <a href=
"http://www.metamata.com/javacc/">
http://www.metamata.com/javacc/</a> .
</p>
<p>
JavaCC is not distributable, so you must get a copy of it
yourself if you intend to use it. Keep in mind that, as
distributed, this library does not require JavaCC to be compiled
because all the JavaCC generated .java files are included.
</p>
<p>
If you decide to use JavaCC, please adjust the "javacc.lib.dir"
property in the build.xml script as needed. You'll also need to
download the set of optional tasks for Ant.
</p>
<h2>
Change Log
</h2>
<table bordercolor="green" border="1" cellspacing="0" width="100%">
<tr>
<td>
2002.01.08
</td>
<td>
v0.1.2
</td>
<td>
Minor changes to distribution
</td>
</tr>
<tr>
<td>
2001.09.17
</td>
<td>
v0.1.1
</td>
<td>
<p>
Added Archive.getReleaseVersion() methods to retreive tip
version numbers without having to retreive the the
release's text.
</p>
<p>
Fixed BranchNode.nextInPathTo() so it went on till the tip
revision when in soft mode.
</p>
<p>
Refactored path getting code in Archive.getRelease() to
make it common to Archive.getReleaseVersion()
</p>
</td>
</tr>
<tr>
<td>
2001.03.22
</td>
<td>
v0.1.0
</td>
<td>
Fixed spelling and typing mistakes in the site/docs
</td>
</tr>
</table>
<hr>
<!--#include file="../software/navbar.html" -->
<!-- \$Id: jrcs.xml,v 1.1 2002/02/21 14:14:58 jvanzyl Exp $ -->
<!--#include file="../copyright.html" -->
</body>
</html>
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: cvs commit: jakarta-turbine-maven/xdocs jrcs.xml
Posted by Jason van Zyl <jv...@zenplex.com>.
On Thu, 2002-02-21 at 20:55, Pete Kazmier wrote:
> On Thu, Feb 21, 2002 at 02:14:58PM -0000, jvanzyl@apache.org wrote:
> > jvanzyl 02/02/21 06:14:58
> >
> > Added: xdocs jrcs.xml
> > Log:
> > - adding the documentation for jrcs
> >
> > pete could you possibly convert this to an xdoc, pretty please :-)
>
> Done.
Cool and the gang!
> --
> To unsubscribe, e-mail: <ma...@jakarta.apache.org>
> For additional commands, e-mail: <ma...@jakarta.apache.org>
--
jvz.
Jason van Zyl
jvanzyl@apache.org
http://tambora.zenplex.org
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>
Re: cvs commit: jakarta-turbine-maven/xdocs jrcs.xml
Posted by Pete Kazmier <pe...@kazmier.com>.
On Thu, Feb 21, 2002 at 02:14:58PM -0000, jvanzyl@apache.org wrote:
> jvanzyl 02/02/21 06:14:58
>
> Added: xdocs jrcs.xml
> Log:
> - adding the documentation for jrcs
>
> pete could you possibly convert this to an xdoc, pretty please :-)
Done.
--
To unsubscribe, e-mail: <ma...@jakarta.apache.org>
For additional commands, e-mail: <ma...@jakarta.apache.org>