Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant
In directory sc8-pr-cvs1:/tmp/cvs-serv22218/src/documentation/content/xdocs/ant
Modified Files:
overview.xml faq.xml brand.xml
Added Files:
dest.xml troubleshooting.xml versionId.xml overWrite.xml
Log Message:
More docs stuff....
--- NEW FILE: dest.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: 'dest' Ant Task Attribute</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<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>
--- NEW FILE: troubleshooting.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 Ant Tasks - Troubleshooting</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<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>
<title>Contact us</title>
<p>If all else fails contact us via <link href="http://www.krysalis.org">http://www.krysalis.org</link>.</p>
</section>
</body>
</document>
--- NEW FILE: versionId.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: 'versionId' Ant Task Attribute</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<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>
--- NEW FILE: overWrite.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: 'overWrite' Ant Task Attribute</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<p>overWrite -- <strong>over-write</strong> an existing file</p>
<p>
This is a <code>boolean</code> setting with "true" and "false" choices. <strong>Default</strong> is false.
</p>
<warning>
Setting this to be <strong>"true"</strong> could overwrite your file. The Ant Tasks do not recognize if the file that is to be over-writen was actually writen by them.
</warning>
</body>
</document>
Index: overview.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/overview.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** overview.xml 12 Feb 2003 22:45:00 -0000 1.2
--- overview.xml 13 Feb 2003 01:14:20 -0000 1.3
***************
*** 17,24 ****
<section><title>Management Tasks</title>
<p>Management tasks help you manage the versions and constraints you generate within your own developments.
! These are "branded" into the code by means of generating source code into your source directory <strong>(dest)</strong>.
! Creating <strong><code>{your.stuff.package}.version.Version.class</code></strong> so as not to clash with your code,
! (and <strong>overWrite</strong> defaulting to false to be doubly sure).
! You then compile and distribute this class with your JAR.
</p>
<note>This <code>Version.class</code> is not dependent upon <strong>Krysalis Version</strong> or anything but the standard JDK class, with any recent JDK.
--- 17,31 ----
<section><title>Management Tasks</title>
<p>Management tasks help you manage the versions and constraints you generate within your own developments.
! </p>
! <p>
! <code>Versions</code> (<link href="version-brand.html">version-brand</link>) and <code>Constraints</code> (<link href="version-brand.html">version-constraint</link>) are <strong>"branded"</strong> into the code by means of generating source code into your <strong>destination</strong> source directory.
! Creating (so as not to clash with your code) :
! </p>
! <p><strong><code>{your.stuff.package}.version.Version.class</code></strong></p>
! <p>in location:</p>
! <p><strong><code>{dest}/{your.stuff.package}/version/Version.java</code></strong></p>
! <p><strong>overWrite</strong> defaults to false to be doubly sure of no inadvertent clash.</p>
! <p>
! You then compile and distribute this class with your JAR using standard Ant tasks.
</p>
<note>This <code>Version.class</code> is not dependent upon <strong>Krysalis Version</strong> or anything but the standard JDK class, with any recent JDK.
***************
*** 26,33 ****
Branding version information into your package is riskless, and benifit loaden.</note>
</section>
! <section><title>Runtime Tasks</title>
<p>Runtime tasks help you work with the version you depend upon within your own developments.</p>
! <p>Runtime tasks 'introspect' your runtime environment (via classloaders) and locates classes.
! If asked a question for a given package (e.g. <code>"personal.my.stuff"</code>) it looks for <code>personal.my.stuff.version.Version</code> and introspects/loads.</p>
<p>Runtime tasks determine the versions within the environment and allow you to perform actions, i.e. set properties <link href="available.html">(version-available)</link> or fail <link href="constrain.html">(version-constrain)</link></p>
</section>
--- 33,42 ----
Branding version information into your package is riskless, and benifit loaden.</note>
</section>
! <section>
! <title>Runtime Tasks</title>
<p>Runtime tasks help you work with the version you depend upon within your own developments.</p>
! <p>Runtime tasks 'introspects' your runtime environment (via classloaders) and locates classes.</p>
! <p>If asked a question for a version for a given package (e.g. <code>"personal.my.stuff"</code>) it looks for <code>personal.my.stuff.version.Version</code> and introspects/loads.</p>
! <p>More 'brute force' collections occur, loading version information from classpaths and JAR manifest within the path.</p>
<p>Runtime tasks determine the versions within the environment and allow you to perform actions, i.e. set properties <link href="available.html">(version-available)</link> or fail <link href="constrain.html">(version-constrain)</link></p>
</section>
Index: faq.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/faq.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** faq.xml 12 Feb 2003 22:45:00 -0000 1.2
--- faq.xml 13 Feb 2003 01:14:20 -0000 1.3
***************
*** 11,14 ****
--- 11,15 ----
<body>
+ <warning>:TODO:</warning>
<section><title>FAQ</title>
<section><title>How do I define these tasks to ant?</title></section>
Index: brand.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/brand.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** brand.xml 8 Feb 2003 00:32:28 -0000 1.1
--- brand.xml 13 Feb 2003 01:14:20 -0000 1.2
***************
*** 12,26 ****
<section><title>Description</title>
<p>Generation a Version 'brand' from a provided version</p>
! </section>
<section><title>Parameters</title>
<table>
! <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
! <tr><td><link href="dest">dest</link></td><td>Destination <strong>Root</strong> Directory</td><td>Yes</td></tr>
!
</table>
</section>
<section>
<title>Parameters specified as nested elements</title>
! <section><title>version</title><p><link href="nested/version.html">version</link></p></section>
</section>
--- 12,29 ----
<section><title>Description</title>
<p>Generation a Version 'brand' from a provided version</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="dest.html">dest</link></td><td>Destination <strong>Root</strong> Directory</td><td>Yes</td><td>N/A</td></tr>
! <tr><td><link href="versionId.html">versionId</link></td><td>Version Identifier<strong> e.g. <code>personal.my.stuff</code></strong> (typically your package name)</td><td>Yes</td><td>N/A</td></tr>
! <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>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>
-------------------------------------------------------
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.