cvs commit: xml-axis/java/docs developers-guide.html user-guide.html

[gl...@apache.org]

glyn        02/01/30 02:30:06

  Modified:    java/docs developers-guide.html user-guide.html
  Log:
  Create a place-holder empty list of published Axis interfaces.
  
  Revision  Changes    Path
  1.7       +8 -0      xml-axis/java/docs/developers-guide.html
  
  Index: developers-guide.html
  ===================================================================
  RCS file: /home/cvs/xml-axis/java/docs/developers-guide.html,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- developers-guide.html	18 Jan 2002 20:15:14 -0000	1.6
  +++ developers-guide.html	30 Jan 2002 10:30:05 -0000	1.7
  @@ -54,6 +54,14 @@
   <li>
   Code changes should comply with <a href="http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html">"Code
   Conventions for the Java Programming Language"</a></li>
  +
  +<li>
  +Incompatible changes to
  +<a href="user-guide.html#published interfaces">published Axis interfaces</a>
  +should be avoided where possible.
  +When changes are necessary, for example to maintain or improve the overall
  +modularity of Axis, the
  +impact on users must be considered and, preferably, documented.</li>
   </ul>
   
   <h2>
  
  
  
  1.35      +34 -0     xml-axis/java/docs/user-guide.html
  
  Index: user-guide.html
  ===================================================================
  RCS file: /home/cvs/xml-axis/java/docs/user-guide.html,v
  retrieving revision 1.34
  retrieving revision 1.35
  diff -u -r1.34 -r1.35
  --- user-guide.html	11 Jan 2002 16:57:51 -0000	1.34
  +++ user-guide.html	30 Jan 2002 10:30:05 -0000	1.35
  @@ -62,8 +62,12 @@
   </ul>
   
   <li>
  +<a href="#published interfaces">Published Interfaces</a></li>
  +
  +<li>
   <a href="#tcpmon">Using TCPMon</a></li>
   
  +
   <li>
   <a href="#Glossary">Glossary</a></li>
   </ul>
  @@ -110,6 +114,11 @@
   system management, or anything else you can imagine.</li>
   
   <li>
  +<b>Stability.</b> Axis defines a set of
  +<a href="#published interfaces">published interfaces</a> which change
  +relatively slowly compared to the rest of Axis.</li>
  +
  +<li>
   <b>Component-oriented deployment.</b> You can easily define reusable networks
   of Handlers to implement common patterns of processing for your applications,
   or to distribute to partners.</li>
  @@ -1074,6 +1083,31 @@
   </ul>
   Now you have all of the necessary files to build your client/server side
   code and deploy the web service!
  +<h2>
  +<a name="published interfaces"></a>Published Axis Interfaces</h2>
  +Although you may use any of the interfaces
  +present in Axis, you need to be aware that some are more stable than
  +others since
  +there is a continuing need to refactor Axis to maintain and improve its
  +modularity.
  +<p>Hence certain interfaces are designated as <i>published</i>,
  +which means that they are relatively stable.
  +As Axis is refactored, the Axis developers will try to avoid changing
  +published interfaces unnecessarily and will certainly consider the impact
  +on users of any modifications.
  +<p>
  +So if you stick to using only published interfaces, you'll minimise the pain
  +of migrating between releases of Axis. On the other hand, if you
  +decide to use unpublished interfaces, migrating between releases
  +could be an interesting exercise!
  +If you would like an interface to be published,
  +you should make the case for this on the
  +<a href="mailto:axis-user@xml.apache.org">axis-user</a> mailing list.
  +<p>
  +The current list of published interfaces is as follows:
  +<ul>
  +<li>No interfaces published so far -- everything is subject to change!
  +</ul>
   <h2>
   <a NAME="tcpmon"></a>Using the Axis TCP Monitor (tcpmon)</h2>
   The included "tcpmon" utility can be found in the org.apache.axis.utils