diff options
Diffstat (limited to 'site/trunk/site-publish/das-c-developer-guide.html')
| -rw-r--r-- | site/trunk/site-publish/das-c-developer-guide.html | 240 |
1 files changed, 240 insertions, 0 deletions
diff --git a/site/trunk/site-publish/das-c-developer-guide.html b/site/trunk/site-publish/das-c-developer-guide.html new file mode 100644 index 0000000000..f57142eae9 --- /dev/null +++ b/site/trunk/site-publish/das-c-developer-guide.html @@ -0,0 +1,240 @@ + +<!-- + + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You 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. +--> + + +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> +<HTML> + <HEAD> + <!-- generateKeywords macro --> + <META name="description" content="Apache Tuscany"> + <META name="keywords" content="apache, apache tuscany, tuscany, service, services, fabric, soa, service oriented architecture, sca, service component architecture, das, sdo, csa, ruby, opensource"> + <!-- generateKeywords macro end --> + + <LINK type="text/css" rel="stylesheet" href="http://tuscany.apache.org/stylesheets/default.css"> + <LINK rel="SHORTCUT ICON" href="https://cwiki.apache.org/confluence/pages/$images/favicon.ico"> + <TITLE>Apache Tuscany : DAS C++ Developer Guide</TITLE> + <META http-equiv="Content-Type" content="text/html;charset=UTF-8"></HEAD> + + <BODY onload="init()"> + <!-- topNav macro --> + <TABLE valign="top" border="0" cellspacing="0" cellpadding="0" width="100%" background="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg"> + <TR> + <TD valing="top" align="left"> + <A href="https://cwiki.apache.org/confluence/pages/$siteroot"><IMG src="http://tuscany.apache.org/images/TuscanyLogoNEW_Text_120px_bg.jpg" height="91" width="25" border="0"></A> + </TD> + <TD> + <A href="http://tuscany.apache.org/"><IMG src="http://tuscany.apache.org/images/TuscanyLogo.jpg" border="0"></A> + </TD> + + <TD width="100%"> + + </TD> + + <!-- Adds the edit page link to the top banner--> + <TD valign="bottom"> + <DIV style="padding: 2px 10px; margin: 0px;"> + <A href="https://cwiki.apache.org/confluence/pages/editpage.action?pageId=69440"> + <IMG src="http://tuscany.apache.org/images/notep_16.gif" height="16" width="16" border="0" align="absmiddle" title="Edit Page"></A> + </DIV> + </TD> + + </TR> + </TABLE> + <!-- topNav macro end --> + + <!-- breadCrumbs macro --> + <TABLE border="0" cellpadding="2" cellspacing="0" width="100%"> + <TR class="topBar"> + <TD align="left" valign="middle" class="topBarDiv" nowrap="true" width="100%"> + <A href="home.html" title="Apache Tuscany">Apache Tuscany</A> > <A href="home.html" title="Home">Home</A> > <A href="das-overview.html" title="DAS Overview">DAS Overview</A> > <A href="das-c.html" title="DAS C++">DAS C++</A> > <A href="das-c-documentation-menu.html" title="DAS C++ Documentation Menu">DAS C++ Documentation Menu</A> > <A href="" title="DAS C++ Developer Guide">DAS C++ Developer Guide</A> + </TD> + + <TD align="right" valign="middle" class="topBarDiv" align="left" nowrap="true"> + <A href="http://mail-archives.apache.org/mod_mbox/tuscany-user">User List</A> | <A href="http://mail-archives.apache.org/mod_mbox/tuscany-dev">Dev List</A> | <A href="http://issues.apache.org/jira/browse/Tuscany">Issue Tracker</A> + </TD> + </TR> + </TABLE> + <!-- breadCrumbs macro end --> + + + <TABLE border="0" cellpadding="0" width="100%" bgcolor="#FFFFFF"> + <TR> + <TD align="left" valign="top"> + + <!-- pageContent macro --> + <DIV id="PageContent"> + + <DIV class="pagecontent"> + <DIV class="wiki-content"> + <TABLE class="sectionMacro" border="0" cellpadding="5" cellspacing="0" width="100%"><TBODY><TR> +<TD class="confluenceTd" valign="top" width="15%"> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #C3CDA1;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #C3CDA1;background-color: #C3CDA1;"><B>General</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="home.html" title="Home">Home</A><BR> +<A href="http://www.apache.org/licenses/LICENSE-2.0.html" class="external-link" rel="nofollow">License </A><BR> +<A href="das-c-get-involved.html" title="DAS C++ Get Involved">Get Involved</A><BR> +<A href="das-c-found-a-bug.html" title="DAS C++ Found A Bug">Found a Bug?</A></P> +</DIV></DIV> +<DIV class="panel" style="background-color: #ECF4D1;border-color: #b4b4b5;border-style: solid;border-width: 1px;"><DIV class="panelHeader" style="border-bottom-width: 1px;border-bottom-style: solid;border-bottom-color: #b4b4b5;background-color: #C3CDA1;"><B>DAS C++</B></DIV><DIV class="panelContent" style="background-color: #ECF4D1;"> +<P><A href="das-c.html" title="DAS C++">DAS C++ Home</A><BR> +<A href="https://cwiki.apache.org/confluence/pages/createpage.action?spaceKey=TUSCANY&title=DAS%20C%2B%2B%20FAQ&linkCreation=true&fromPageId=56223" class="createlink">FAQ</A><BR> +<A href="das-c-releases.html" title="DAS C++ Releases">Downloads</A><BR> +<A href="das-c-documentation-menu.html" title="DAS C++ Documentation Menu">Documentation</A><BR> +<A href="https://svn.apache.org/repos/asf/tuscany/cpp/das" class="external-link" rel="nofollow">Source Code</A></P> +</DIV></DIV></TD> +<TD class="confluenceTd" valign="top" width="85%"> + +<H3><A name="DASC%2B%2BDeveloperGuide-HowtogetinvolvedindevelopmentofC%5CRDBDAS%3F"></A>How to get involved in development of C++ RDB DAS?</H3> + +<P>This document is the development guideline for C++ RDB DAS project.</P> +<UL> + <LI>General Guide</LI> + <LI>Getting Source code</LI> + <LI>Setting up your development environment</LI> + <LI>Importing DAS code and samples into your Development IDE</LI> + <LI>Testing</LI> + <LI>Reporting Issues and Providing patches</LI> +</UL> + + +<H3><A name="DASC%2B%2BDeveloperGuide-GeneralGuide"></A>General Guide</H3> + +<P>Welcome to the Tuscany RDB DAS C++ subproject project. We look forward to your participation and try to help you get on board. Feel free to ask your questions on the mailing list.</P> + +<P>Here are some general guidelines we use in this project.</P> +<UL> + <LI>C++ RDB DAS sub-project aims to provide enterprise-grade Data Access Service to help SOA applications using SDO have data updates with Database Data Source at backend.</LI> + <LI>C++ RDB DAS provides feedback to Tuscany SDO and Spec as it evolves.</LI> + <LI>The C++ RDB DAS provides flexibility in accessing data with explicit CRUD as well as using SDO DataObjects.</LI> + <LI>The C++ RDB DAS infrastructure is very modularized and is designed to be highly extensible so users can customize it to fit their needs.</LI> +</UL> + + +<H3><A name="DASC%2B%2BDeveloperGuide-GettingSourcecode"></A>Getting Source code</H3> + +<P>The C++ RDB DAS project Subversion repository is located at <A href="https://svn.apache.org/repos/asf/incubator/tuscany/cpp/das" class="external-link" rel="nofollow">https://svn.apache.org/repos/asf/incubator/tuscany/cpp/das</A> .<BR> +The repository can also be viewed online at <A href="http://svn.apache.org/viewvc/incubator/tuscany/cpp/das" class="external-link" rel="nofollow">http://svn.apache.org/viewvc/incubator/tuscany/cpp/das</A><BR> +Anyone can check code out of Subversion. You only need to specify a username and password in order to update the Subversion repository, and only Tuscany committers have the permissions to do so.</P> + +<H3><A name="DASC%2B%2BDeveloperGuide-CheckingoutcodefromSubversion"></A>Checking out code from Subversion</H3> + +<P>Use the command as follows (note that it uses http scheme so if you're a committer change it to https):</P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>svn checkout http://svn.apache.org/repos/asf/incubator/tuscany/cpp/das +</PRE> +</DIV></DIV> + +<H3><A name="DASC%2B%2BDeveloperGuide-CommittingChangestoSubversion"></A>Committing Changes to Subversion</H3> + +<P>Any Tuscany committer should have a shell account on svn.apache.org. Before you can commit, you'll need to set a Subversion password for yourself. To do that, log in to svn.apache.org and run the command svnpasswd.<BR> +Once your password is set, you can use a command like this to commit:</P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>svn commit +</PRE> +</DIV></DIV> +<P>If Subversion can't figure out your username, you can tell it explicitly:</P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>svn --username <name> commit +</PRE> +</DIV></DIV> +<P>Subversion will prompt you for a password, and once you've entered it, it will remember it for you. Note this is the password you configured with svnpasswd not your shell or other password.</P> + +<H3><A name="DASC%2B%2BDeveloperGuide-Buildtreestructure"></A>Build tree structure</H3> + +<P>The build tree is designed to facilitate modular development and releases. Maven modules are grouped by how they are released under a hierarchy. C++ RDB DAS currently have the below module hierarchy :</P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>-cpp + |-- das + |-- runtime DAS Source |-- source DAS Core Source Code |-- test DAS Test Cases Source Code + |-- samples DAS Sample Applications |-- VSExpress DAS Visual Studio Express Project Files +</PRE> +</DIV></DIV> + +<H3><A name="DASC%2B%2BDeveloperGuide-BuildingtheRDBDASsourcecodeissimple"></A>Building the RDB DAS source code is simple</H3> + +<P><B>Prerequisites</B></P> + +<P> - Apache Ant with CppTasks and Ant-Contrib<BR> + - Tuscany SDO latest version<BR> + - Visual Studio Express (optional)<BR> + </P> +<DIV class="preformatted panel" style="border-width: 1px;"><DIV class="preformattedContent panelContent"> +<PRE>cd cpp/das +ant +</PRE> +</DIV></DIV> +<P>More details about downloading and installing DAS can be found at <A href="http://svn.apache.org/repos/asf/incubator/tuscany/cpp/das/GettingStarted.html" class="external-link" rel="nofollow">http://svn.apache.org/repos/asf/incubator/tuscany/cpp/das/GettingStarted.html</A></P> + +<H3><A name="DASC%2B%2BDeveloperGuide-DevelopingRDBDASusingVisualStudioExpressIDE"></A>Developing RDB DAS using Visual Studio Express IDE</H3> + +<P>There is a VS solution file under cpp/das/VSExpress/tuscany_das/ that contains all configuration necessary to start developing DAS C++ with your Visual Studio Express.</P> +<H3><A name="DASC%2B%2BDeveloperGuide-Testing"></A>Testing</H3> + +<P>All commits are expected to be accompanied by test cases execution. Test cases should verify specific behavior relating to a single class or small set of related classes; integration tests verify code paths across subsystems. Test cases should be documented and clearly indicate what they verify. Also, avoid things that may cause side-effects when possible such as access of external resources. Test cases source code can be found at cpp/das/runtime/test/src/.</P> + + +<H3><A name="DASC%2B%2BDeveloperGuide-Reportingissuesandprovidingpatches"></A>Reporting issues and providing patches</H3> + +<P><B>Issue Tracking</B></P> + +<P>Tuscany bug reports are handled via a <A href="https://issues.apache.org/jira/browse/TUSCANY" class="external-link" rel="nofollow">JIRA</A> issues list. Please use this list to report any bugs and track their status.</P> + +<P><B>Reporting an Issue</B></P> + +<P>Please search JIRA to see if the problem has already been reported. If it has not, please create a new JIRA issue. To help developers quickly resolve an issue, include as much information with your report as possible such as your platform, version numbers, error logs, configuration, steps to reproduce the problem, etc. Also, if possible, please include a testcase that demonstrates the problem.<BR> +Thanks for working with us to improve Apache Tuscany.</P> + +<P><B>Submitting a Patch</B></P> + +<P>To submit a patch, create an issue in JIRA that describes the problem and attach your patch file. Please include detailed steps to reproduce the problem in the issue description. Providing test cases in the patch will help us verify and apply it quicker. To create a patch, follow the steps below:</P> +<UL> + <LI>Perform a full build with all tests enabled for the module the fix is for. Specific build procedures vary by sub-project.</LI> + <LI>Confirm that the problem is fixed and include testcases where possible</LI> + <LI>Generate the patch using svn diff File > patchfile</LI> + <LI>Try to give your patch files meaningful names, including the JIRA number</LI> + <LI>Add your patch file as an attachment to the associated JIRA issue<BR> +Once you have submitted the patch it will be picked up for review.</LI> +</UL> +</TD></TR></TBODY></TABLE> + </DIV> + </DIV> + </DIV> + <!-- pageContent macro end --> + + </TD> + </TR> + </TABLE> + + <!-- footer macro --> + <SCRIPT src="http://www.google-analytics.com/urchin.js" type="text/javascript"> + </SCRIPT> + <SCRIPT type="text/javascript"> + _uacct = "UA-1174707-5"; + urchinTracker(); + </SCRIPT> + + <A href="http://www.statcounter.com/" target="_blank"><IMG src="http://c26.statcounter.com/counter.php?sc_project=2619156&java=0&security=94bd7e7d&invisible=0" alt="website stats" border="0"></A> + + <DIV class="footer"> + Copyright � 2003-2012, The Apache Software Foundation </BR> + Apache Tuscany and the Apache Tuscany project logo are trademarks of The Apache Software Foundation. + </DIV> + <!-- footer macro end --> + + </BODY> +</HTML> |