db-derby-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Apache Wiki <wikidi...@apache.org>
Subject [Db-derby Wiki] Update of "siddharthsrivastava/QuickStartGuide_NewDevelopers" by siddharthsrivastava
Date Tue, 19 Apr 2011 14:19:23 GMT
Dear Wiki user,

You have subscribed to a wiki page or wiki category on "Db-derby Wiki" for change notification.

The "siddharthsrivastava/QuickStartGuide_NewDevelopers" page has been changed by siddharthsrivastava.
http://wiki.apache.org/db-derby/siddharthsrivastava/QuickStartGuide_NewDevelopers?action=diff&rev1=72&rev2=73

--------------------------------------------------

  (iv) Setting CLASSPATH: Following are the jars that needs to be included in your classpath
  
  ||<tablestyle="margin-left: 0.75in; border-collapse: collapse; border: medium none;"width="283px"
style="border: 1pt solid black; padding: 0in 5.4pt; vertical-align: top;">'''Jar name'''
||<width="283px" style="border-width: 1pt 1pt 1pt medium; border-style: solid solid solid
none; border-color: black black black -moz-use-text-color; padding: 0in 5.4pt; vertical-align:
top;">'''Purpose''' ||
+ ||<width="283px" height="19.75pt" style="border-width: medium 1pt 1pt; border-style:
none solid solid; border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align:
top;">jakarta-oro-2.0.8.jar  (trunk\tools\java) ||<width="283px" height="19.75pt" s
- ||<width="283px" height="19.75pt" style="border-width: medium 1pt 1pt; border-style:
none solid solid; border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align:
top;">jakarta-oro-2.0.8.jar  (trunk\tools\java) ||<width="283px" height="19.75pt" style="border-width:
medium 1pt 1pt medium; border-style: none solid solid none; border-color: -moz-use-text-color
black black -moz-use-text-color; padding: 0in 5.4pt; vertical-align: top;">Required for
running Derby harness tests ||
- ||<width="283px" style="border-width: medium 1pt 1pt; border-style: none solid solid;
border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align: top;">derbyTesting.jar
||<width="283px" style="border-width: medium 1pt 1pt medium; border-style: none solid solid
none; border-color: -moz-use-text-color black black -moz-use-text-color; padding: 0in 5.4pt;
vertical-align: top;">test files and classes ||
- ||<width="283px" style="border-width: medium 1pt 1pt; border-style: none solid solid;
border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align: top;">derby.jar
||<width="283px" style="border-width: medium 1pt 1pt medium; border-style: none solid solid
none; border-color: -moz-use-text-color black black -moz-use-text-color; padding: 0in 5.4pt;
vertical-align: top;">main derby package classes ||
- ||<width="283px" style="border-width: medium 1pt 1pt; border-style: none solid solid;
border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align: top;">derbytools.jar
||<width="283px" style="border-width: medium 1pt 1pt medium; border-style: none solid solid
none; border-color: -moz-use-text-color black black -moz-use-text-color; padding: 0in 5.4pt;
vertical-align: top;">derby tools classes for tools like ij   and dblook ||
- ||<width="283px" style="border-width: medium 1pt 1pt; border-style: none solid solid;
border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align: top;">derbyrun.jar
||<width="283px" style="border-width: medium 1pt 1pt medium; border-style: none solid solid
none; border-color: -moz-use-text-color black black -moz-use-text-color; padding: 0in 5.4pt;
vertical-align: top;">executable jar file for tools like ij   and dblook ||
- ||<width="283px" style="border-width: medium 1pt 1pt; border-style: none solid solid;
border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align: top;">derbynet.jar
||<width="283px" style="border-width: medium 1pt 1pt medium; border-style: none solid solid
none; border-color: -moz-use-text-color black black -moz-use-text-color; padding: 0in 5.4pt;
vertical-align: top;">derby network server classes ||
- ||<width="283px" height="20.2pt" style="border-width: medium 1pt 1pt; border-style: none
solid solid; border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align:
top;">derbyclient.jar ||<width="283px" height="20.2pt" style="border-width: medium 1pt
1pt medium; border-style: none solid solid none; border-color: -moz-use-text-color black black
-moz-use-text-color; padding: 0in 5.4pt; vertical-align: top;">derby client classes ||
- ||<width="283px" style="border-width: medium 1pt 1pt; border-style: none solid solid;
border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align: top;">junit.jar
||<width="283px" style="border-width: medium 1pt 1pt medium; border-style: none solid solid
none; border-color: -moz-use-text-color black black -moz-use-text-color; padding: 0in 5.4pt;
vertical-align: top;">assertion-based test machinery. It needs to be   manually put into
trunk/tools/java directory.     See BUILDING.html for details.   It is required for running
JUnit tests in Derby ||
  
- 
- For Derby checked out from the trunk, the classpath should be set as follows:  Say, you
want to add derbyclient.jar to the classpath:
- 
- ||<tablestyle="margin-left: 54.9pt; border-collapse: collapse; border: medium none;"width="222px"
style="border: 1pt solid black; padding: 0in 5.4pt; vertical-align: top;">Operating System
||<width="343px" style="border-width: 1pt 1pt 1pt medium; border-style: solid solid solid
none; border-color: black black black -moz-use-text-color; padding: 0in 5.4pt; vertical-align:
top;">Command ||
- ||<width="222px" style="border-width: medium 1pt 1pt; border-style: none solid solid;
border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align: top;">Linux
/ OSX ||<width="343px" style="border-width: medium 1pt 1pt medium; border-style: none solid
solid none; border-color: -moz-use-text-color black black -moz-use-text-color; padding: 0in
5.4pt; vertical-align: top;">export CLASSPATH=$DERBY_HOME/sane/jars/derbyclient.jar ||
- ||<width="222px" style="border-width: medium 1pt 1pt; border-style: none solid solid;
border-color: -moz-use-text-color black black; padding: 0in 5.4pt; vertical-align: top;">Windows
||<width="343px" style="border-width: medium 1pt 1pt medium; border-style: none solid solid
none; border-color: -moz-use-text-color black black -moz-use-text-color; padding: 0in 5.4pt;
vertical-align: top;">set CLASSPATH=%DERBY_HOME%\jars\sane\derbyclient.jar ||
- 
- Note: It is advisable to set the classpath only for the session for Derby if you have other
versions of junit, jakarta-oro etc. set in the global classpath.
- To set the classpath for only a session: set the classpath from the terminal/command window.
- 
- b) __Building Derby from source:__
-     Refer to [[http://svn.apache.org/viewvc/db/derby/code/trunk/BUILDING.html?view=co|BUILDING.html]]
for  detailed instructions.
- 
- c) __Verify the build__
- 
- To verify that the build is a good one, you must run the regression tests.
- 
- But for quickly verifying your build, please try running the test SimpleTest.
- To run it, type the following in the terminal
- 
-          ''java junit.textui.TestRunner org.apache.derbyTesting.functionTests.tests.lang.SimpleTest''
- 
- If the test fails, then you must check your build of Derby.
- 
- == Running Regression Tests ==
-      There are two types of test in Derby: Harness Tests and [[http://wiki.apache.org/db-derby/IntroToJUnit|JUnit]]
Tests. We are converting the harness tests to       JUnit Tests . [[http://wiki.apache.org/db-derby/KillDerbyTestHarness#Goals|Why]]
? Whenever you make changes to the code, these tests need to be run so as to make sure that
the changes didn’t break any other part of Derby.
- 
- To run '''suites.All''' (the suite that runs all the JUnit tests in Derby), add junit.jar
to your classpath and run:
- 
-           ''java -XX:MaxPermSize=512m  junit.textui.TestRunner org.apache.derbyTesting.functionTests.suites.All''
- (Note: It can take approximately 4-6 hours for regression tests to complete)
- 
- To run '''derbyAll''' (the suite for running harness tests in Derby), add jakarta-oro-2.0.8.jar
 to your classpath and run:
- 
-           ''java org.apache.derbyTesting.functionTests.harness.RunSuite derbyall''
- 
- For detailed information about tests, refer [[http://svn.apache.org/viewvc/db/derby/code/trunk/java/testing/README.htm?view=co|Testing
README]]
- 
- == Using IDE to Build Derby ==
- 
- Either Eclipse or Netbeans can be used to build derby
- 
- 1) [[http://wiki.apache.org/db-derby/BuildingDerby#Using_Eclipse_to_Build_Derby|Using Eclipse
to build Derby]]
- 
- 2) [[http://wiki.apache.org/db-derby/BuildingDerby#Using_NetBeans_to_Build_Derby|Using Netbeans
to build Derby]]
- 
- = New Developer Tips =
- 
- 1) Join [[http://db.apache.org/derby/derby_mail.html|Derby Developers Mailing List]], ask
questions, help others and become a part of the community (the most important of being an
Open Source Developer, isn't it ;-) ). Derby has a very active, helping and nice community,
so feel free to drop any of your queries to the mailing list.
- 
- 2) While running tests, clean your current directory containing any artifacts from previous
tests. Refer [[https://issues.apache.org/jira/browse/DERBY-5129|DERBY-5129]]
- 
- 3) When you rebuild Derby,  if you face issues related to the build procedure (buildjars),
not being able to overwrite some of the existing jars, delete the existing jars from trunk/jars/sane
directory and run the buildjars (ant –quiet buildjars) again.See [[https://issues.apache.org/jira/browse/DERBY-5128|DERBY-5128]]
- 
- = Next Steps =
- 
- Following resources are for developers who would like to contribute to Derby
- 
- * For suggested starting point for New Developers, please visit The [[http://wiki.apache.org/db-derby/ForNewDevelopers|ForNewDevelopers]]
wiki page
- 
- * The [[http://db.apache.org/derby/derby_comm.html|Apache Derby: Get Involved!]] page includes
tips for [[http://db.apache.org/derby/derby_comm.html#Contribute+Code+or+Documentation|contributing
code and documentation]].
- 
- * The [[http://db.apache.org/derby/papers/index.html#Derby+Engine|Derby Engine]] papers
provide internal details about Derby.
- 
- * If you want to know more about internals of Derby, refer [[http://wiki.apache.org/db-derby/HowItWorks|How
it works]]
- 
- = Frequently Asked Questions =
- 
- 1) ''Where can I get help if I get stuck ?''
- 
- You can ask questions at derby-dev@db.apache.org (the Derby Developers mailing list)
- You can also ask questions at our IRC channel: #derby at Freenode
- 
- 2) ''Where are Apache Derby bugs logged ?''
- 
- Apache Derby uses Apache's Jira issue tracker to track bugs.
- 
- 3) ''Who can create a new Apache Derby issue ?''
- 
- Anyone can browse Apache Derby issues. To log new issues, see the [[http://db.apache.org/derby/DerbyBugGuidelines.html|tips
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 derby-dev@db.apache.org and request that
it be added to the derby-developers Jira list.
- 

Mime
View raw message