Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant
In directory sc8-pr-cvs1:/tmp/cvs-serv11553/src/documentation/content/xdocs/ant
Modified Files:
constraint.xml environment.xml dest.xml versionId.xml book.xml
cut-n-paste.xml troubleshooting.xml brand.xml
Added Files:
available.xml
Log Message:
Docs
--- NEW FILE: available.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "./dtd/document-v11.dtd">
<document>
<header>
<title>Krysalis-Version: 'version-available' Ant Task</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>Description</title>
<p>Set a property if a given (perhaps constrained) version is avaiable</p>
</section>
<section><title>Parameters</title>
<table>
<tr><th>Attribute</th><th>Description</th><th>Required</th><th>Default</th></tr>
<tr><td><link href="versionId.html">versionId</link></td><td>Version Identifier</td><td>Yes</td><td>N/A</td></tr>
</table>
</section>
<section>
<title>Parameters specified as nested elements</title>
<p>None</p>
</section>
<section>
<title>Parameters specified as text content</title>
<p>None</p>
</section>
</body>
</document>
Index: constraint.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/constraint.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** constraint.xml 13 Feb 2003 23:45:57 -0000 1.1
--- constraint.xml 17 Feb 2003 06:27:26 -0000 1.2
***************
*** 10,15 ****
</header>
<body>
! <section><title>Description</title>
! <p>Generation a Version 'constraint' from provided constraint information</p>
</section>
<section><title>Parameters</title>
--- 10,16 ----
</header>
<body>
! <section>
! <title>Description</title>
! <p>Generation a Version 'constraint' from provided constraint information</p>
</section>
<section><title>Parameters</title>
***************
*** 20,31 ****
<tr><td><link href="overWrite.html">overWrite</link></td><td><strong>Over-Write</strong> the current file</td><td>No</td><td>false</td></tr>
</table>
! </section>
! <section>
! <title>Parameters specified as nested elements</title>
! <section><title>constraints</title>
<p>The <code>constraints</code> nested element represents a set of version constraints.</p>
! <p>Re-used Nested Elements (like <link href="nested/constraints.html">constraints</link>) have their own documentation.</p></section>
</section>
!
</body>
! </document>
--- 21,36 ----
<tr><td><link href="overWrite.html">overWrite</link></td><td><strong>Over-Write</strong> the current file</td><td>No</td><td>false</td></tr>
</table>
! </section>
! <section>
! <title>Parameters specified as nested elements</title>
! <section><title>constraints</title>
<p>The <code>constraints</code> nested element represents a set of version constraints.</p>
! <p>Re-used Nested Elements (like <link href="nested/constraints.html">constraints</link>) have their own documentation.</p>
! </section>
</section>
! <section>
! <title>Parameters specified as text content</title>
! <p>None</p>
! </section>
</body>
! </document>
\ No newline at end of file
Index: environment.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/environment.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** environment.xml 13 Feb 2003 23:45:58 -0000 1.1
--- environment.xml 17 Feb 2003 06:27:26 -0000 1.2
***************
*** 4,8 ****
<document>
<header>
! <title>Krysalis-Version: 'version-brand' Ant Task</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
--- 4,8 ----
<document>
<header>
! <title>Krysalis-Version: 'version-environment' Ant Task</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
***************
*** 11,15 ****
<body>
<section><title>Description</title>
! <p>Generation a Version 'brand' from a provided version</p>
</section>
<section><title>Parameters</title>
--- 11,15 ----
<body>
<section><title>Description</title>
! <p>Extract/Display a Version 'environment' from runtime versions</p>
</section>
<section><title>Parameters</title>
***************
*** 24,28 ****
<title>Parameters specified as nested elements</title>
<p>None</p>
! </section>
</body>
</document>
--- 24,32 ----
<title>Parameters specified as nested elements</title>
<p>None</p>
! </section>
! <section>
! <title>Parameters specified as text content</title>
! <p>None</p>
! </section>
</body>
</document>
Index: dest.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/dest.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** dest.xml 13 Feb 2003 01:14:20 -0000 1.1
--- dest.xml 17 Feb 2003 06:27:27 -0000 1.2
***************
*** 12,21 ****
<p>dest -- <strong>Dest</strong>ination directory</p>
<p>
! This is a directory reference, and is a relative directory (per ant).
</p>
! <note>
! This directory will be created, if not present, <strong>only</strong> only if it's parent immediate parent already exists.
I.e. "./src" would be created, but "./my/src" would not, unless "./my" already existed.
! </note>
</body>
</document>
--- 12,22 ----
<p>dest -- <strong>Dest</strong>ination directory</p>
<p>
! This is a directory reference, and is a relative directory (per ant's view of relative).
</p>
! <note>Example dest="src/java".</note>
! <warning>
! The destination directory will be created, if not present, <strong>but only</strong> only if it's immediate parent directory already exists.
I.e. "./src" would be created, but "./my/src" would not, unless "./my" already existed.
! </warning>
</body>
</document>
Index: versionId.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/versionId.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** versionId.xml 13 Feb 2003 01:14:20 -0000 1.1
--- versionId.xml 17 Feb 2003 06:27:27 -0000 1.2
***************
*** 12,17 ****
<p>versionId -- <strong>Version Identifier</strong></p>
<p>
! For packages this is the package name, e.g. <code>personal.my.stuff</code> or <code>org.krysalis.version</code>.
</p>
</body>
</document>
--- 12,19 ----
<p>versionId -- <strong>Version Identifier</strong></p>
<p>
! This represents an identifier, typically a package name.
</p>
+ <note>Example dest="personal.my.stuff" or dest="org.krysalis.version".
+ </note>
</body>
</document>
Index: book.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/book.xml,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** book.xml 13 Feb 2003 23:45:58 -0000 1.5
--- book.xml 17 Feb 2003 06:27:27 -0000 1.6
***************
*** 25,28 ****
<menu-item label="version-environment" href="environment.html"/>
</menu>
-
</book>
--- 25,27 ----
Index: cut-n-paste.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/cut-n-paste.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** cut-n-paste.xml 13 Feb 2003 23:45:58 -0000 1.2
--- cut-n-paste.xml 17 Feb 2003 06:27:27 -0000 1.3
***************
*** 10,14 ****
</header>
<body>
! <section><title>Generate a Version into your source tree -- string format</title>
<source>
<taskdef resource="version">
--- 10,15 ----
</header>
<body>
! <section><title>Generate a Version (into your source tree)</title>
! <section><title>String format</title>
<source>
<taskdef resource="version">
***************
*** 21,25 ****
</section>
! <section><title>Generate a Version into your source tree -- compound format</title>
<source>
<taskdef resource="version">
--- 22,26 ----
</section>
! <section><title>Compound format</title>
<source>
<taskdef resource="version">
***************
*** 31,34 ****
</version-brand>
</source>
! </section></body>
</document>
--- 32,52 ----
</version-brand>
</source>
! </section>
! </section>
!
! <section><title>Version Environment</title>
! <section><title>Log an Environment</title>
! <source>
! <taskdef resource="version">
! <version-environment />
! </source>
! </section>
! <section><title>Log an Environment as XML</title>
! <source>
! <taskdef resource="version">
! <version-environment xml="true"/>
! </source>
! </section>
! </section>
! </body>
</document>
Index: troubleshooting.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/troubleshooting.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** troubleshooting.xml 13 Feb 2003 01:14:20 -0000 1.1
--- troubleshooting.xml 17 Feb 2003 06:27:27 -0000 1.2
***************
*** 12,21 ****
<body>
<section>
<title>-verbose</title>
! <p>The ant tasks respect this with ant, and do give more information.</p>
</section>
<section>
<title>Logging</title>
! <p><code>-D org.krysalis.version.logging=true</code> will enable more logging.</p>
</section>
<section>
--- 12,26 ----
<body>
<section>
+ <title>VersionException</title>
+ <p><strong>Krysalis Version</strong> attempt to throw meaningful and descriptive
+ exceptions.</p>
+ </section>
+ <section>
<title>-verbose</title>
! <p>The ant tasks respect this with ant command line parameter, and give appropriate information.</p>
</section>
<section>
<title>Logging</title>
! <p><code>-D org.krysalis.version.logging=true</code> enables <strong>Krysalis Version</strong> logging.</p>
</section>
<section>
Index: brand.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/brand.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** brand.xml 13 Feb 2003 01:14:20 -0000 1.2
--- brand.xml 17 Feb 2003 06:27:27 -0000 1.3
***************
*** 21,30 ****
</table>
</section>
! <section>
! <title>Parameters specified as nested elements</title>
<section><title>version</title>
! <p>The <code>version</code> nested element represents a version. It can be as simple as version="1.2" or as complex as needed.</p>
! <p>Re-used Nested Elements (like <link href="nested/version.html">version</link>) have their own documentation.</p></section>
</section>
</body>
--- 21,34 ----
</table>
</section>
! <section><title>Parameters specified as nested elements</title>
<section><title>version</title>
! <p>The <code>version</code> nested element represents a version. It can be as simple as a version string (e.g. "1.2") or as complex as needed.</p>
! <p>See: <link href="nested/version.html">version</link></p>
! </section>
</section>
+ <section>
+ <title>Parameters specified as text content</title>
+ <p>None</p>
+ </section>
</body>
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
lmpx.com only provides a reader for public news (NNTP) servers. It is not
affiliated with the servers or forums shown here and is not responsible for
the content of articles, which is written by their respective authors.