You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-commits@db.apache.org by jt...@apache.org on 2004/11/09 23:18:44 UTC
svn commit: rev 57106 - in incubator/derby/site/trunk: build/site build/site/binaries build/site/papers src/documentation/content/binaries src/documentation/content/xdocs src/documentation/content/xdocs/papers
Author: jta
Date: Tue Nov 9 14:18:43 2004
New Revision: 57106
Added:
incubator/derby/site/trunk/build/site/DerbyBugGuidelines.html
incubator/derby/site/trunk/build/site/binaries/FilingDerbyIssuesInJira.doc (contents, props changed)
incubator/derby/site/trunk/src/documentation/content/binaries/FilingDerbyIssuesInJira.doc (contents, props changed)
incubator/derby/site/trunk/src/documentation/content/xdocs/DerbyBugGuidelines.ihtml
Modified:
incubator/derby/site/trunk/build/site/derby_comm.html
incubator/derby/site/trunk/build/site/faq.html
incubator/derby/site/trunk/build/site/papers/misc.html
incubator/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml
incubator/derby/site/trunk/src/documentation/content/xdocs/faq.xml
incubator/derby/site/trunk/src/documentation/content/xdocs/papers/misc.xml
incubator/derby/site/trunk/src/documentation/content/xdocs/site.xml
Log:
Added DerbyBugGuidelines.xml and binaries/FilingDerbyIssuesInJira.doc, changed
links in various pages to point to DerbyBugGuidelines.html (site.xml, faq.xml,
derby_comm.xml)
Added more integration stuff to the miscellaneous page.
Added: incubator/derby/site/trunk/build/site/DerbyBugGuidelines.html
==============================================================================
--- (empty file)
+++ incubator/derby/site/trunk/build/site/DerbyBugGuidelines.html Tue Nov 9 14:18:43 2004
@@ -0,0 +1,337 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>Tips For Filing Apache Derby Bugs</title>
+<link type="text/css" href="skin/page.css" rel="stylesheet">
+</head>
+<body text="#000000" bgcolor="#FFFFFF">
+<!--================= start Navigation Path ==================-->
+<table summary="navigation path" width="100%" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td nowrap="nowrap" valign="middle" bgcolor="#CFDCED" height="20"><img height="1" width="5" alt="" src="skin/images/spacer.gif" class="spacer"><!--===== breadcrumb trail (javascript-generated) ====--><font size="2" face="Arial, Helvetica, Sans-serif"><script src="skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script></font></td>
+</tr>
+<tr>
+<td bgcolor="#4C6C8F" height="2"><img height="2" width="2" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+</table>
+<!--================= end Navigation Path ==================-->
+<!--================= start Banner ==================-->
+<table summary="header with logos" width="100%" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<!--================= start Group Logo ==================-->
+<td bgcolor="#294563"><a href="http://incubator.apache.org"><img border="0" class="logoImage" alt="" src="resources/images/apache-incubator.png" title="Derby is a zero admin java based embedded database."></a></td>
+<!--================= end Group Logo ==================-->
+<!--================= start Project Logo ==================--><td width="100%" align="center" bgcolor="#294563"><a href="http://incubator.apache.org/derby/"><img border="0" class="logoImage" alt="Derby" src="images/derby-logo.jpg" title="Derby is a zero admin java based embedded database."></a></td>
+<!--================= end Project Logo ==================-->
+<!--================= start Search ==================--><td valign="top" rowspan="2" bgcolor="#294563">
+<form target="_blank" action="http://www.google.com/search" method="get">
+<table summary="search" border="0" cellspacing="0" cellpadding="0" bgcolor="#4C6C8F">
+<tr>
+<td colspan="3"><img height="10" width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td><img height="1" width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap"><input value="incubator.apache.org" name="sitesearch" type="hidden"><input size="15" name="q" id="query" type="text"><img height="1" width="5" alt="" src="skin/images/spacer.gif" class="spacer"><input name="Search" value="Search" type="submit">
+<br>
+<font face="Arial, Helvetica, Sans-serif" size="2" color="white">
+ the Derby site
+
+
+ </font></td><td><img height="1" width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td><img alt="" border="0" height="10" width="9" src="skin/images/search-left.gif"></td><td><img height="1" width="1" alt="" src="skin/images/spacer.gif" class="spacer"></td><td><img alt="" border="0" height="10" width="9" src="skin/images/search-right.gif"></td>
+</tr>
+</table>
+</form>
+</td>
+<!--================= start Search ==================--><td bgcolor="#294563"><img height="10" width="10" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td valign="bottom" bgcolor="#294563" colspan="2">
+<!--================= start Tabs ==================-->
+<div class="tab">
+<table summary="tab bar" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td width="6"><img alt="" height="8" width="6" src="skin/images/spacer.gif"></td><td valign="bottom">
+<table summary="selected tab" style="height: 1.8em" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="skin/images/tabSel-left.gif"></td><td valign="middle" bgcolor="#4C6C8F"><font color="#ffffff" size="2" face="Arial, Helvetica, Sans-serif"><b><a class="base-selected" href="index.html">Home</a></b></font></td><td valign="top" width="5" bgcolor="#4C6C8F"><img height="5" width="5" alt="" src="skin/images/tabSel-right.gif"></td>
+</tr>
+</table>
+</td><td width="6"><img alt="" height="8" width="6" src="skin/images/spacer.gif"></td><td valign="bottom">
+<table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a class="base-not-selected" href="manuals/index.html">Manuals</a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="skin/images/tab-right.gif"></td>
+</tr>
+<tr>
+<td colspan="3" height="1"></td>
+</tr>
+</table>
+</td><td width="6"><img alt="" height="8" width="6" src="skin/images/spacer.gif"></td><td valign="bottom">
+<table summary="non selected tab" style="height: 1.6em" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="skin/images/tab-left.gif"></td><td valign="middle" bgcolor="#B2C4E0"><a class="base-not-selected" href="papers/index.html">Papers</a></td><td valign="top" width="5" bgcolor="#B2C4E0"><img height="5" width="5" alt="" src="skin/images/tab-right.gif"></td>
+</tr>
+<tr>
+<td colspan="3" height="1"></td>
+</tr>
+</table>
+</td>
+</tr>
+</table>
+</div>
+<!--================= end Tabs ==================-->
+</td><td bgcolor="#294563"><img alt="" width="1" height="1" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td bgcolor="#4C6C8F" colspan="4"><img width="1" height="10" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+</table>
+<!--================= end Banner ==================-->
+<!--================= start Menu, NavBar, Content ==================-->
+<table summary="page content" bgcolor="#ffffff" width="100%" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td valign="top">
+<table summary="menu" border="0" cellspacing="0" cellpadding="0">
+<tr>
+<!--================= start left top NavBar ==================-->
+<td rowspan="3" valign="top">
+<table summary="blue line" border="0" cellpadding="0" cellspacing="0">
+<tr>
+<td bgcolor="#294563"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td bgcolor="#CFDCED"><font color="#4C6C8F" size="4" face="Arial, Helvetica, Sans-serif"> </font></td>
+</tr>
+<tr>
+<td bgcolor="#294563"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+</table>
+</td>
+<!--================= end left top NavBar ==================--><td bgcolor="#294563"><img width="1" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="skin/images/spacer.gif" class="spacer"></td><td nowrap="nowrap" valign="top" bgcolor="#4C6C8F">
+<!--================= start Menu items ==================-->
+<div class="menu">
+<ul>
+<li>
+<font color="#CFDCED">Derby</font>
+<ul>
+
+<li>
+<a href="index.html">Welcome</a>
+</li>
+
+<li>
+<a href="license.html">License</a>
+</li>
+
+<li>
+<a href="derby_proposal.html">Proposal</a>
+</li>
+
+<li>
+<a href="faq.html">FAQs</a>
+</li>
+
+<li>
+<a href="derby_downloads.html">Downloads</a>
+</li>
+
+
+</ul>
+</li>
+<li>
+<font color="#CFDCED">Community</font>
+<ul>
+
+<li>
+<a href="ApacheConUS04.html">ApacheCon US 2004</a>
+</li>
+
+<li>
+<a href="derby_comm.html">Get Involved!</a>
+</li>
+
+<li>
+<a href="derby_mail.html">Mailing Lists</a>
+</li>
+
+<li>
+<span class="sel"><font color="#ffcc00">BUGS</font></span>
+</li>
+
+<li>
+<a href="DerbyToDo.html">To-Do</a>
+</li>
+
+<li>
+<a href="papers/">Integration Topics</a>
+</li>
+
+</ul>
+</li>
+</ul>
+</div>
+<!--================= end Menu items ==================-->
+</td><td valign="bottom" bgcolor="#4C6C8F"><img width="10" height="10" alt="" src="skin/images/spacer.gif" class="spacer"></td><td bgcolor="#294563"><img width="1" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td valign="bottom" align="left" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="skin/images/menu-left.gif"></td><td bgcolor="#4C6C8F"><img height="10" width="10" alt="" src="skin/images/spacer.gif" class="spacer"></td><td valign="bottom" align="right" colspan="2" rowspan="2" bgcolor="#4C6C8F"><img height="10" width="10" border="0" alt="" src="skin/images/menu-right.gif"></td>
+</tr>
+<tr>
+<td height="1" bgcolor="#294563"><img width="1" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+</table>
+</td><td valign="top" width="100%">
+<table summary="content" width="100%" border="0" cellpadding="0" cellspacing="0">
+<!--================= start middle NavBar ==================-->
+<tr>
+<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td align="left" width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td><td align="left" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
+
+
+ </font><img width="10" height="8" alt="" src="skin/images/spacer.gif" class="spacer"></td><td align="right" width="50%" bgcolor="#CFDCED"><font color="#4C6C8F" size="3" face="Arial, Helvetica, Sans-serif">
+
+
+ </font><img width="10" height="8" alt="" src="skin/images/spacer.gif" class="spacer"></td><td width="10" bgcolor="#CFDCED"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<tr>
+<td colspan="4" bgcolor="#294563"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<!--================= end middle NavBar ==================-->
+<!--================= start Content==================-->
+<tr>
+<td align="left" width="10"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td><td colspan="2" align="left" width="100%">
+<div class="content">
+<table class="title" summary="">
+<tr>
+<td valign="middle">
+<h1>Tips For Filing Apache Derby Bugs</h1>
+</td>
+</tr>
+</table>
+<ul class="minitoc">
+<li>
+<a href="#Introduction">Introduction</a>
+</li>
+<li>
+<a href="#Login+to+Jira%2FRequest+a+Jira+userid">Login to Jira/Request a Jira userid</a>
+</li>
+<li>
+<a href="#Search+Jira+for+an+existing+bug+report">Search Jira for an existing bug report</a>
+</li>
+<li>
+<a href="#Post+your+bug+to+the+mailing+lists">Post your bug to the mailing lists</a>
+</li>
+<li>
+<a href="#File+your+bug">File your bug</a>
+</li>
+<li>
+<a href="#%22Close%22+your+bug+once+it+is+%22Resolved%22">"Close" your bug once it is "Resolved"</a>
+</li>
+<li>
+<a href="#For+more+information">For more information</a>
+</li>
+</ul>
+<a name="N10035"></a><a name="Introduction"></a>
+<h3>Introduction</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>This document is suggested reading for anyone who wants to enter a bug against Derby. It explains how to go about filing a bug and what information you should provide to make the bug entry useful to a developer attempting to fix it. For information on filing other issues in Jira (enhancements, improvements etc.) and for a detailed description of some of the less understood concepts and data fields in Jira, please read the document titled <a href="binaries/FilingDerbyIssuesInJira.doc">Filing Apache Derby Issues in Jira</a>.</p>
+<p>Derby issues are maintained at <a href="http://issues.apache.org/jira/browse/DERBY">http://issues.apache.org/jira/browse/DERBY</a>. Suggested actions to take before/while filing a bug are listed in the sections below.</p>
+</div>
+<a name="N10045"></a><a name="Login+to+Jira%2FRequest+a+Jira+userid"></a>
+<h3>Login to Jira/Request a Jira userid</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>You may access Jira at</p>
+<p>
+<a href="http://issues.apache.org/jira">http://issues.apache.org/jira</a>
+</p>
+<p>If you do not have a userid, create one. A "Signup" link has been provided on the login page. There are 2 levels of access to Derby issues in Jira, "user" access and "developer" access. A "user" may open a bug but will not be able to edit/update/assign it. This requires "developer" privileges. If you think you will need to edit/update a bug entry, please send an email to <a href="mailto:derby-dev@db.apache.org">derby-dev@db.apache.org</a> requesting that you be added in to the "derby-developers" group in Jira.</p>
+</div>
+<a name="N10055"></a><a name="Search+Jira+for+an+existing+bug+report"></a>
+<h3>Search Jira for an existing bug report</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>Before filing a new bug, it is recommended that you first search Jira to verify that it has not yet been reported. Jira offers various fields (and combinations thereof) that you can search on. You will probably benefit the most by searching on keywords that are relevant to the bug you are intending to report. For more details on how to search, see the document titled <a href="binaries/FilingDerbyIssuesInJira.doc">Filing Apache Derby Issues in Jira</a>.</p>
+</div>
+<a name="N1005F"></a><a name="Post+your+bug+to+the+mailing+lists"></a>
+<h3>Post your bug to the mailing lists</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>If the bug you are intending to report is not already logged in Jira, it may be a good idea to post a query to the <a href="mailto:derby-user@db.apache.org">derby-user@db.apache.org</a> mail list asking the following:</p>
+<p>- is your bug really a bug (or a restriction, feature request etc)</p>
+<p>- has anyone else noticed this bug and if so, under what circumstances</p>
+<p>- can anyone suggest a workaround for the problem</p>
+<p>- if relevant, why you think the bug is a "blocker" (highest priority)</p>
+<p>Note: Posting to the mail lists should not be seen as an alternative to filing the bug in Jira. This step may be viewed as optional, however you should at least search Jira for an existing bug report.</p>
+</div>
+<a name="N10073"></a><a name="File+your+bug"></a>
+<h3>File your bug</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>When you post a new bug to the mail lists, please pay attention to the following details that make it a "useful" post. These simple guidelines help avoid poorly filed/described bugs:</p>
+<p>- Attach the output of "sysinfo" to your bug description. This contains important version, CLASSPATH, build, JRE and platform information that will be useful to a developer trying to reproduce and resolve the bug. Please run the following command in the exact same environment your Derby application ran under when the bug was detected</p>
+<p>'java org.apache.derby.tools.sysinfo'</p>
+<p>When you set your application environment manually, make sure you do the very same setup before running sysinfo. On the other hand, when the application sets up the environment, you need to run sysinfo under the application environment to ensure that accurate information is captured by sysinfo.</p>
+<p>- Give clear bug reproduction information as part of your bug entry. This could be in the form of a script, a program, code snippet or step-by-step instructions.</p>
+<p>- Include any relevant output from the derby.log file. If this information is too confusing for you to understand and the file isn't too big, you may want to attach it to your bug entry</p>
+<p>Provide error information such as SQLSTATE and nested exceptions reported by Derby. Usually, Derby would generate chained exceptions (nested), so you should write applications that traverse the chains with the getNextException() method call in your exception reporting code. If you are not using a JDBC application, you should report the series of nested exceptions (if generated) displayed on your error console.</p>
+</div>
+<a name="N10085"></a><a name="%22Close%22+your+bug+once+it+is+%22Resolved%22"></a>
+<h3>"Close" your bug once it is "Resolved"</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>As the submitter of a bug, it is your responsibility to verify a bug fix and "Close" the issue. Once fixed, a developer marks the bug as "Resolved" with a resolution of "Fixed". You need to then go back and "Close" the issue, provided you agree the bug has been fixed. If the resolution of the bug is something other than "Fixed" and you disagree, or the fix submitted did not really resolve the issue, you need to "Reopen" the issue. Please add relevant comments in Jira when doing these operations. See the document titled <a href="binaries/FilingDerbyIssuesInJira.doc">Filing Apache Derby Issues in Jira</a> for additional details.</p>
+<p>Note that once you file your bug, Jira will generate a notification email to the derby-dev@db.apache.org mail list.</p>
+</div>
+<a name="N10091"></a><a name="For+more+information"></a>
+<h3>For more information</h3>
+<div style="margin-left: 0 ; border: 2px">
+<p>You may want to read the document titled <a href="binaries/FilingDerbyIssuesInJira.doc">Filing Apache Derby Issues in Jira</a> for additional details on the following concepts:</p>
+<ul>
+<li>
+<p>How to search Jira for an existing bug</p>
+</li>
+<li>
+<p>How to Resolve/Close a bug</p>
+</li>
+<li>
+<p>The seemingly obvious and not-so-obvious fields in Jira such as Priority, Components and Resolutions</p>
+</li>
+<li>
+<p>Guidelines for workflow of issues in Jira</p>
+</li>
+<li>
+<p>What to do to avoid a poorly constructed bug entry</p>
+</li>
+</ul>
+<p>
+<em>Last updated: Nov 9, 2004</em>
+</p>
+</div>
+<div class="attribution"></div>
+</div>
+</td><td width="10"><img width="10" height="1" alt="" src="skin/images/spacer.gif" class="spacer"></td>
+</tr>
+<!--================= end Content==================-->
+</table>
+</td>
+</tr>
+</table>
+<!--================= end Menu, NavBar, Content ==================-->
+<!--================= start Footer ==================-->
+<table summary="footer" cellspacing="0" cellpadding="0" width="100%" border="0">
+<tr>
+<td colspan="2" height="1" bgcolor="#4C6C8F"><img height="1" width="1" alt="" src="skin/images/spacer.gif" class="spacer"><a href="skin/images/label.gif"></a><a href="skin/images/page.gif"></a><a href="skin/images/chapter.gif"></a><a href="skin/images/chapter_open.gif"></a><a href="skin/images/current.gif"></a><a href="/favicon.ico"></a></td>
+</tr>
+<tr>
+<td colspan="2" bgcolor="#CFDCED" class="copyright" align="center"><font size="2" face="Arial, Helvetica, Sans-Serif">Copyright ©
+ 2004 Apache Software Foundation All rights reserved.<script type="text/javascript" language="JavaScript"><!--
+ document.write(" - "+"Last Published: " + document.lastModified);
+ // --></script></font></td>
+</tr>
+<tr>
+<td colspan="2" align="left" bgcolor="#CFDCED" class="logos"></td>
+</tr>
+</table>
+<!--================= end Footer ==================-->
+</body>
+</html>
Added: incubator/derby/site/trunk/build/site/binaries/FilingDerbyIssuesInJira.doc
==============================================================================
Binary file. No diff available.
Modified: incubator/derby/site/trunk/build/site/derby_comm.html
==============================================================================
--- incubator/derby/site/trunk/build/site/derby_comm.html (original)
+++ incubator/derby/site/trunk/build/site/derby_comm.html Tue Nov 9 14:18:43 2004
@@ -157,7 +157,7 @@
</li>
<li>
-<a href="http://issues.apache.org/jira/browse/DERBY">BUGS</a>
+<a href="DerbyBugGuidelines.html">BUGS</a>
</li>
<li>
@@ -244,12 +244,14 @@
<li>
- Derby uses <a href="http://issues.apache.org/jira/browse/DERBY">Apache's Jira
+ Derby uses <a href="DerbyBugGuidelines.html">Apache's Jira
issue tracker</a>
to log bugs and enhancement requests.
Anyone can browse the Jira database.
- To log new issues, create a userid for yourself at
- <a href="http://issues.apache.org/jira">http://issues.apache.org/jira</a>.
+ To log new issues,
+ see the <a href="DerbyBugGuidelines.html">tips</a> page,
+ which describes how to create a userid for yourself and how
+ to log useful bugs.
To update existing issues, email your Jira userid to
<a href="derby_mail.html">derby-dev@db.apache.org</a> and
request that it be added to the derby-developers Jira list.
Modified: incubator/derby/site/trunk/build/site/faq.html
==============================================================================
--- incubator/derby/site/trunk/build/site/faq.html (original)
+++ incubator/derby/site/trunk/build/site/faq.html Tue Nov 9 14:18:43 2004
@@ -157,7 +157,7 @@
</li>
<li>
-<a href="http://issues.apache.org/jira/browse/DERBY">BUGS</a>
+<a href="DerbyBugGuidelines.html">BUGS</a>
</li>
<li>
@@ -310,7 +310,7 @@
<div style="margin-left: 15 ; border: 2px">
<p>
Apache Derby uses
- <a href="http://issues.apache.org/jira/browse/DERBY">Apache's Jira issue
+ <a href="DerbyBugGuidelines.html">Apache's Jira issue
tracker</a> to track bugs.
</p>
</div>
@@ -322,8 +322,10 @@
<div style="margin-left: 15 ; border: 2px">
<p>
Anyone can browse Apache Derby issues.
- To log new issues, create a userid for yourself at
- <a href="http://issues.apache.org/jira">http://issues.apache.org/jira</a>.
+ To log new issues,
+ see the <a href="DerbyBugGuidelines.html">tips</a> page,
+ which describes how to create a userid for yourself and how
+ to log useful bugs.
To update existing issues, email your Jira userid to
<a href="derby_mail.html">derby-dev@db.apache.org</a> and
request that it be added to the derby-developers Jira list.
Modified: incubator/derby/site/trunk/build/site/papers/misc.html
==============================================================================
--- incubator/derby/site/trunk/build/site/papers/misc.html (original)
+++ incubator/derby/site/trunk/build/site/papers/misc.html Tue Nov 9 14:18:43 2004
@@ -247,6 +247,7 @@
<p></p>
</li>
+
<li> Geronimo
<ul>
@@ -268,6 +269,7 @@
</li>
+
<li>
<a href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=derby-user@db.apache.org&msgNo=144">Eclipse plug-in for Derby</a>
@@ -298,12 +300,19 @@
<li>
<a href="http://nagoya.apache.org/eyebrowse/BrowseList?listName=derby-user@db.apache.org&by=subject&from=669620&to=669620&first=1&count=2">Tomcat</a>
</li>
+
+<li>
+<a href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=derby-dev@db.apache.org&msgNo=882">J2EE 1.4 SDK</a> configuration (plus links to notes by
+ <a href="http://weblogs.java.net/blog/jonbruce/archive/2004/11/sun_java_system_2.html">Jonathan Bruce</a>
+ and
+ <a href="http://weblogs.java.net/blog/lancea/archive/2004/11/using_apache_de.html">Lance Andersen</a>)
+ </li>
</ul>
</div>
-<a name="N10075"></a><a name="Wish+List"></a>
+<a name="N10084"></a><a name="Wish+List"></a>
<h3>Wish List</h3>
<div style="margin-left: 0 ; border: 2px">
<p>
@@ -329,7 +338,7 @@
<p>
-<em>Last Updated: November 8, 2004</em>
+<em>Last Updated: November 9, 2004</em>
</p>
<div class="attribution"></div>
Added: incubator/derby/site/trunk/src/documentation/content/binaries/FilingDerbyIssuesInJira.doc
==============================================================================
Binary file. No diff available.
Added: incubator/derby/site/trunk/src/documentation/content/xdocs/DerbyBugGuidelines.ihtml
==============================================================================
--- (empty file)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/DerbyBugGuidelines.ihtml Tue Nov 9 14:18:43 2004
@@ -0,0 +1,144 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<HTML>
+<HEAD>
+ <title>Tips For Filing Apache Derby Bugs </title>
+ <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=windows-1252">
+ <TITLE></TITLE>
+ <META NAME="GENERATOR" CONTENT="OpenOffice.org 1.1.3 (Win32)">
+ <META NAME="CREATED" CONTENT="20041108;14190374">
+ <META NAME="CHANGED" CONTENT="20041108;17285917">
+</HEAD>
+<BODY LANG="en-US" DIR="LTR">
+
+
+<h1>Introduction</h1>
+
+<P>This document is suggested reading for anyone who wants to enter a
+bug against Derby. It explains how to go about filing a bug and what
+information you should provide to make the bug entry useful to a
+developer attempting to fix it. For information on filing other
+issues in Jira (enhancements, improvements etc.) and for a detailed
+description of some of the less understood concepts and data fields
+in Jira, please read the document titled <A HREF="binaries/FilingDerbyIssuesInJira.doc">Filing
+Apache Derby Issues in Jira</A>.</P>
+
+<P>
+Derby issues are maintained at
+<a href="http://issues.apache.org/jira/browse/DERBY">http://issues.apache.org/jira/browse/DERBY</a>.
+Suggested actions to take before/while filing a bug are listed in the
+sections below.
+</P>
+
+<h1>Login to Jira/Request a Jira userid</h1>
+
+<P>You may access Jira at</p>
+<p><A HREF="http://issues.apache.org/jira">http://issues.apache.org/jira
+</A>
+</P>
+
+
+<P>If you do not have a userid, create one. A "Signup" link
+has been provided on the login page. There are 2 levels of access to
+Derby issues in Jira, "user" access and "developer"
+access. A "user" may open a bug but will not be able to
+edit/update/assign it. This requires "developer"
+privileges. If you think you will need to edit/update a bug entry,
+please send an email to <A HREF="mailto:derby-dev@db.apache.org">derby-dev@db.apache.org</A>
+requesting that you be added in to the "derby-developers"
+group in Jira.
+</P>
+
+<h1>Search Jira for an existing bug report</h1>
+<P>Before filing a new bug, it is recommended that you first search
+Jira to verify that it has not yet been reported. Jira offers various
+fields (and combinations thereof) that you can search on. You will
+probably benefit the most by searching on keywords that are relevant
+to the bug you are intending to report. For more details on how to
+search, see the document titled <A HREF="binaries/FilingDerbyIssuesInJira.doc">Filing
+Apache Derby Issues in Jira</A>.
+</P>
+
+<h1>Post your bug to the mailing lists</h1>
+
+<P>If the bug you are intending to report is not already logged in
+Jira, it may be a good idea to post a query to the
+<A HREF="mailto:derby-user@db.apache.org">derby-user@db.apache.org</A>
+mail list asking the following:</P>
+<P>- is your bug really a bug (or a restriction, feature request etc)</P>
+<P>- has anyone else noticed this bug and if so, under what
+circumstances</P>
+<P>- can anyone suggest a workaround for the problem</P>
+<P>- if relevant, why you think the bug is a "blocker"
+(highest priority)</P>
+<P>Note: Posting to the mail lists should not be seen as an
+alternative to filing the bug in Jira. This step may be viewed as
+optional, however you should at least search Jira for an existing bug
+report. </P>
+
+<h1>File your bug</h1>
+
+<P>When you post a new bug to the mail lists, please pay attention to
+the following details that make it a "useful" post. These
+simple guidelines help avoid poorly filed/described bugs:</P>
+<P>- Attach the output of "sysinfo" to your bug
+description. This contains important version, CLASSPATH, build, JRE
+and platform information that will be useful to a developer trying to
+reproduce and resolve the bug. Please run the following command in
+the exact same environment your Derby application ran under when the
+bug was detected</P>
+<P>'java org.apache.derby.tools.sysinfo'</P>
+<P>When you set your application environment manually, make sure you
+do the very same setup before running sysinfo. On the other hand,
+when the application sets up the environment, you need to run sysinfo
+under the application environment to ensure that accurate information
+is captured by sysinfo.</P>
+<P>- Give clear bug reproduction information as part of your bug
+entry. This could be in the form of a script, a program, code snippet
+or step-by-step instructions.
+</P>
+<P>- Include any relevant output from the derby.log file. If this
+information is too confusing for you to understand and the file isn't
+too big, you may want to attach it to your bug entry</P>
+<P>Provide error information such as SQLSTATE and nested exceptions
+reported by Derby. Usually, Derby would generate chained exceptions
+(nested), so you should write applications that traverse the chains
+with the getNextException() method call in your exception reporting
+code. If you are not using a JDBC application, you should report the
+series of nested exceptions (if generated) displayed on your error
+console.
+</P>
+
+<h1>"Close" your bug once it is "Resolved"</h1>
+
+<P>As the submitter of a bug, it is your responsibility to verify a
+bug fix and "Close" the issue. Once fixed, a developer
+marks the bug as "Resolved" with a resolution of "Fixed".
+You need to then go back and "Close" the issue, provided
+you agree the bug has been fixed. If the resolution of the bug is
+something other than "Fixed" and you disagree, or the fix
+submitted did not really resolve the issue, you need to "Reopen"
+the issue. Please add relevant comments in Jira when doing these
+operations. See the document titled <A HREF="binaries/FilingDerbyIssuesInJira.doc">Filing
+Apache Derby Issues in Jira</A> for additional details.</P>
+
+<P>Note that once you file your bug, Jira will generate a
+notification email to the derby-dev@db.apache.org mail list.
+</P>
+
+<h1>For more information</h1>
+
+<P>You may want to read the document titled <A HREF="binaries/FilingDerbyIssuesInJira.doc">Filing
+Apache Derby Issues in Jira</A> for additional details on the
+following concepts:</P>
+<UL>
+ <LI><P>How to search Jira for an existing bug</P>
+ <LI><P>How to Resolve/Close a bug</P>
+ <LI><P>The seemingly obvious and not-so-obvious fields in Jira such
+ as Priority, Components and Resolutions</P>
+ <LI><P>Guidelines for workflow of issues in Jira</P>
+ <LI><P>What to do to avoid a poorly constructed bug entry</P>
+</UL>
+
+<p><em>Last updated: Nov 9, 2004</em></p>
+</BODY>
+</HTML>=
Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/derby_comm.xml Tue Nov 9 14:18:43 2004
@@ -1,6 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd">
-
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Apache Derby: Get Involved!</title>
@@ -24,23 +23,25 @@
<ul>
<li>
- Subscribe to the <link href="derby_mail.html">Derby mail lists</link>.
+ Subscribe to the <a href="derby_mail.html">Derby mail lists</a>.
</li>
<li>
- Derby uses <link href="http://issues.apache.org/jira/browse/DERBY">Apache's Jira
- issue tracker</link>
+ Derby uses <a href="DerbyBugGuidelines.html">Apache's Jira
+ issue tracker</a>
to log bugs and enhancement requests.
Anyone can browse the Jira database.
- To log new issues, create a userid for yourself at
- <link href="http://issues.apache.org/jira">http://issues.apache.org/jira</link>.
+ To log new issues,
+ see the <a href="DerbyBugGuidelines.html">tips</a> page,
+ which describes how to create a userid for yourself and how
+ to log useful bugs.
To update existing issues, email your Jira userid to
- <link href="derby_mail.html">derby-dev@db.apache.org</link> and
+ <a href="derby_mail.html">derby-dev@db.apache.org</a> and
request that it be added to the derby-developers Jira list.
</li>
<li>
Pre-built jar files are available on the
- <link href="derby_downloads.html#jars">Derby Downloads</link> page.
+ <a href="derby_downloads.html#jars">Derby Downloads</a> page.
</li>
</ul>
@@ -60,22 +61,22 @@
<ul>
<li> Like all Apache projects, the Derby
- <link href="http://incubator.apache.org/incubation/Process_Description.html">
- incubator project</link>
+ <a href="http://incubator.apache.org/incubation/Process_Description.html">
+ incubator project</a>
follows the
- <link href="http://www.apache.org/foundation/how-it-works.html">Apache
- Way</link>.
+ <a href="http://www.apache.org/foundation/how-it-works.html">Apache
+ Way</a>.
</li>
<li>The Derby community
- <link href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=derby-dev@db.apache.org&msgNo=258">voted to follow</link>
+ <a href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=derby-dev@db.apache.org&msgNo=258">voted to follow</a>
the guidelines established by the
- <link href="http://db.apache.org/guidelines.html">Apache DB Project</link>.
+ <a href="http://db.apache.org/guidelines.html">Apache DB Project</a>.
</li>
<li>
Changes to the Apache DB Project guidelines may be called for and
voted on using the
- <link href="derby_mail.html">derby-dev</link> mail list.
+ <a href="derby_mail.html">derby-dev</a> mail list.
</li>
<li>
This page will maintain a list of how the Derby process differs from the
@@ -89,7 +90,7 @@
<p>
The Apache DB Project recommends using
-<link href="http://db.apache.org/source.html">cvs diff</link>
+<a href="http://db.apache.org/source.html">cvs diff</a>
output for creating patches,
but Derby uses <code>svn</code>,
so use '<code>svn diff</code>' instead.
@@ -101,12 +102,12 @@
<p>
If you use Enigmail to send a patch to the
-<link href="derby_mail.html">derby-dev</link> mail list be aware that,
+<a href="derby_mail.html">derby-dev</a> mail list be aware that,
by default,
Enigmail handles Mozilla's <em>text=flowed</em> formatting
by replacing leading spaces with a tilde ("~") character (see
-<link href="http://enigmail.mozdev.org/troubles.html#flowed">
-http://enigmail.mozdev.org/troubles.html#flowed</link>).
+<a href="http://enigmail.mozdev.org/troubles.html#flowed">
+http://enigmail.mozdev.org/troubles.html#flowed</a>).
To send a patch in-line using Enigmail,
turn off the <em>Allow flowed text</em> setting:
</p>
@@ -117,11 +118,11 @@
<p>
If you use Enigmail to save a patch submitted to the
-<link href="derby_mail.html">derby-dev</link> mail list,
+<a href="derby_mail.html">derby-dev</a> mail list,
you may need to decrypt and save that decrypted email if it was signed using
gnuPG because
lines that begin with a dash get escaped with "- " (see
-<link href="http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7">http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7</link>).
+<a href="http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7">http://www.stillhq.com/extracted/gnupg-api/doc/faq.html#q4.7</a>).
To extract the text in Enigmail without the escape characters,
first decrypt the email, then save the decrypted message:
</p>
Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/faq.xml
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/faq.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/faq.xml Tue Nov 9 14:18:43 2004
@@ -4,7 +4,9 @@
<faqs title="Frequently Asked Questions">
<part id="developers">
+
<title>Developing Derby</title>
+
<faq id="derby_source">
<question>
Where is the Derby source code?
@@ -21,10 +23,13 @@
</p>
</answer>
</faq>
+
<faq id="derby_internals">
+
<question>
Where can I read about Derby internals?
</question>
+
<answer>
<p> The
<link href="papers/derby_arch.html">Derby Engine Architecture
@@ -35,7 +40,9 @@
mail list and post any questions you have.
</p>
</answer>
+
</faq>
+
<faq id="derby_issues">
<question>
Where are Apache Derby bugs logged?
@@ -43,11 +50,12 @@
<answer>
<p>
Apache Derby uses
- <link href="http://issues.apache.org/jira/browse/DERBY">Apache's Jira issue
+ <link href="DerbyBugGuidelines.html">Apache's Jira issue
tracker</link> to track bugs.
</p>
</answer>
</faq>
+
<faq id="derby_update">
<question>
Who can create a new Apache Derby issue?
@@ -55,16 +63,19 @@
<answer>
<p>
Anyone can browse Apache Derby issues.
- To log new issues, create a userid for yourself at
- <link href="http://issues.apache.org/jira">http://issues.apache.org/jira</link>.
+ To log new issues,
+ see the <link href="DerbyBugGuidelines.html">tips</link> page,
+ which describes how to create a userid for yourself and how
+ to log useful bugs.
To update existing issues, email your Jira userid to
<link href="derby_mail.html">derby-dev@db.apache.org</link> and
request that it be added to the derby-developers Jira list.
</p>
</answer>
</faq>
- <!-- More faqs or parts here -->
+
</part>
+
<part id="users">
<title>Using Derby</title>
@@ -110,8 +121,5 @@
</p>
</answer>
</faq>
-
- <!-- More faqs or parts here -->
</part>
- <!-- More faqs or parts here -->
</faqs>
Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/papers/misc.xml
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/papers/misc.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/papers/misc.xml Tue Nov 9 14:18:43 2004
@@ -32,6 +32,7 @@
</ul>
<p></p>
</li>
+
<li> Geronimo
<ul>
<li><a href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=derby-dev@db.apache.org&msgNo=105">Geronimo</a></li>
@@ -45,6 +46,7 @@
<p></p>
</li>
+
<li><a href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=derby-user@db.apache.org&msgNo=144">Eclipse plug-in for Derby</a>
</li>
@@ -57,6 +59,11 @@
<li><a href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=derby-user@db.apache.org&msgNo=166">Mono/.NET</a></li>
<li><a href="http://nagoya.apache.org/eyebrowse/BrowseList?listName=derby-user@db.apache.org&by=subject&from=675614&to=675614&first=1&count=2">JBoss</a></li>
<li><a href="http://nagoya.apache.org/eyebrowse/BrowseList?listName=derby-user@db.apache.org&by=subject&from=669620&to=669620&first=1&count=2">Tomcat</a></li>
+ <li> <a href="http://nagoya.apache.org/eyebrowse/ReadMsg?listName=derby-dev@db.apache.org&msgNo=882">J2EE 1.4 SDK</a> configuration (plus links to notes by
+ <a href="http://weblogs.java.net/blog/jonbruce/archive/2004/11/sun_java_system_2.html">Jonathan Bruce</a>
+ and
+ <a href="http://weblogs.java.net/blog/lancea/archive/2004/11/using_apache_de.html">Lance Andersen</a>)
+ </li>
</ul>
</section>
@@ -77,6 +84,6 @@
</section>
-<p><em>Last Updated: November 8, 2004</em></p>
+<p><em>Last Updated: November 9, 2004</em></p>
</body>
</document>
Modified: incubator/derby/site/trunk/src/documentation/content/xdocs/site.xml
==============================================================================
--- incubator/derby/site/trunk/src/documentation/content/xdocs/site.xml (original)
+++ incubator/derby/site/trunk/src/documentation/content/xdocs/site.xml Tue Nov 9 14:18:43 2004
@@ -15,9 +15,9 @@
<apacheCon label="ApacheCon US 2004" href="ApacheConUS04.html"/>
<derby_comm label="Get Involved!" href="derby_comm.html"/>
<derby_mail label="Mailing Lists" href="derby_mail.html"/>
- <derby_bugs label="BUGS" href="http://issues.apache.org/jira/browse/DERBY"/>
+ <derby_bugs label="BUGS" href="DerbyBugGuidelines.html"/>
<derby_todo label="To-Do" href="DerbyToDo.html"/>
- <derby_int label="Integration Topics" href="papers/" tab="home" />
+ <derby_int label="Integration Topics" href="papers/index.html" tab="home" />
</community>
<papers label="About" href="papers/" tab="papers">