utils/jalopy/docs/faq.html

   1
   2 <!--
   3  * Jalview - A Sequence Alignment Editor and Viewer (Version 2.5)
   4  * Copyright (C) 2011 J Procter, AM Waterhouse, J Engelhardt, LM Lui, G Barton, M Clamp, S Searle
   5  *
   6  * This file is part of Jalview.
   7  *
   8  * Jalview is free software: you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  18 -->
  19     <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  20   <html><head>
  21       <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
  22    <title>Jalopy - FAQ</title><link rel="stylesheet" href="site.css" type="text/css"><meta name="generator" content="DocBook XSL Stylesheets V1.65.1"><meta name="keywords" content="Java, convention, source, code, formatter, beautifier, pretty, printer, format, beautify, layout, coding, open, style, standard, transform, parser, Sun, ANTLR, Ant, Eclipse, JBuilder, NetBeans, jEdit, jakarta, JDeveloper, generator, generation, JDE, maven">
  23       <meta name="description" content="Jalopy Java Source Code Formatter Beautifier Pretty Printer">
  24       <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" l gen true for "http://jalopy.sf.net" r (cz 1 lz 1 nz 1 oz 1 vz 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://jalopy.sf.net" r (n 0 s 0 v 0 l 0))'>
  25     </head><body id="toppage" bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table width="700" border="0" cellpadding="0" cellspacing="0" align="center"><tbody><tr><td><table cellpadding="0" cellspacing="0" width="100%" style="border:1px solid #336699"><tbody><tr><td height="16"></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr style="border:none"><td style="border:none"><table border="0" cellspacing="0" cellpadding="0"><tbody><tr><td class="logo">JALOPY</td><td class="sublogo" valign="bottom">Java Source Code Formatter Beautifier Pretty Printer</td></tr></tbody></table></td></tr><tr><td bgcolor="#3399cc" height="1"></td></tr><tr><td height="10"></td></tr><tr><td bgcolor="#ff8000" height="4"></td></tr><tr><td height="20" bgcolor="#336699" style="color:#ffffff;padding-left:10px"><a href="./index.html" class="navlink">Overview</a> &#149;
  26                     <a href="./download.html" class="navlink">Download</a> &#149;
  27                     <a href="./docs.html" class="navlink">Documentation</a> &#149;
  28                     <a href="./plugins.html" class="navlink">Plug-ins</a> &#149;
  29                     <a href="./links.html" class="navlink">Links</a> &#149;
  30                     <a href="./contact.html" class="navlink">Contact</a></td></tr><tr><td height="1" bgcolor="#ffffff"></td></tr></tbody></table><table cellpadding="0" cellspacing="0" width="100%"><tbody><tr><td height="20" bgcolor="#faebd7" style="padding-left:15px"><a href="./features.html" class="navlink2">Features</a> |
  31                         <a href="./history.html" class="navlink2">History</a> |
  32                         <a href="./manual.html" class="navlink2">Manual</a> |
  33                         <a href="./faq.html" class="navlink2">FAQ</a> |
  34                         <a href="./api/index.html" class="navlink2">Javadoc</a></td></tr></tbody></table></td></tr><tr><td height="20" bgcolor="#ffffff"></td></tr><tr><td bgcolor="#eeeecc" height="17" align="right" style="font-size:10px;padding-right:3px">
  35             This page generated: <strong>June 8 2004</strong></td></tr><tr valign="top"><td valign="top" bgcolor="#ffffff"><table border="0" width="100%" cellspacing="0" cellpadding="5"><tbody><tr><td><div class="article" lang="en"><div class="simplesect" lang="en"><div class="titlepage"><div></div><div></div></div><div class="qandaset"><table border="0" summary="Q and A Set"><col align="left" width="1%"><tbody><tr class="question"><td align="left" valign="top"><a name="d21e76"></a><a name="report-bugs"></a><b>Q:</b></td><td align="left" valign="top"><p>
  36 How do I report a bug I have found in Jalopy?
  37 </p></td></tr><tr class="answer"><td align="left" valign="top"><b>A:</b></td><td align="left" valign="top"><p>
  38 To be as helpful as possible to the Jalopy developer team and other users, you should use
  39 the <a href="http://sf.net/tracker/?group_id=45216&amp;atid=442212" target="_top">
  40 bug tracker database</a> that the Jalopy project maintains on the
  41 <a href="http://sf.net/" target="_top">SourceForge web site</a>. You do need to be a SourceForge
  42 member to post a bug report.
  43 </p><p>
  44 Before posting a bug report, spend a few moments searching the bug database to see if a
  45 similar report has already been made. The bug tracker has a search facility that will let
  46 you search for bug reports using a variety of criteria. If you find a similar bug report,
  47 and you have additional information to contribute, post a comment to the report. Only if
  48 you do not find a similar bug report, submit a new one.
  49 </p></td></tr><tr class="question"><td align="left" valign="top"><a name="d21e91"></a><a name="bug-report"></a><b>Q:</b></td><td align="left" valign="top"><p>
  50 What information should I include in a bug report?
  51 </p></td></tr><tr class="answer"><td align="left" valign="top"><b>A:</b></td><td align="left" valign="top"><p>
  52 The web form in the bug tracker report provides several fields for
  53 submitting information. If you are unsure about a particular
  54 item, leave it at the default setting provided in the form.
  55 </p><p>
  56 The more important fields are &#8220;<span class="quote">Category</span>&#8221;,
  57 &#8220;<span class="quote">Summary</span>&#8221; and the &#8220;<span class="quote">Initial comment</span>&#8221;.
  58 </p><p>
  59 When you write your initial comment describing the bug, you
  60 should specify the versions of Jalopy, the Plug-in environment, the Java platform and
  61 operating system you are using.
  62 </p><p>
  63 Be as specific as possible. If you encounter stack traces, attach them. If you have
  64 problems formatting a specific file, locate the cause of the error and attach
  65 the code section as a text file. Also attach your code convention as many errors only
  66 occur with a certain settings combination.
  67 </p><p>
  68 A more typical example should look like:
  69 </p><div class="informalexample"><a name="ex-bug-report"></a><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="programlisting">
  70 I newly installed jalopy-1.0b9 on Windows NT with German locales, Sun JDK 1.3.1_05.
  71 I upgraded property file from jalopy-1.0b7 via Import/Export.
  72
  73 When starting the jalopy settings dialog, I always have problems
  74 when I am on the "Sorting" panel. No entries are shown. Maybe
  75 this is a similar problem.
  76
  77 I tried with different files. Always the same result.
  78
  79 Using the Ant task (0.3.3 with Ant 1.4.1), I get a stack trace as attached. I attached
  80 my code convention also.
  81 </pre></td></tr></table></div><p>
  82 The attached stack trace could read as follows:
  83 </p><div class="informalexample"><table border="0" bgcolor="#E0E0E0" class="shade"><tr><td><pre class="programlisting">
  84 [jalopy] Jalopy Java Source Code Formatter 1.0b9
  85 [jalopy] Format 1 source file
  86 [jalopy] X:\beans\booking\BookingService.java:0:0:
  87 Parse
  88 [jalopy] X:\beans\booking\BookingService.java:0:0:parsing took 170
  89 [jalopy] X:\beans\booking\BookingService.java:0:0:transform
  90 [jalopy] X:\beans\booking\BookingService.java:0:0:
  91 java.lang.NullPointerException
  92 [jalopy] java.lang.NullPointerException
  93 at de.hunsicker.jalopy.lang.Transformation.addSiblings(Transformation.java:167)
  94 at de.hunsicker.jalopy.lang.Transformation.sortDeclarations(Transformation.java:534)
  95 at de.hunsicker.jalopy.lang.Transformation.sort(Transformation.java:104)
  96 at de.hunsicker.jalopy.lang.Transformation.apply(Transformation.java:64)
  97 at de.hunsicker.jalopy.lang.JavaRecognizer.transform(JavaRecognizer.java:451)
  98 at de.hunsicker.jalopy.lang.JavaRecognizer.getParseTree(Java Recognizer.java:173)
  99 </pre></td></tr></table></div><p>
 100 The given information made it quite obvious that the auto-conversion of the code
 101 convention format from 1.0b7 to 1.0b9 failed for some reason.
 102 </p><p>
 103 Looking further at the supplied code convention revealed that the value of the sorting
 104 key was invalid and the actual cause was easy to spot.
 105 </p></td></tr></tbody></table></div></div></div></td></tr><tr><td height="20"></td></tr></tbody></table></td></tr><tr><td bgcolor="#eeeecc" height="17" style="font-size:9px;padding-left:5px"><a href="#toppage">to top</a></td></tr><tr><td height="30"><br></td></tr><tr><td height="3"></td></tr><tr><td bgcolor="#336699" height="1"></td></tr><tr><td height="1"></td></tr><tr><td bgcolor="#336699" height="16"></td></tr><tr><td bgcolor="#ff9966" height="4"></td></tr><tr><td class="footer" align="center" height="15" valign="middle">
 106             Copyright &copy; 2001-2002, <a class="footer" href="./contact.html">Marco Hunsicker</a>. All rights reserved. Hosted by <a href="http://sourceforge.net">SourceForge.net</a></td></tr></tbody></table><img src="http://sourceforge.net/sflogo.php?group_id=45216&amp;type=1" width="1" height="1" border="0" hspace="0" vspace="0" alt=""></body></html>