ndlesiecki    02/01/08 20:59:35

  Modified:    docs/framework/xdocs resources.xml goals.xml
                        contributors.xml coding_conventions.xml
  Log:
  documentation tweaks and updates. nothing major.
  
  Revision  Changes    Path
  1.6       +12 -3     jakarta-cactus/docs/framework/xdocs/resources.xml
  
  Index: resources.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-cactus/docs/framework/xdocs/resources.xml,v
  retrieving revision 1.5
  retrieving revision 1.6
  diff -u -r1.5 -r1.6
  --- resources.xml     2 Dec 2001 12:05:10 -0000       1.5
  +++ resources.xml     9 Jan 2002 04:59:35 -0000       1.6
  @@ -7,6 +7,7 @@
       <title>Resources</title>
       <authors>
         <person name="Vincent Massol" email="[EMAIL PROTECTED]"/>
  +      <person name="Nicholas Lesiecki" email="[EMAIL PROTECTED]"/>
       </authors>
     </header>
   
  @@ -55,14 +56,14 @@
         </table>
   
         <p/>
  -
  +      <anchor id="xp_book"/>
         <table>
           <tr>
             <td>
               Link
             </td>
             <td>
  -            <link 
href="http://www.amazon.com/exec/obidos/ASIN/047120708X/qid=1007292540/sr=8-1/ref=sr_8_3_1/103-5269600-2827061";>
  +            <link href="http://www.amazon.com/exec/obidos/ASIN/047120708X/";>
               Java Tools for Extreme Programming: Mastering Open Source Tools, 
including Ant,
               JUnit, and Cactus</link>
             </td>
  @@ -88,7 +89,15 @@
               Description
             </td>
             <td>
  -            Book from Richard Hightower and Nicholas Lesiecki on open source tools.
  +            Co-authored by 
  +         <link href="contributors.html#nick_bio">
  +         Nicholas Lesiecki
  +         </link> (a Cactus commiter)
  +         and Richard Hightower, this book covers key open source testing and 
integration
  +         tools that work well in agile processes such as XP. The book 
  +         features a Cactus API reference, an in-depth tutorial on Cactus use, 
  +         and an example of applying in-container techniques to a real-world 
  +         application.
             </td>
           </tr>
         </table>
  
  
  
  1.7       +5 -1      jakarta-cactus/docs/framework/xdocs/goals.xml
  
  Index: goals.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-cactus/docs/framework/xdocs/goals.xml,v
  retrieving revision 1.6
  retrieving revision 1.7
  diff -u -r1.6 -r1.7
  --- goals.xml 22 Sep 2001 19:19:54 -0000      1.6
  +++ goals.xml 9 Jan 2002 04:59:35 -0000       1.7
  @@ -51,7 +51,11 @@
             EJBs
           </li>
         </ul>
  -
  +                     <p>
  +        All of these are currently enabled in Cactus 1.2,
  +                             though we'd like to do more work on
  +                             facilitating EJB and Taglib testing.
  +      </p>
       </s1>
   
       <s1 title="Long term goals">
  
  
  
  1.12      +32 -2     jakarta-cactus/docs/framework/xdocs/contributors.xml
  
  Index: contributors.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-cactus/docs/framework/xdocs/contributors.xml,v
  retrieving revision 1.11
  retrieving revision 1.12
  diff -u -r1.11 -r1.12
  --- contributors.xml  14 Nov 2001 21:57:34 -0000      1.11
  +++ contributors.xml  9 Jan 2002 04:59:35 -0000       1.12
  @@ -7,6 +7,7 @@
       <title>Contributors</title>
       <authors>
         <person name="Vincent Massol" email="[EMAIL PROTECTED]"/>
  +                     <person name="Nicholas Lesiecki" 
email="[EMAIL PROTECTED]"/>
       </authors>
      </header>
   
  @@ -52,7 +53,7 @@
             Worsley</link>
           </li>
           <li>
  -          <link href="mailto:[EMAIL PROTECTED]";>Nicholas Lesiecki</link>
  +          <link href="mailto:[EMAIL PROTECTED]";>Nicholas Lesiecki</link>
           </li>
         </ul>
   
  @@ -233,7 +234,36 @@
           several persons have jumped aboard and are already helping shape
           Cactus future. Come and help us ! :)
         </p>
  -
  +                     <anchor id="nick_bio"/>
  +      <p>
  +        <strong>
  +                                     <link 
href="mailto:[EMAIL PROTECTED]";>Nicholas Lesiecki</link>
  +                                     -- Committer
  +                             </strong>
  +      </p>
  +      <p>
  +             I became involved in Cactus while co-authoring 
  +                             <link 
href="http://www.amazon.com/exec/obidos/ASIN/047120708X/";>
  +                                     Java Tools for Extreme Programming.
  +                             </link> (See our <link 
href="resources.html#xp_book">resources</link> 
  +                             section for details.) While researching the framework 
I found myself making some 
  +                             suggestions on the project's mailing list. One thing 
led to another, 
  +                             and now I am graced with commiter status.
  +                     </p>
  +                     <p>
  +                             I currently work as a Technical Team Lead at
  +                             <link href="http://www.eblox.com";>eBlox, Inc</link>, 
  +                             a consulting and ecommerce application development 
shop. Right now I lead
  +                             development of the company's flagship online catalog 
system, 
  +                             <link 
href="http://eblox.com/storeblox.php";>storeBlox</link>. As such, 
  +                             I'm always working on new ways to test J2EE 
components, and so my 
  +                             involvement with Cactus is natural.
  +                     </p>
  +                     <p>
  +                             I'm excited about Cactus 2.0, which we hope will usher 
in the next 
  +                             phase in in-container testing by providing a more 
abstract framework for
  +                             interacting with a wider variety of containers (EJB, 
JMS, etc. ).
  +                     </p>
       </s1>
   
     </body>
  
  
  
  1.5       +10 -51    jakarta-cactus/docs/framework/xdocs/coding_conventions.xml
  
  Index: coding_conventions.xml
  ===================================================================
  RCS file: /home/cvs/jakarta-cactus/docs/framework/xdocs/coding_conventions.xml,v
  retrieving revision 1.4
  retrieving revision 1.5
  diff -u -r1.4 -r1.5
  --- coding_conventions.xml    22 Sep 2001 19:19:54 -0000      1.4
  +++ coding_conventions.xml    9 Jan 2002 04:59:35 -0000       1.5
  @@ -7,6 +7,7 @@
       <title>Coding Conventions</title>
       <authors>
         <person name="Vincent Massol" email="[EMAIL PROTECTED]"/>
  +                     <person name="Nicholas Lesiecki" 
email="[EMAIL PROTECTED]"/>
       </authors>
     </header>
   
  @@ -220,7 +221,7 @@
   
         </s2>
   
  -      <s2 title="10. Versionning">
  +      <s2 title="10. Versioning">
   
           <p>
             All .java files should have a <code>@version</code> tag like the one
  @@ -228,7 +229,7 @@
           </p>
   
   <source><![CDATA[
  -@version $Id: coding_conventions.xml,v 1.4 2001/09/22 19:19:54 vmassol Exp $
  +@version $Id: coding_conventions.xml,v 1.5 2002/01/09 04:59:35 ndlesiecki Exp $
   ]]></source>
   
         </s2>
  @@ -238,66 +239,24 @@
           <p>
             Do <strong>not</strong> use <code>System.out</code> to log. Instead,
             use the Cactus logging classes which are a facade to Log4j. Use the
  -          name of your class as the Log4j <code>Category</code>.For
  +          name of your class as the Log4j <code>Category</code>. For
             example :
           </p>
   
   <source><![CDATA[
   private static Log logger =
  -    LogService.getInstance().getLog(MyClass.class.getName());
  +             LogService.getInstance().getLog(MyClass.class.getName());
   
   public void someMethod()
   {
  -    logger.debug("some debug text");
  +             logger.debug("some debug text");
   }
   ]]></source>
   
  -        <p>
  -          Try as much as possible to log entry and exits of methods with
  -          the parameter values. Cactus logging interface provides 2 methods
  -          for this : <code>logger.entry()</code> and <code>logger.exit()</code>,
  -          used as follows :
  -        </p>
  -
  -<source><![CDATA[
  -public void someMethod(String theClassName)
  -{
  -    logger.entry("someMethod([" + theClassName + "])");
  -[...]
  -    logger.exit("someMethod");
  -}
  -]]></source>
  -
  -        <p>
  -          This will translate in the following log :
  -        </p>
  -
  -<source><![CDATA[
  -3435 [ApplicationServerThread] DEBUG some.package.MyClass - 
>someMethod([SomeClassName])
  -3436 [ApplicationServerThread] DEBUG some.package.MyClass - <someMethod
  -]]></source>
  -
  -        <p>
  -          If there is no value in logging the parameters (for example because
  -          the object passed as parameter do not have a string representation
  -          and you cannot add one), use the following :
  -        </p>
  -
  -<source><![CDATA[
  -public void someMethod(InputStream theInputStream)
  -{
  -    logger.entry("someMethod(...)");
  -[...]
  -    logger.exit("someMethod");
  -}
  -]]></source>
  -
  -        <p>
  -          This is because you could have a method within your class with the
  -          same name but without parameters and we need to differentiate that
  -          in the logs.
  -        </p>
  -
  +        <note>
  +          As of Cactus 1.3, LogAspect autmatically logs all method entries and
  +                                     exits.
  +        </note>
         </s2>
   
         <s2 title="12. Exception handling">
  
  
  

--
To unsubscribe, e-mail:   <mailto:[EMAIL PROTECTED]>
For additional commands, e-mail: <mailto:[EMAIL PROTECTED]>

Reply via email to