Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant
In directory sc8-pr-cvs1:/tmp/cvs-serv18959/src/documentation/content/xdocs/ant
Modified Files:
quickstart.xml faq.xml overWrite.xml troubleshooting.xml
cut-n-paste.xml
Log Message:
Docs & also Constraints
Index: quickstart.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/quickstart.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** quickstart.xml 12 Feb 2003 20:51:47 -0000 1.1
--- quickstart.xml 17 Feb 2003 18:54:54 -0000 1.2
***************
*** 20,33 ****
</section>
<section>
! <title>1 -- <taskdef resource="version"></title>
<p>Entering this into your ant script (prior to calling any of the version tasks) to register them with Ant.</p>
<p><strong><taskdef resource="version"></strong></p>
</section>
<section>
! <title>2 -- enter the task</title>
! <p>Call the appropriate task</p>
! <p><strong><version-brand dest="${project.src}" versionId="personal.my.stuff" version="1.2"></strong></p>
</section>
! <section><title>3 -- run ant...</title>
</section>
</body>
--- 20,36 ----
</section>
<section>
! <title>Register the tasks</title>
<p>Entering this into your ant script (prior to calling any of the version tasks) to register them with Ant.</p>
<p><strong><taskdef resource="version"></strong></p>
</section>
<section>
! <title>Call the tasks</title>
! <p>Call the appropriate task or tasks</p>
! <p><strong><version-brand dest="${project.src}" versionId="personal.my.stuff" version="1.2"></strong></p>
! <note>See <link href="cut-n-paste.html">cut-n-paste section</link> for examples.</note>
</section>
! <section><title>Run...</title>
! <p>Run ant. The tasks will report their activity, and attempt to throw meaningful exceptions is you
! have invalid or insufficient parameters.</p>
</section>
</body>
Index: faq.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/faq.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** faq.xml 13 Feb 2003 23:45:58 -0000 1.4
--- faq.xml 17 Feb 2003 18:54:54 -0000 1.5
***************
*** 18,35 ****
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>
--- 18,30 ----
the Krysalis-Version JAR. That is a simple text file that defines the various tasks to ant.
</p>
! <note>Krysalis-Version must be in your classpath, and available to be loaded.</note>
! </section>
! <section><title>These ant tasks have so many parameters, how do I know what I need?</title>
! <p>Although the tasks do have a lot of flexibility they are intended primarily for simple usage (with just a few parameters) and
! allow you to tweak things. Try what makes common sense and let the task tell you if it needs
! more. If you feel something is non-intuitative let us know, we'll look into it.</p>
! <note>See <link href="cut-n-paste.html">cut-n-paste section</link> for examples.</note>
! </section>
!
</body>
</document>
Index: overWrite.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/overWrite.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** overWrite.xml 13 Feb 2003 01:14:20 -0000 1.1
--- overWrite.xml 17 Feb 2003 18:54:54 -0000 1.2
***************
*** 15,19 ****
</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>
--- 15,20 ----
</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,
! or is a user edited file. Any file will be replaced.
</warning>
</body>
Index: troubleshooting.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/troubleshooting.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** troubleshooting.xml 17 Feb 2003 06:27:27 -0000 1.2
--- troubleshooting.xml 17 Feb 2003 18:54:54 -0000 1.3
***************
*** 13,18 ****
<section>
<title>VersionException</title>
! <p><strong>Krysalis Version</strong> attempt to throw meaningful and descriptive
! exceptions.</p>
</section>
<section>
--- 13,18 ----
<section>
<title>VersionException</title>
! <p><strong>Krysalis Version</strong> attempts to throw meaningful and descriptive
! exceptions. If on JDK1.4 or above look at the 'cause' behind the ant BuildException.</p>
</section>
<section>
Index: cut-n-paste.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/ant/cut-n-paste.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** cut-n-paste.xml 17 Feb 2003 06:27:27 -0000 1.3
--- cut-n-paste.xml 17 Feb 2003 18:54:54 -0000 1.4
***************
*** 11,15 ****
<body>
<section><title>Generate a Version (into your source tree)</title>
! <section><title>String format</title>
<source>
<taskdef resource="version">
--- 11,15 ----
<body>
<section><title>Generate a Version (into your source tree)</title>
! <section><title>Formatted Version</title>
<source>
<taskdef resource="version">
***************
*** 22,26 ****
</section>
! <section><title>Compound format</title>
<source>
<taskdef resource="version">
--- 22,26 ----
</section>
! <section><title>Compound Version</title>
<source>
<taskdef resource="version">
***************
*** 38,42 ****
<section><title>Log an Environment</title>
<source>
! <taskdef resource="version">
<version-environment />
</source>
--- 38,42 ----
<section><title>Log an Environment</title>
<source>
! <taskdef resource="version">
<version-environment />
</source>
-------------------------------------------------------
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.