Update of /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs
In directory sc8-pr-cvs1:/tmp/cvs-serv11553/src/documentation/content/xdocs
Modified Files:
index.xml book.xml versioning.xml
Log Message:
Docs
Index: index.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/index.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** index.xml 16 Feb 2003 14:43:20 -0000 1.3
--- index.xml 17 Feb 2003 06:27:25 -0000 1.4
***************
*** 17,21 ****
enable package versioning (and version introspection) to attempt to reduce, amongst others, <strong>JAR-hell</strong>.
</p>
! <p>Krysalis-version attempt to automate the tasks of:
</p>
<ul>
--- 17,46 ----
enable package versioning (and version introspection) to attempt to reduce, amongst others, <strong>JAR-hell</strong>.
</p>
! <p>Environments
! are populated from the system (boot) classpath, app server classpaths, application classpaths,
! and many more. The hierarchy of class loaders is increasingly complex, as are the environments
! they produce.</p>
! <p>
! Although applications attempt to deploy their own dependencies, the vastly re-used and
! lower level packages (XML parsers and such) are often shared. Software components, inside
! applications, get whatever the application packager decided upon, combined with the
! deployment environment. Furthermore, operators deply (more than likely unintentionally)
! into environments unexpected by developers.
! </p>
! <p>In short,
! software runs in the environment it finds itself in, which is frequently not
! the same as that which it was developed or tested against. Such environments constitute
! vast unknowns, and such deployements/environments are <strong>inherently untested</strong>.
! This is no way to manage small or large software environments.
! </p>
! <p><strong>JAR-hell</strong> occurs when software is deployed into a runtime environment that
! is unsuitable, but nothing other than full integration testing would detect this. Ensuring
! the compatibility of a variety of dependent packages is duanting, doing it amongst the
! variety supported by a hierarchy of complex class loaders, is <strong>inhuman</strong>.
! </p>
! <p>Manual environment debugging is not something a human ought be forced to waste time
! upon. With that thought <strong>Krysalis-Version was born</strong>...
! </p>
! <p><strong>Krysalis-version</strong> attempts to automate the tasks of:
</p>
<ul>
***************
*** 23,26 ****
--- 48,54 ----
<li>Knowing what <strong>runtime version</strong> of a package exists in a runtime environment.</li>
<li>Determining any <strong>version constraints</strong> that exists on packages, as determined by the author, site operator, or other.</li>
+ <li>Evaluating constraints against the runtime environment, automatically detecting
+ previously 'documented' incompatibilities. (A developer or tester can communicate
+ known compatibilities and incompatibilities with the software.)</li>
</ul>
<p>As such it implements the following components (cents, ant tasks, tools and plug-ins) on top of it's own API:</p>
Index: book.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/book.xml,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** book.xml 16 Feb 2003 14:43:20 -0000 1.4
--- book.xml 17 Feb 2003 06:27:25 -0000 1.5
***************
*** 12,32 ****
<menu label="Docs">
! <menu-item label="Introduction" href="index.html"/>
! <menu-item label="Versioning" href="versioning.html"/>
! <menu-item label=":TODO:" href="todo.html"/>
! <menu-item label="Ant Tasks" href="ant/index.html"/>
! <menu-item label="Eclipse Plug-in" href="eclipse/index.html"/>
</menu>
<menu label="FAQs">
! <menu-item label="Introduction" href="faq/index.html"/>
</menu>
<menu label="Code">
! <menu-item label="Javadocs" href="javadocs/index.html"/>
! <menu-item label="Java Source Ref" href="javasrc/index.html"/>
! <menu-item label="Code Style Checks" href="checkstyle/index.html"/>
! <menu-item label="Unit tests" href="junit/index.html"/>
</menu>
-
</book>
--- 12,32 ----
<menu label="Docs">
! <menu-item label="Introduction" href="index.html"/>
! <menu-item label="Versioning" href="versioning.html"/>
! <menu-item label="To-Do" href="todo.html"/>
! <menu-item label="Ant Tasks" href="ant/index.html"/>
! <menu-item label="Eclipse Plug-in" href="eclipse/index.html"/>
</menu>
<menu label="FAQs">
! <menu-item label="Introduction" href="faq/index.html"/>
! <menu-item label="Ant FAQs" href="ant/faq.html"/>
</menu>
<menu label="Code">
! <menu-item label="Javadocs" href="javadocs/index.html"/>
! <menu-item label="Java Source Ref" href="javasrc/index.html"/>
! <menu-item label="Code Style Checks" href="checkstyle/index.html"/>
! <menu-item label="Unit tests" href="junit/index.html"/>
</menu>
</book>
Index: versioning.xml
===================================================================
RCS file: /cvsroot/metamorphosis/krysalis-version/src/documentation/content/xdocs/versioning.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** versioning.xml 16 Feb 2003 14:43:20 -0000 1.1
--- versioning.xml 17 Feb 2003 06:27:25 -0000 1.2
***************
*** 12,28 ****
<body>
<section><title>Versonion Approaches</title>
! <p>Krysalis-version supports a variety of versioning approaches, from the manual to the fully automated:
</p>
<ul>
! <li>JAR <fork href="http://java.sun.com/j2se/1.4.1/docs/api/java/util/jar/Manifest.html">http://java.sun.com/j2se/1.4.1/docs/api/java/util/jar/Manifest.html</fork> information.</li>
<li>Branding the <strong>version</strong> of a package into the package (as a class).</li>
</ul>
</section>
! <section><title>Management Approaches</title>
! <p>Krysalis-version supports a variety of versioning management approaches, from the manual to the fully automated:
</p>
<ul>
! <li>Manual management (one edits the Manifest or hand produces a class).</li>
! <li>Ant management (ant tasks do the mundane work).</li>
</ul>
</section>
--- 12,32 ----
<body>
<section><title>Versonion Approaches</title>
! <p><strong>Krysalis-version</strong> supports different versioning approaches, from the manual to the fully automated. Manual versioning is available to all, with no requirements -- simply enter
! a correctly formatted version into a manifest, or code. Automated versioning is available to folk who
! invest in learning tools, such as Ant.
</p>
<ul>
! <li>JAR <fork href="http://java.sun.com/j2se/1.4.1/docs/api/java/util/jar/Manifest.html">Manifest</fork> information.</li>
! <li>Integration via the <link href="standard/index.html">Dynamic Version Interface</link>.</li>
<li>Branding the <strong>version</strong> of a package into the package (as a class).</li>
</ul>
</section>
! <section><title>Version Management Approaches</title>
! <p><strong>Krysalis-version</strong> supports a variety of versioning management approaches, from the manual to the fully automated:
</p>
<ul>
! <li>Manual management - one edits/increments the Manifest or hand produces a Version class).</li>
! <li>Ant management - Ant tasks do the mundane work.</li>
! <li>Eclipse management - Eclipse plugins do the mundane work.</li>
</ul>
</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.