Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant
In directory sc8-pr-cvs1:/tmp/cvs-serv8349/src/documentation/content/xdocs/ant
Modified Files:
faq.xml index.xml book.xml cut-n-paste.xml
Added Files:
constraint.xml environment.xml
Log Message:
Docs, docs, and more docs .... but probably still insufficient/immature...
--- NEW FILE: constraint.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-constraint' Ant Task</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<section><title>Description</title>
<p>Generation a Version 'constraint' from provided constraint information</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>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>
--- NEW FILE: environment.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-brand' Ant Task</title>
<authors>
<person id="arb_jack" name="Adam R. B. Jack" email="[email protected]"/>
</authors>
</header>
<body>
<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>full</td><td>Full (all collectors) or <strong>Branded-only</strong> Versions...</td><td>No</td><td>false</td></tr>
<tr><td>xml</td><td>Generate XML output<strong> otherwise simply log</strong> </td><td>No</td><td>false</td></tr>
<tr><td>annotate</td><td>Display the annotated information that gave the result</td><td>No</td><td>false</td></tr>
</table>
</section>
<section>
<title>Parameters specified as nested elements</title>
<p>None</p>
</section>
</body>
</document>
Index: faq.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/faq.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** faq.xml 13 Feb 2003 01:14:20 -0000 1.3
--- faq.xml 13 Feb 2003 23:45:58 -0000 1.4
***************
*** 11,20 ****
<body>
! <warning>:TODO:</warning>
! <section><title>FAQ</title>
! <section><title>How do I define these tasks to ant?</title></section>
! <section><title>How does this differ than a Manifest.mf ...</title></section>
! <section><title>How does this differ from naming the JAR to include the version?</title></section>
</section>
</body>
</document>
--- 11,35 ----
<body>
! <note>Ask and they'll be added...</note>
! <section><title>How do I define these tasks to ant?</title>
! <p>Use:</p>
! <source><taskdef resource="version"></source>
! <p>Basically this looks for a file call 'version' in the classpath, and hopefully finds it in
! the Krysalis-Version JAR. That is a simple text file that defines the various tasks to ant.
! </p>
! </section>
! <section><title>How does this differ from a Manifest.mf?</title>
! <p>Primarily: It builds a framework for programatic version management...</p>
! <p>Automation is the key, have a Version framework to write code on top off. No real reason why the framework can't read manifests to generate version objects (and right now it does).</p>
! </section>
! <section><title>How does this differ from a <code>java.lang.Package</code>?</title>
! <p>Primarily: It builds a framework for programatic version management...</p>
! <p>Automation is the key, have a Version framework to write code on top off. No real reason why the framework can't look at Packages to generate version objects (and right now it does).</p>
</section>
+ <section><title>How does this differ from naming the JAR to include the version?</title>
+ <p>Again, programatic -- but still -- it ought work w/ tools (like Ruper) to generate files names</p>
+ <p>Also, when developing classes aren't always in JARs.</p>
+ <p>Automation is the key, have a Version framework to write code on top off. No real reason why the framework can't read JAR filename formats to generate version objects (but right now it does NOT).</p>
+ </section>
</body>
</document>
Index: index.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/index.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** index.xml 11 Feb 2003 23:45:58 -0000 1.2
--- index.xml 13 Feb 2003 23:45:58 -0000 1.3
***************
*** 12,16 ****
<body>
<section><title>Ant Tasks</title>
! <p>Krysalis-Version <link href="http://ant.apache.org">Ant</link> Tasks are designed to
enable <strong>versioning tasks</strong> with the minimal of developer effort.
Versioning is primarily of interest to users, not developers, so for developers to accomodate a perhaps unknown future operator things need to be <strong>easy, easy, easy.</strong>
--- 12,16 ----
<body>
<section><title>Ant Tasks</title>
! <p>Krysalis-Version <fork href="http://ant.apache.org">Ant</fork> Tasks are designed to
enable <strong>versioning tasks</strong> with the minimal of developer effort.
Versioning is primarily of interest to users, not developers, so for developers to accomodate a perhaps unknown future operator things need to be <strong>easy, easy, easy.</strong>
Index: book.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/book.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** book.xml 12 Feb 2003 20:51:47 -0000 1.4
--- book.xml 13 Feb 2003 23:45:58 -0000 1.5
***************
*** 17,21 ****
<menu label="Management">
<menu-item label="version-brand" href="brand.html"/>
! <menu-item label="version-constraint" href="todo.html"/>
</menu>
--- 17,21 ----
<menu label="Management">
<menu-item label="version-brand" href="brand.html"/>
! <menu-item label="version-constraint" href="constraint.html"/>
</menu>
***************
*** 23,27 ****
<menu-item label="version-available" href="todo.html"/>
<menu-item label="version-constrain" href="todo.html"/>
! <menu-item label="version-environment" href="todo.html"/>
</menu>
--- 23,27 ----
<menu-item label="version-available" href="todo.html"/>
<menu-item label="version-constrain" href="todo.html"/>
! <menu-item label="version-environment" href="environment.html"/>
</menu>
Index: cut-n-paste.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/cut-n-paste.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** cut-n-paste.xml 12 Feb 2003 20:51:47 -0000 1.1
--- cut-n-paste.xml 13 Feb 2003 23:45:58 -0000 1.2
***************
*** 29,32 ****
--- 29,33 ----
overWrite="true">
<version major="1" minor="2"/>
+ </version-brand>
</source>
</section></body>
-------------------------------------------------------
This SF.NET email is sponsored by: FREE SSL Guide from Thawte
are you planning your Web Server Security? Click here to get a FREE
Thawte SSL guide and find the answers to all your SSL security issues.
http://ads.sourceforge.net/cgi-bin/redirect.pl?thaw0026en
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.