You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tuscany.apache.org by ri...@apache.org on 2006/05/15 19:14:36 UTC

svn commit: r406685 - in /incubator/tuscany/site/src/site: resources/jdkinstall.jpg site.xml xdoc/bugs.xml xdoc/faq.xml xdoc/getinvolved.xml xdoc/installjava.xml xdoc/news.xml xdoc/patches.xml

Author: rineholt
Date: Mon May 15 10:14:35 2006
New Revision: 406685

URL: http://svn.apache.org/viewcvs?rev=406685&view=rev
Log:
TUSCANY-162
TUSCANY-183
TUSCANY-351
Provided by Haleh

Added:
    incubator/tuscany/site/src/site/resources/jdkinstall.jpg   (with props)
    incubator/tuscany/site/src/site/xdoc/patches.xml
Modified:
    incubator/tuscany/site/src/site/site.xml
    incubator/tuscany/site/src/site/xdoc/bugs.xml
    incubator/tuscany/site/src/site/xdoc/faq.xml
    incubator/tuscany/site/src/site/xdoc/getinvolved.xml
    incubator/tuscany/site/src/site/xdoc/installjava.xml
    incubator/tuscany/site/src/site/xdoc/news.xml

Added: incubator/tuscany/site/src/site/resources/jdkinstall.jpg
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/resources/jdkinstall.jpg?rev=406685&view=auto
==============================================================================
Binary file - no diff available.

Propchange: incubator/tuscany/site/src/site/resources/jdkinstall.jpg
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Modified: incubator/tuscany/site/src/site/site.xml
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/site.xml?rev=406685&r1=406684&r2=406685&view=diff
==============================================================================
--- incubator/tuscany/site/src/site/site.xml (original)
+++ incubator/tuscany/site/src/site/site.xml Mon May 15 10:14:35 2006
@@ -64,7 +64,6 @@
 			<item name="Wiki" href="/wiki.html" />
 			<item name="Requirements" href="/requirements.html" />
 			<item name="FAQ" href="/faq.html" />
-			<item name="Reference Library" href="reference.html" />
 		</menu>
 		
 		<menu name="Development">

Modified: incubator/tuscany/site/src/site/xdoc/bugs.xml
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/xdoc/bugs.xml?rev=406685&r1=406684&r2=406685&view=diff
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/bugs.xml (original)
+++ incubator/tuscany/site/src/site/xdoc/bugs.xml Mon May 15 10:14:35 2006
@@ -28,13 +28,18 @@
 	<section name="Apache Tuscany Bug Reporting and Tracking" />
 		<p>
 			Tuscany bug reports are handled via a 
-			<a href="http://issues.apache.org/jira/browse/TUScany">
-				JIRA issues list
-			</a>.
+			<a href="http://issues.apache.org/jira/browse/TUScany"> JIRA issues list </a>.
 			Please use this list to report any bugs that you find - the list can also be used to
-			track the status of your bug reports.
+			track the status of reported bugs.
+			<p>
+			To help developers to quickly fix the bug, please include as much information with your report as possible such as your platform, version numbers, error logs, configuration, 'how to reproduce the problem',  etc. </p>
+
+			
+		</p>
+
+		<p> Tuscany project welcomes your help to improve the project. Here is information on how to <a href="patches.html"> create and submit patches </a>.
 		</p>
 		
 	</body>
 
-</document>
\ No newline at end of file
+</document>

Modified: incubator/tuscany/site/src/site/xdoc/faq.xml
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/xdoc/faq.xml?rev=406685&r1=406684&r2=406685&view=diff
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/faq.xml (original)
+++ incubator/tuscany/site/src/site/xdoc/faq.xml Mon May 15 10:14:35 2006
@@ -34,9 +34,17 @@
 					based on the same Service Component Architecture specification that is used by
 					the Tuscany runtime.					
 				</p>
+
+				<li>
+					I get null pointer for all samples running Tomcat. What is wrong?
+				</li>
+				This is result of a user error but useful to know anyhow. The build/test instructions say that to run the helloworld tomcat test you go to testing/tomcat and run mvn. This works fine. 
+				<br></br>If you forget this instruction and use the "prepareTomcat" ant target that the maven pom refers to, it fails. 
+				<p>
+				</p>
 			</ul>
 
 
 		</section>
 	</body>
-</document>
\ No newline at end of file
+</document>

Modified: incubator/tuscany/site/src/site/xdoc/getinvolved.xml
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/xdoc/getinvolved.xml?rev=406685&r1=406684&r2=406685&view=diff
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/getinvolved.xml (original)
+++ incubator/tuscany/site/src/site/xdoc/getinvolved.xml Mon May 15 10:14:35 2006
@@ -49,7 +49,7 @@
 				</li>
 				<li>	
 			Help with 
-                    <script type="text/javascript">linkNewWindow('samples/java/docs/sampleSetup.htm','Tuscany Samples');</script> 
+                    <script type="text/javascript">linkNewWindow('samples/java/sampleSetup.htm','Tuscany Samples');</script> 
             to demonstrate Tuscany's value and help new users understand Tuscany
 				</li>
 			</ul>
@@ -111,322 +111,9 @@
 				<li> CPP directory holds SCA and SDO C++ source code. </li>
 				 <li> Java directory holds SCA, SDO and DAS source code.</li> 
 			     </ol>
-			     We welcome your help with any of the projects. You can learn more about how to setup your development environment for <script type="text/javascript">linkNewWindow('projectJava.html','Java');</script> or <script type="text/javascript">linkNewWindow('projectC++.html','C++');</script>. 
-			     <br></br>
-			     Both C++ and Java projects are in svn repository. 
-			     <script type="http://www.apache.org/dev/version-control.html#anon-svn">linkNewWindow('http://wiki.apache.org/ws/Tuscany','Apache guidance for Subversion');</script> 
-			A quick reference for subversion commands is provided in <a href="#using subversion">using subversion</a>.
+			     We welcome your help with any of the sub projects. You can learn more about how to setup your development environment on <script type="text/javascript">linkNewWindow('projectJava.html','Java project page');</script> or <script type="text/javascript">linkNewWindow('projectC++.html','C++ project page');</script>. 
+			     
 		</p>
-		</section>
-		<section name="Get Started On Tuscany Using Java">
-		<p>
-			<ul>
-			<li>
-			<span style="">
-					<span style="font-size: 10pt;">
-						The Tuscany Java projects depend on J2SE version 5.x which can be downloaded here:
-						<span style="" />
-					</span>
-				</span>
-				<a href="http://java.sun.com/j2se/1.5.0/download.jsp">
-					<span style="">
-						<span style="font-size: 10pt;">
-							http://java.sun.com/j2se/1.5.0/download.jsp
-						</span>
-					</span>
-					<span style="" />
-				</a>
-				<span style="">
-					<span style="font-size: 10pt;" />
-				</span>
-			</li>
-		
-			<li>
-			The Java project is built using <script type="text/javascript">linkNewWindow('http://maven.apache.org/','Apache Maven 2');</script>
-			</li>
-	
-			<li>
-				The Tuscany runtime can be used as a server in conjunction with Tomcat, which you can find
-				here:
-                                    <script type="text/javascript">linkNewWindow('http://tomcat.apache.org/','http:/tomcat.apache.org');</script> 
-			<p>
-				Download "The Core" Tomcat 5.5.<i>xx</i> from:
-				<a href="http://tomcat.apache.org/download-55.cgi">
-					http://tomcat.apache.org/download-55.cgi
-				</a>
-			</p>
-		
-                        <p>
-                         For setting up Tomcat to run Tuscany see the sample's readme 
-                          <script type="text/javascript">linkNewWindow('samples/java/docs/sampleSetup.htm#Tomcat_Setup','Tomcat Setup');</script> in the sample's
-                          readme.
-                          </p>
-
-	 	 </li>
-
-	 	 <li>
-             Run  <script type="text/javascript">linkNewWindow('samples/java/docs/sampleSetup.htm','Tuscany Samples');</script>.
-		</li>
-		</ul>
-		  </p>
-                <p>
-		 You can use any IDE. Tuscany has a preferred way of running from within Eclipse and IDEA. This is documented below.
-		 You will also find high level introduction for maven 2.0 as well as subversion in the text below.
-		</p>
-            
-	</section>
-	<a name="using subversion"></a>
-	<section name="Using Subversion (Command Line)">
-	<p>
-		You can download Subversion from 
-                <script type="text/javascript">linkNewWindow('http://subversion.tigris.org/','http://subversion.tigris.org/');</script>.
-	</p>
-	<p>
-		Subversion Reference manual ("the book") is located at 
-                <script type="text/javascript">linkNewWindow('http://svnbook.red-bean.com/','http://svnbook.red-bean.com/');</script>.
-	</p>
-	<p>
-	<span style="font-size: 10pt;">
-		If you use Eclipse as your development environment, there is a plugin available
-		which enables you to use Subversion from within Eclipse (ie it is a Subversion
-		client for Eclipse).  This plugin is called Subclipse and it is located at:
-                <script type="text/javascript">linkNewWindow('http://subclipse.tigris.org/','http://subclipse.tigris.org/');</script>
-		</span>
-		</p>
-		<p style="margin-right: -0.25in;">
-		<span style="font-size: 10pt;">
-		If you use Windows on your systems, there is also a graphical client implemented as an
-			extension to the Windows shell, called TortoiseSVN:
-					<span style="" />
-					http://tortoisesvn.tigris.org/
-				</span>
-			</p>
-			<span style="font-size: 14pt;">
-					Common Commands for Subversion
-			</span>
-			<p>Create a directory called tuscany and check out the project.
-				<p>
-				<b style="">
-					<i style="">To check out the Java project:</i>
-				</b>
-				</p>
-			</p>
-			<pre>
-Committers:                        
-svn co https://svn.apache.org/repos/asf/incubator/tuscany/java
-Non-Commiters:
-svn co http://svn.apache.org/repos/asf/incubator/tuscany/java
-			</pre>
-			<p>
-				<b style="">
-					<i style="">To check out the C++ project:</i>
-				</b>
-			</p>
-			<pre>
-Committers:                        
-svn co https://svn.apache.org/repos/asf/incubator/tuscany/cpp
-Non-Commiters:
-svn co http://svn.apache.org/repos/asf/incubator/tuscany/cpp
-			</pre>
-			<p>
-				If it worked, you will see all the files as they
-				checkout followed by a revision number - this is the
-				version of the tree that you have (useful for comparing notes)
-			</p>
-			<p>
-				<b style="">
-					<i style="">
-						To update your copy with other's people's committed changes:
-					</i>
-				</b>
-			</p>
-			<pre>
-svn update
-			</pre>
-			<p>
-				<b>
-					<i>To manipulate files in various ways:</i>
-				</b>
-			</p>
-			<pre>
-svn add
-
-svn move
-
-svn remove
-
-svn diff
-			</pre>
-			<p>
-				<b>
-					<i>To commit changes go to the root and:</i>
-				</b>
-			</p>
-			<pre>
-svn commit -m"change comment"
-			</pre>
-			<p>
-				This will commit the entire tree and display the new
-				revision number. You can also commit sub-trees and
-				individual files but this is not normal.
-			</p>
-			<p>
-				<b>
-					<i>To undo changes:</i>
-				</b>
-			</p>
-			<pre>svn revert ${file}</pre>
-			<pre>svn revert -R ${directory}
-			</pre>
-			<p>
-				<b>
-					<i>To see what has changed locally:</i>
-				</b>
-			</p>
-			<pre>svn status</pre>
-			<p style="margin-left: 0.5in;">
-				<b>
-					<i>Results:</i>
-				</b>
-			</p>
-			<p>
-				A means a file has been added locally
-			</p>
-			<p>
-				D means a file has been deleted locally
-			</p>
-			<p>
-				M means a file has been modified locally
-			</p>
-			<p>
-				? means a file exists locally that is not being managed
-				by svn.
-				<span style="" />
-				Typically this means you forgot to add it with
-				<span style="font-family: Courier;">svn add</span>
-				.
-			</p>
-			<p style="margin-left: 1in;">
-				! means a file that was being managed by svn no longer
-				exists locally.
-				<span style="" />
-				Typically this means you didn't delete it using svn
-				remove.
-			</p>
-		</section>
-
-
-		<section name="Using Eclipse (optional)">
-			<p>
-				<span style="font-size: 10pt;">
-					Link to Eclipse download :
-					<span>
-						<a
-							href="http://www.eclipse.org/downloads/index.php">
-							http://www.eclipse.org/downloads/index.php
-						</a>
-					</span>
-				</span>
-			</p>
-			<p>
-				Getting Started documentation:
-						<a href="http://www.eclipse.org/downloads/index.php">
-							http://www.eclipse.org/downloads/index.php
-						</a>
-			</p>
-			<p>
-				To create the eclipse projects to use for SCA development:
-			</p>
-			<p>
-				1) When checking code out from subversion, checkout the
-					subversion trunk to a location outside your eclipse
-					workspace (it has to be outside because Eclipse will
-					not allow you to import projects from a location
-					overlapping with your workspace)
-			</p>
-			<p style="margin-left: 0.5in; text-indent: -0.25in;"><!--[if !supportLists]-->
-				2) Go to Import / Existing projects into workspace.
-					<span style="" />
-					Select either the runtime, spec, tools or samples
-					directory.
-					<span style="" />
-					The wizard proposes the list of Eclipse projects
-					under that directory. Importing the projects does
-					not copy the files; it just makes the files at that
-					location visible under an Eclipse project.
-			</p>
-			<p>
-				3) If you need to use Eclipse to edit files outside of
-					these projects (for example the etc directory, or
-					the maven files at the root of the trunk), then
-					delete the Eclipse projects, with the option to not
-					delete the files, and import the whole trunk as a
-					project.
-			</p>
-		</section>
-		<section name="Using Eclipse style templates">
-                 If you are using Eclpse, Tuscany has a preferred Java coding style. Please use the 
-                   <a href='http://svn.apache.org/repos/asf/incubator/tuscany/java/etc/tuscany-eclipse-codestyle.xml'>tuscany-eclipse-codestyle.xml</a> in Eclipse.
-                <br/>Download this file. <i>You may need to right click and save.</i> 
-                Then in Eclipse:<br/>
-                <pre>
-                Window->Preferences-&gt;Java-&gt;Code-Style-&gt;Formatter-&gt;Import...
-                <i>(Specify path and file to the tuscany-eclipse-codestyle.xml just downloaded. </i>
-                </pre>
-		</section>
-		<section name="Using Subclipse (optional)">
-			<p>
-				Install the Subversion Eclipse Plugin as described here:
-				<a href="http://subclipse.tigris.org/">http://subclipse.tigris.org/
-				</a>
-			</p>
-			<ol>
-				<li>
-				Open the SVN Repository Exploring perspective
-				</li>
-			
-				<li>
-				Right click in the SVN Repository view.
-				
-				</li>
-				<li>Select "New" and "Repository Location" 
-				
-				</li>
-				<li>
-				Url:
-					<a href="http://svn.apache.org/repos/asf/incubator/tuscany">
-					http://svn.apache.org/repos/asf/incubator/tuscany
-				</a>
-					<p>
-						Use URL https://svn.apache.org/repos/asf/incubator/tuscany if you
-						have committer rights and need to commit changes back to the repository.
-					</p>
-				</li>
-				<li>
-					Select the "Finish" button and allow Subclipse time to access the repository and
-					display its contents in the SVN Repository explorer.  Once the repository is displayed
-					in the explorer, you will see a number of subfolders displayed.  The ones that are
-					relevant are "java", "cpp" and "site" - which contain the Tuscany Java runtime, the
-					Tuscany C++ runtime and the Tuscany website material respectively.
-				</li>
-				<li>
-					Select the folder you want to check out as a project - one of java, cpp or site for example
-					Right click, select "Checkout" and "Checkout using new project wizard" - select the appropriate
-					options for your needs and then click "Finish"
-				</li>
-			</ol>
-			<p>
-				You can check in changes using the "Commit" item in the team submenu of the Java perspective.
-			</p>
-		</section>
-		<section name="Using IDEA style templates">
-                 If you are using IDEA IDE, Tuscany has a preferred Java coding style. Please use the 
-                   <a href='http://svn.apache.org/repos/asf/incubator/tuscany/java/etc/tuscany-idea-codestyle.xml'>tuscany-idea-codestyle.xml</a> in IDEA 
-                <br/>Download this file. <i>You may need to right click and save.</i> 
-                        <pre>
-                        copy tuscany-idea-codestyle.xml to ~/.IntelliJIdea50/config/codestyles
-                        File->Settings, Project Code Styles, Import
-                        </pre>
 		</section>
 		
 	</body>

Modified: incubator/tuscany/site/src/site/xdoc/installjava.xml
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/xdoc/installjava.xml?rev=406685&r1=406684&r2=406685&view=diff
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/installjava.xml (original)
+++ incubator/tuscany/site/src/site/xdoc/installjava.xml Mon May 15 10:14:35 2006
@@ -25,8 +25,8 @@
 	
 	<body>
 
-	<section name="installation instructions for java projects">
-	<p>this page describes what you need to know to install the java projects of tuscany.
+	<section name="Installation Instructions for JAVA projects">
+	<p>This page describes what is needed to install and run Tuscany SCA, SDO and DAS for Java.
 	</p>
 
 	<p>if you haven't already, the first step is to download the latest release of apache tuscany from our <a href="download.html">downloads</a> page.
@@ -34,16 +34,22 @@
 
 	</section>
 
-	<section name="system requirements">
+	<section name="System Requirements">
 		<p>in order to run the tuscany java projects there are some minimum system requirements</p>
 			<table style="text-align: left; width: 100%;" border="1"
 				cellpadding="2" cellspacing="2">
 				<tbody>
+					<tr> <!-- heading -->
+						<td><b>Software</b></td>
+						<td><b>Download Link</b></td>
+						<td><b>Download Instructions </b></td>
+					</tr>
 					<tr>
 						<td>jdk</td>
 						<td>
-                                                     <script type="text/javascript">linkNewWindow('http://java.sun.com/j2se/1.5.0/download.jsp','jdk 5.0');</script>
+							<script type="text/javascript">linkNewWindow('http://java.sun.com/j2se/1.5.0/download.jsp','jdk 5.0');</script> 
 						</td>
+						<td>Steps for Java setup is <a href="#setup JDK 5.0">here</a>.  </td>
 					</tr>
 					<tr>
 						<td>operating system</td>
@@ -52,25 +58,100 @@
 							<li>windows xp sp2</li>
 							<li>linux: red hat fedora core </li>
 						</ul>
-						</td>
+					</td>
+					<td></td>
 					</tr>
-					<tr>
-						<td>other components</td>
-						<td>
-                                                     <script type="text/javascript">linkNewWindow('http://tomcat.apache.org/','apache tomcat 5.5');</script>
-						</td>
-					</tr>
-				</tbody>
+					<tr> <!--mvn -->
+				        <td> Apache Maven 2.0.4  </td>
+				        <td><script type="text/javascript">linkNewWindow('http://maven.apache.org/download.html','Maven 2.04');</script> </td>
+					<td> 
+						You would use maven to build samples if you wish to. Instruction for downloading mave 2.0.4 and building samples is <a href="#setup maven">here</a>.
+				
+							</td>
+				</tr>				</tbody>
 			</table>
 	</section>
 
-	<section name="configuring apache tuscany">
-		<p>Detailed instructions on how to configure your Tomcat environment, or a Stand-Alone environment, 
- 		can be found in the 
-                    <script type="text/javascript">linkNewWindow('samples/java/docs/sampleSetup.htm','Samples README file');</script>
-                    </p>
-	</section>
+	
+	<a name="setup JDK 5.0"></a>
+<section name="Downloading and Installing the Java JDK 5.0"> 
+<ul>
+	<li>
+	Point your Web browser to   <script type="text/javascript">linkNewWindow('http://java.sun.com/j2se/1.5.0/download.jsp','jdk 5.0');</script>.
+	</li>
+	<li>
+	Select "Download JDK 5.0 Update 6". 
+	</li>
+	<li>
+	Accept the License agreement, then select Windows Online Installation, 
+	Multi-language - jdk-1_5_0_06-windows-i586-p-iftw.exe. </li>
+	<li>
+	Download jdk-1_5_0_06-windows-i586-p-iftw.exe to the C:\tuscany directory. 
+	</li>
+	<li>
+	From the command prompt do the following: 
+	<pre>
+	jdk-1_5_0_06-windows-i586-p-iftw.exe
+	This will run the JDK 5.0 Installation Wizard. Accept the License agreement, 
+	then proceed through the pages of the wizard. Accept all the default options. 
 
+	After a few minutes the installation will complete.
+        You should see the following: <br></br>
+       	<img alt="installation result" src="jdkinstall.jpg"/>
+
+	Press Finish to close the installation wizard. 
+	</pre> 
+	</li>
+	<li>
+	Create a new .bat file C:\tuscany\setenv.bat and add the following line: 
+	<pre>
+	set JAVA_HOME=C:\Program Files\Java\jdk1.5.0_06
+	</pre>
+	</li>
+</ul>
+</section>
+
+
+
+<a name="setup maven"></a>
+<section name ="Setup Maven and Build Samples">
+	<p>
+		<b> Download and Setup </b>
+	</p>
+<ul>
+	<li>
+		Point your Web browser to  <script type="text/javascript">linkNewWindow('http://maven.apache.org/download.html','http://maven.apache.org/download.html');</script>.
+	</li>
+	<li>	
+		Select "Maven 2.0.4 (zip) - maven-2.0.4-bin.zip".
+	</li>
+	<li>
+	Download maven-2.0.4-bin.zip to the C:\tuscany directory. 
+	</li>
+	<li>
+	From the command prompt do the following: 
+	<pre>
+		unzip maven-2.0.4-bin.zip
+	</pre>
+	This will extract Maven 2.0.4 to the C:\tuscany\maven-2.0.4 directory. 
+	</li>
+	<li>
+	Modify C:\tuscany\setenv.bat and add the following line: 
+	<pre>
+		set PATH=%PATH%;C:\tuscany\maven-2.0.4\bin
+	</pre>
+	</li>
+</ul>
+<p>
+	<b> Build Samples </b>
+	<br></br>
+		You are now ready to build samples. For example,  go to samples/sca/helloworld and issue the following command to build it. 
+		<br> </br>
+		<pre>
+			mvn 
+		</pre>
+	</p>
+</section>
 </body>
 
 

Modified: incubator/tuscany/site/src/site/xdoc/news.xml
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/xdoc/news.xml?rev=406685&r1=406684&r2=406685&view=diff
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/news.xml (original)
+++ incubator/tuscany/site/src/site/xdoc/news.xml Mon May 15 10:14:35 2006
@@ -34,10 +34,11 @@
 <br />
 Various community members will be presenting SCA, SDO. There is also a BOF session for Tuscany on Thursday.
 </p>  
-    <p><b>March 6 2006  --  A stable "milestone" build is available for both Java and C++ </b><br />
+    <p><b>March 6 2006  --  A stable level of source code is available for both Java and C++ </b><br />
 <br />
-To get Java build up and running on your system see the
-        <a href ="http://wiki.apache.org/ws/Tuscany/GetTuscany" target='_blank'>GetTuscany Wiki</a>. Use the following SVN checkout command:
+To get the Java project up and running on your system see the <script type="text/javascript">linkNewWindow('projectjava.html','Java Project Page');</script>.
+         <br></br>
+         Use the following SVN checkout command to get this version:
         <pre> svn co -r 383106   http://svn.apache.org/repos/asf/incubator/tuscany/java
         </pre>
         Highlights for the Java project in this build:

Added: incubator/tuscany/site/src/site/xdoc/patches.xml
URL: http://svn.apache.org/viewcvs/incubator/tuscany/site/src/site/xdoc/patches.xml?rev=406685&view=auto
==============================================================================
--- incubator/tuscany/site/src/site/xdoc/patches.xml (added)
+++ incubator/tuscany/site/src/site/xdoc/patches.xml Mon May 15 10:14:35 2006
@@ -0,0 +1,90 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+  Copyright (c) 2005 The Apache Software Foundation or its licensors, as applicable.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+ -->
+<document url="patches.xml">
+	<properties>
+		<author email="hmahbod@gmail.com">Haleh Mahbod</author>
+		<title>Apache Tuscany - Patches</title>
+	</properties>
+	<body>
+		<section name="Creating and Submitting a Patch">
+			Thank you for helping Tuscany project. Here are the steps to follow to create and submit a patch.
+			<ul>
+				<li>
+				<p>
+					<b> Check out the latest version </b> of source code from Subversion.
+				If you have a version checked out already,
+				do a fresh update before you make your changes. 
+				</p>
+				
+				<p>
+				You can find information about how to setup development environment <a href="projectjava.html"> for Java </a> or <a href="projectc++.html"> for C++ </a> here. 
+			 	</p>
+				</li>
+			       
+				<li> 
+				<p>
+					Please do a <b>full build with all tests enabled </b>. Try the following for Java projects:
+			        </p><p> 
+			        <code>
+				 
+					 maven -o clean new
+				 </code>
+			 	</p>
+			 	</li>
+			 
+				<li>
+				<p>
+					 <b>Confirm</b> that the problem is actually fixed and include a test case in the patch where possible.
+				 </p>
+				 </li>
+				 
+				 <li>
+				 <p>
+					 <b>Generate a patch</b> by issuing the following command from tuscany directory.   
+				 </p><p>
+				 <code>
+					 svn diff File >> patchfile
+				 </code>
+				 </p><p>
+				  Please try to give your patch files meaningful names. This helps the developer
+				  who applies a number of different patches. A recommendation is to use the JIRA 
+				  issue number as part of patch file name. For example
+			  	 </p>
+			  	 <p> 
+				 <code>
+					  svn diff File >> File312
+				  </code>
+				  <br></br>
+				  In this example, the number 312 is a JIRA issue number associated with this patch.
+			         </p>
+			        
+			  	</li>
+			
+				<li> 
+					<p> Add your patch file as an attachment to the JIRA issue that it is fixing.</p> 
+				<p>
+					Please include detailed steps to reproduce the problem in the issue description 
+					so that the patch can be properly verified after it is applied.
+				</p>
+			</li>
+			<li>
+				<p>Thank you! Your patch will be picked up for review. </p>
+			</li>
+		</ul>
+		</section>
+	</body>
+</document>