cayenne-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From dkazimirc...@apache.org
Subject svn commit: r1186237 - /cayenne/site/cms/trunk/content/
Date Wed, 19 Oct 2011 14:16:28 GMT
Author: dkazimirchyk
Date: Wed Oct 19 14:16:27 2011
New Revision: 1186237

URL: http://svn.apache.org/viewvc?rev=1186237&view=rev
Log:
Apache CMS migration: site pages correction

Added:
    cayenne/site/cms/trunk/content/how-can-i-help.mdtext
    cayenne/site/cms/trunk/content/why-cayenne.mdtext
Removed:
    cayenne/site/cms/trunk/content/how-can-i-help?.mdtext
    cayenne/site/cms/trunk/content/why-cayenne?.mdtext
Modified:
    cayenne/site/cms/trunk/content/legacy-ant-documentation-export.mdtext
    cayenne/site/cms/trunk/content/legacy-ant-unit-tests.mdtext
    cayenne/site/cms/trunk/content/legacy-eclipse.mdtext
    cayenne/site/cms/trunk/content/mailing-lists.mdtext
    cayenne/site/cms/trunk/content/privacy-policy.mdtext
    cayenne/site/cms/trunk/content/release-guide.mdtext
    cayenne/site/cms/trunk/content/running-unit-tests.mdtext
    cayenne/site/cms/trunk/content/submit-patch.mdtext
    cayenne/site/cms/trunk/content/success-stories.mdtext

Added: cayenne/site/cms/trunk/content/how-can-i-help.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/how-can-i-help.mdtext?rev=1186237&view=auto
==============================================================================
--- cayenne/site/cms/trunk/content/how-can-i-help.mdtext (added)
+++ cayenne/site/cms/trunk/content/how-can-i-help.mdtext Wed Oct 19 14:16:27 2011
@@ -0,0 +1,23 @@
+Title: How can I help?
+<a name="HowcanIhelp?-HowCanIHelp?"></a>
+## How Can I Help?
+
+Every volunteer project gets its strength from its participants. We invite
+everybody interested to participate in Cayenne. If you are willing to help,
+this can be done in many different ways:
+
+* By contributing code.
+* By contributing documentation.
+* By testing Cayenne and reporting bugs.
+* By using Cayenne and reporting bugs.
+* By suggesting your own ideas on the mailing list and contributing code
+implementing them.
+
+If you want to contribute to Cayenne, first you should probably subscribe
+to developer mailing list to see what issues are discussed and to
+communicate with the project team. Code contributions are made via patches
+submitted via the the bug tracker. For more details read the Developer
+Guide that describes where the source code is, how to build it, etc.
+
+Read on to understand how to [submit a patch](submit-patch.html)
+.

Modified: cayenne/site/cms/trunk/content/legacy-ant-documentation-export.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/legacy-ant-documentation-export.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/legacy-ant-documentation-export.mdtext (original)
+++ cayenne/site/cms/trunk/content/legacy-ant-documentation-export.mdtext Wed Oct 19 14:16:27
2011
@@ -3,9 +3,8 @@ Prior to a release latest documentation 
 web service to a folder under subversion control
 *cayenne/cayenne-other/wiki-docs*. This can be done with Ant:
 
-
-    # ant doc -Dcayenne.confluence.user=username
--Dcayenne.confluence.password=secret
+    # cd cayenne/cayenne-ant
+    # ant doc -Dcayenne.confluence.user=username -Dcayenne.confluence.password=secret
     # cd ../cayenne-other
     ... add new pages ... remove deleted page ...
-    # svn commit -m "documentation export for release X.Y.Z"{noformat}
+    # svn commit -m "documentation export for release X.Y.Z"

Modified: cayenne/site/cms/trunk/content/legacy-ant-unit-tests.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/legacy-ant-unit-tests.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/legacy-ant-unit-tests.mdtext (original)
+++ cayenne/site/cms/trunk/content/legacy-ant-unit-tests.mdtext Wed Oct 19 14:16:27 2011
@@ -8,13 +8,12 @@ you must first [get Cayenne from SVN](co
 
 These properties can be passed to ant build via *-DpropName=value*.
 
-<table>
-<tr><th>Property</th><th>Description</th></tr>
-<tr><td>*cayenne.test.connection*</td><td>Named connection source
(see below)</td></tr>
-<tr><td>*test.filter*</td><td>Running a subset of tests (see below)</td></tr>
-<tr><td>*cayenne.test.schema.skip*</td><td>If "true", won't attempt
to recreate the test
-database, i.e. the database must already be present.</td></tr>
-</table>
+
+Property | Description
+---------|------------
+*cayenne.test.connection* | Named connection source (see below)
+*test.filter* | Running a subset of tests (see below)
+*cayenne.test.schema.skip* | If "true", won't attempt to recreate the test database, i.e.
the database must already be present.
 
 <a name="LegacyAntUnitTests-RunningAgainstEmbeddedHSQLDB"></a>
 ## Running Against Embedded HSQLDB
@@ -93,6 +92,5 @@ startup parameters can be used:
 
 
     # cd cayenne/cayenne-ant
-    # ant test -Dcayenne.test.connection=example1
--Dtest.filter="**/tools/*Tst.class"
+    # ant test -Dcayenne.test.connection=example1 -Dtest.filter="**/tools/*Tst.class"
 

Modified: cayenne/site/cms/trunk/content/legacy-eclipse.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/legacy-eclipse.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/legacy-eclipse.mdtext (original)
+++ cayenne/site/cms/trunk/content/legacy-eclipse.mdtext Wed Oct 19 14:16:27 2011
@@ -31,25 +31,12 @@ to the same workspace. You may skip proj
 not planning to use/change them.
 
 
-<table>
-<tr><th>Project Folder</th><th>JVM</th><th>Special Setup</th><th>Notes</th></tr>
-<tr><th>*/cayenne-java*</td><td>1.4.x</td><td>n/a</td><td>Eclipse
project containing main Cayenne
-source and library folders. Source and binary compatibility must be set to
-JDK 1.4.</td></tr>
-<tr><th>*/cayenne-java-1.5*</td><td>1.5.x</td><td>*JRE_LIB_15*
variable</td><td>Eclipse project
-containing Cayenne JDK 1.5 specific code. Requires "cayenne-java"
-</tr>
-project to be present in workspace. Source and binary compatibility must be
-set to JDK 1.5.|
-<tr><th>*/cayenne-other*</td><td>1.5.x</td><td>*JRE_LIB_15*
variable</td><td>Optional Eclipse project
-that contains Cayenne documentation, contrib folders and such.
-</tr>
-<tr></tr>
-<tr><th>*/cayenne-ant*</td><td>n/a</td><td>n/a</td><td>Eclipse
project with Ant build files to build
-the entire Cayenne workspace. Needed if you are planning to build Cayenne
-with Ant outside of Eclipse (i.e. to create JAR files or run a test
-suite).</td></tr>
-</table>
+Project Folder | JVM | Special Setup | Notes
+---------------|-----|---------------|------
+*/cayenne-java* | 1.4.x | n/a | Eclipse project containing main Cayenne source and library
folders. Source and binary compatibility must be set to JDK 1.4.
+*/cayenne-java-1.5* | 1.5.x | *JRE_LIB_15* variable | Eclipse projectcontaining Cayenne JDK
1.5 specific code. Requires "cayenne-java" project to be present in workspace. Source and
binary compatibility must be set to JDK 1.5.
+*/cayenne-other* | 1.5.x | *JRE_LIB_15* variable | Optional Eclipse project that contains
Cayenne documentation, contrib folders and such.
+*/cayenne-ant* | n/a | n/a | Eclipse project with Ant build files to build the entire Cayenne
workspace. Needed if you are planning to build Cayenne with Ant outside of Eclipse (i.e. to
create JAR files or run a test suite).
 
 There are also various tutorials in "cayenne" folder that are not needed to
 build the framework or the tools.

Modified: cayenne/site/cms/trunk/content/mailing-lists.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/mailing-lists.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/mailing-lists.mdtext (original)
+++ cayenne/site/cms/trunk/content/mailing-lists.mdtext Wed Oct 19 14:16:27 2011
@@ -9,18 +9,18 @@ This is a general discussion and support
 primary source of free Cayenne support. It is also a place for general
 discussion of Cayenne-related topics.
 
-To subscribe send empty email to user-subscribe@cayenne.apache.org
-To unsubscribe send empty email to user-unsubscribe@cayenne.apache.org
+To subscribe send empty email to user-subscribe@cayenne.apache.org  
+To unsubscribe send empty email to user-unsubscribe@cayenne.apache.org  
 To post a message use the following address: user@cayenne.apache.org
 
 * Apache Message Archive:
-http://mail-archives.apache.org/mod_mbox/cayenne-user/
-* Gmane Archive: http://dir.gmane.org/gmane.comp.java.cayenne.user
+[http://mail-archives.apache.org/mod_mbox/cayenne-user/](http://mail-archives.apache.org/mod_mbox/cayenne-user/)
+* Gmane Archive: [http://dir.gmane.org/gmane.comp.java.cayenne.user](http://dir.gmane.org/gmane.comp.java.cayenne.user)
 * Markmail Archive:
-http://cayenne.markmail.org/search/+list:org.apache.cayenne.user
+[http://cayenne.markmail.org/search/+list:org.apache.cayenne.user](http://cayenne.markmail.org/search/+list:org.apache.cayenne.user)
 * ObjectStyle.org Archive (legacy, does not store new messages, but has
 very old messages not available elsewhere)  :
-http://objectstyle.org/cayenne/lists/cayenne-user/
+[http://objectstyle.org/cayenne/lists/cayenne-user/](http://objectstyle.org/cayenne/lists/cayenne-user/)
 
 <a name="Mailinglists-Dev"></a>
 ### Dev
@@ -32,18 +32,18 @@ for all Cayenne commiters to subscribe t
 subscribe and participate if they are interested in the topics discussed
 here.
 
-To subscribe send empty email to dev-subscribe@cayenne.apache.org
-To unsubscribe send empty email to dev-unsubscribe@cayenne.apache.org
+To subscribe send empty email to dev-subscribe@cayenne.apache.org  
+To unsubscribe send empty email to dev-unsubscribe@cayenne.apache.org  
 To post a message use the following address: dev@cayenne.apache.org
 
 * Apache Message Archive:
-http://mail-archives.apache.org/mod_mbox/cayenne-dev/
-* Gmane Archive: http://dir.gmane.org/gmane.comp.java.cayenne.devel
+[http://mail-archives.apache.org/mod_mbox/cayenne-dev/](http://mail-archives.apache.org/mod_mbox/cayenne-dev/)
+* Gmane Archive: [http://dir.gmane.org/gmane.comp.java.cayenne.devel](http://dir.gmane.org/gmane.comp.java.cayenne.devel)
 * Markmail Archive:
-http://cayenne.markmail.org/search/+list:org.apache.cayenne.dev
+[http://cayenne.markmail.org/search/+list:org.apache.cayenne.dev](http://cayenne.markmail.org/search/+list:org.apache.cayenne.dev)
 * ObjectStyle.org Archive (legacy, does not store new messages, but has
 very old messages not available elsewhere) :
-http://objectstyle.org/cayenne/lists/cayenne-devel/
+[http://objectstyle.org/cayenne/lists/cayenne-devel/](http://objectstyle.org/cayenne/lists/cayenne-devel/)
 
 <a name="Mailinglists-Commits"></a>
 ### Commits
@@ -52,13 +52,13 @@ commits is a mailing list that receives 
 messages. You can subscribe to this list to keep track of changes to the
 Cayenne SVN repository.
 
-To subscribe send empty email to commits-subscribe@cayenne.apache.org
+To subscribe send empty email to commits-subscribe@cayenne.apache.org  
 To unsubscribe send empty email to commits-unsubscribe@cayenne.apache.org
 
 * Message Archive:
-http://mail-archives.apache.org/mod_mbox/cayenne-commits/
+[http://mail-archives.apache.org/mod_mbox/cayenne-commits/](http://mail-archives.apache.org/mod_mbox/cayenne-commits/)
 * Markmail Archive:
-http://cayenne.markmail.org/search/+list:org.apache.cayenne.commits
+[http://cayenne.markmail.org/search/+list:org.apache.cayenne.commits](http://cayenne.markmail.org/search/+list:org.apache.cayenne.commits)
 
 <a name="Mailinglists-Otherresources"></a>
 ### Other resources

Modified: cayenne/site/cms/trunk/content/privacy-policy.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/privacy-policy.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/privacy-policy.mdtext (original)
+++ cayenne/site/cms/trunk/content/privacy-policy.mdtext Wed Oct 19 14:16:27 2011
@@ -10,8 +10,8 @@ following:
 1. The addresses of pages from where you followed a link to our site.
 
 Part of this information is gathered using a tracking cookie set by the [Google Analytics](http://www.google.com/analytics/)
- service and handled by Google as described in their [privacy policy|http://www.google.com/privacy.html]
-. See your browser documentation for instructions on how to disable the
+ service and handled by Google as described in their [privacy policy](http://www.google.com/privacy.html).
+See your browser documentation for instructions on how to disable the
 cookie if you prefer not to share this data with Google.
 
 We use the gathered information to help us make our site more useful to

Modified: cayenne/site/cms/trunk/content/release-guide.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/release-guide.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/release-guide.mdtext (original)
+++ cayenne/site/cms/trunk/content/release-guide.mdtext Wed Oct 19 14:16:27 2011
@@ -10,7 +10,7 @@ are also available for evaluation during
 
 * A release manager must have his public key appended to the KEYS file
 checked in to SVN and the key published on one of the public key servers.
-More info can be found at http://www.apache.org/dev/release-signing.html
+More info can be found at [http://www.apache.org/dev/release-signing.html](http://www.apache.org/dev/release-signing.html)
 
 * Make sure "apache-releases" repository is configured in
 *~/.m2/settings.xml* and an appropriate password is setup. See [this page](http://www.apache.org/dev/publishing-maven-artifacts.html)
@@ -19,8 +19,7 @@ More info can be found at http://www.apa
 <a name="ReleaseGuide-PreparingSources"></a>
 ## Preparing Sources
 
-* Export and commit the latest documentation per [Documentation Guidelines](documentation-guidelines.html)
-.
+* Export and commit the latest documentation per [Documentation Guidelines](documentation-guidelines.html).
 
 * Edit UPGRADE-NOTES.txt if there is anything to add there.
 
@@ -30,39 +29,38 @@ checking the release files for ASF licen
 download the jar _(we are using version 0.5.1)_, and run it against
 unpacked distro (or the release tag), read the report and fix any issues.
 
-
-    mvn clean
-    java -jar rat-0.5.1.jar `pwd` > report.txt{noformat}
+        cd cayenne
+        mvn clean
+        java -jar rat-0.5.1.jar `pwd` > report.txt
     
-    h2. Tagging the Repo and Releasing Maven Artifacts 
+## Tagging the Repo and Releasing Maven Artifacts 
     
-    * Get a trunk SVN checkout of Cayenne. If you are using {{git}} for
+* Get a trunk SVN checkout of Cayenne. If you are using *git* for
 development, SVN checkout is still needed to prepare a release with
-{{maven-release-plugin}}. 
+*maven-release-plugin*. 
     
-
+        svn co https://svn.apache.org/repos/asf/cayenne/main/trunk cayenne
 
 * Tag the SVN and Create Maven Staging Repository
 
-
-    mvn release:clean
-    mvn release:prepare -DpreparationGoals="clean install"
--DautoVersionSubmodules=true -Passembly,generic,mac,windows{noformat}
+        cd cayenne
+        mvn release:clean
+        mvn release:prepare -DpreparationGoals="clean install" -DautoVersionSubmodules=true
-Passembly,generic,mac,windows
     
-    A problem [described in the documentation|http://www.apache.org/dev/publishing-maven-artifacts.html#prepare-release]
+    A problem [described in the documentation](http://www.apache.org/dev/publishing-maven-artifacts.html#prepare-release)
  consistently occurs here ... if you are in Europe: "If you're located in
 Europe then release:prepare may fail with 'Unable to tag SCM' and ' svn: No
 such revision X '. Wait 10 seconds and run mvn release:prepare again." It
 fails indeed, and requires a re-run and continue:
     
+        mvn release:perform -P gpg [-Dgpg.keyname=B8AF90BF]
 
-
-* Close the staging repo. Login to https://repository.apache.org/ with
+* Close the staging repo. Login to [https://repository.apache.org/](https://repository.apache.org/)
with
 Apache ID/password, go to "Staging Repositories" page. Select a staging
 repository that was just created during "*mvn release:perform*", click
 "Close". Take a note of the freshly created staging repository URL. It will
 be used by the people voting on Cayenne. It may look like this:
-https://repository.apache.org/content/repositories/orgapachecayenne-052/ 
+[https://repository.apache.org/content/repositories/orgapachecayenne-052/](https://repository.apache.org/content/repositories/orgapachecayenne-052/)

 
 <a name="ReleaseGuide-ReleasingDownloadableAssemblies"></a>
 ## Releasing Downloadable Assemblies
@@ -72,33 +70,32 @@ https://repository.apache.org/content/re
 * Build source package (it will be the basis for the binary packages built
 in the next steps) :
 
-
+        mvn clean install -Passembly,src
     
-    
-    * Build binary assemblies. Take
-{{"assembly/target/cayenne-XXX-src.tar.gz"}}, unpack it somewhere, and
+* Build binary assemblies. Take
+*"assembly/target/cayenne-XXX-src.tar.gz"*, unpack it somewhere, and
 perform binary builds from the unpacked directory (NOT FROM SVN OR GIT
 CHECKOUT). _Release manager may skip running unit tests from here, as shown
-below, although release evaluators should use the src assembly for [unit testing|Running
Unit Tests]
+below, although release evaluators should use the src assembly for [unit testing](running-unit-tests.html)
  and other kinds of testing._ 
     
+        mvn clean install -Passembly,generic -Dmaven.test.skip=true
 
+        mvn clean install -Passembly,mac -Dmaven.test.skip=true
 
+        mvn clean install -Passembly,windows -Dmaven.test.skip=true
 
-
-For further details on a general Cayenne build process check [this page](building-cayenne.html)
-.
+    For further details on a general Cayenne build process check [this page](building-cayenne.html).
 
 * Signing assemblies
 
-For more info visit [this page](http://www.apache.org/dev/release-signing.html)
+    For more info visit [this page](http://www.apache.org/dev/release-signing.html)
 . Release manager key must be in the project KEYS file. Signing is a manual
 procedure not included in the Ant or Maven script. Here is how it might
 work ("-u" option can be omitted if you have only one GPG key):
 
-
-    gpg --print-md MD5 cayenne-X.X.tar.gz > cayenne-X.X.tar.gz.md5
-
+        gpg --armor -u B8AF90BF --output cayenne-X.X.tar.gz.asc --detach-sig cayenne-X.X.tar.gz
+        gpg --print-md MD5 cayenne-X.X.tar.gz > cayenne-X.X.tar.gz.md5
 
 * Assemblies, signature and checksum files are uploaded to the release
 manager's web directory on *people.apache.org*.
@@ -129,40 +126,42 @@ the equivalent source). 
 <a name="ReleaseGuide-PublishingtheRelease"></a>
 ## Publishing the Release
 
-* Publish Maven artifacts. Go back to https://repository.apache.org/ ,
+* Publish Maven artifacts. Go back to [https://repository.apache.org/](https://repository.apache.org/),
 select the staging repo and click "Release".
 
 * Publish downloadable assemblies:
 
-
-    % cp /path/to/release/artifacts /www/www.apache.org/dist/cayenne/{noformat}
+        $ ssh people.apache.org
+        % cp /path/to/release/artifacts /www/www.apache.org/dist/cayenne/{noformat}
     
     
-    h2. After the release
+<a name="ReleaseGuide-AftertheRelease"></a>
+## After the release
     
-    * [Tell Jira|https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310903]
+* [Tell Jira](https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12310903)
  that the release has been released. Ensure there is another milestone or
 release target already created for further work, but this was probably
 already done when a branch was created in preparation for release.
-    * Update the [DOAP file|http://svn.apache.org/repos/asf/cayenne/site/trunk/tlp-site/src/doap/cayenne.rdf]
+* Update the [DOAP file](http://svn.apache.org/repos/asf/cayenne/site/trunk/tlp-site/src/doap/cayenne.rdf)
  (held in the Cayenne svn) which will update
 http://projects.apache.org/projects/cayenne.html automatically
-    * Update Freshmeat with new release number
-(http://freshmeat.net/projects/cayenne/)
-    * If the release is significant, consider press releases to relevant news
+* Update Freshmeat with new release number
+([http://freshmeat.net/projects/cayenne/](http://freshmeat.net/projects/cayenne/))
+* If the release is significant, consider press releases to relevant news
 sources
-    * Review the main website pages (front page and why-cayenne especially) to
+* Review the main website pages (front page and why-cayenne especially) to
 add any new features
-    * Add a news item to the Cayenne web site
-    * Send an email to the Cayenne user and developer lists
-    * Send a notification email to announceATapachenews.org
-    * Update http://en.wikipedia.org/wiki/Apache_Cayenne
-    
-    h2. Reference:
-    
-    * Apache release publishing:
-http://www.apache.org/dev/release-publishing.html
-    * Apache Maven release publishing:
-http://www.apache.org/dev/publishing-maven-artifacts.html
-    * ARAT: http://code.google.com/p/arat/
-    * Signing Releases: http://www.apache.org/dev/release-signing.html
+* Add a news item to the Cayenne web site
+* Send an email to the Cayenne user and developer lists
+* Send a notification email to announceATapachenews.org
+* Update [http://en.wikipedia.org/wiki/Apache_Cayenne](http://en.wikipedia.org/wiki/Apache_Cayenne)
+    
+<a name="ReleaseGuide-Reference"></a>
+## Reference:
+    
+* Apache release publishing:
+[http://www.apache.org/dev/release-publishing.html](http://www.apache.org/dev/release-publishing.html)
+* Apache Maven release publishing:
+[http://www.apache.org/dev/publishing-maven-artifacts.html](http://www.apache.org/dev/publishing-maven-artifacts.html)
+* ARAT: [http://code.google.com/p/arat/](http://code.google.com/p/arat/)
+* Signing Releases: [http://www.apache.org/dev/release-signing.html](http://www.apache.org/dev/release-signing.html)

Modified: cayenne/site/cms/trunk/content/running-unit-tests.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/running-unit-tests.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/running-unit-tests.mdtext (original)
+++ cayenne/site/cms/trunk/content/running-unit-tests.mdtext Wed Oct 19 14:16:27 2011
@@ -10,73 +10,72 @@ On some systems (e.g. Ubuntu 8.x) the fo
 *"~/.mavenrc"* or otherwise there will be test failures in the unit tests
 relying on JGroups. This is a workaround of a known JVM bug:
 
-
+    MAVEN_OPTS="-Djava.net.preferIPv4Stack=true"
     
     
-    h2. Running Against Embedded HSQLDB
+## Running Against Embedded HSQLDB
     
-    No extra setup is required. Just run Maven:
+No extra setup is required. Just run Maven:
     
-
-$ mvn install{noformat}
+    $ cd cayenne
+    $ mvn install{noformat}
 
 or 
 
-
-    $ mvn clean test{noformat}
+    $ cd cayenne
+    $ mvn clean test
     
-    h2. Running Against a Specific Database
+## Running Against a Specific Database
     
-    h4. Step 1. Install JDBC Driver Jars in a Local Maven Repo
+#### Step 1. Install JDBC Driver Jars in a Local Maven Repo
     
-    Most commercial drivers are not present in the public Maven repositories.
+Most commercial drivers are not present in the public Maven repositories.
 So they have to be installed by the tester locally. The group and artifact
 ids are arbitrarily assigned in the main Cayenne POM, so users must follow
 the POM or the examples below.
     
-    *FrontBase:*
+**FrontBase:**
 
-       -DartifactId=frontbase-driver -Dversion=4.1 -Dpackaging=jar
--DgeneratePom=true{noformat}
+    $ mvn install:install-file -Dfile=frontbasejdbc.jar -DgroupId=com.frontbase \
+           -DartifactId=frontbase-driver -Dversion=4.1 -Dpackaging=jar -DgeneratePom=true
 
-*OpenBase:*
+**OpenBase:**
 
-           -DartifactId=openbase-driver -Dversion=9 -Dpackaging=jar
--DgeneratePom=true{noformat}
+    $ mvn install:install-file -Dfile=OpenBaseJDBC.jar -DgroupId=com.openbase \
+           -DartifactId=openbase-driver -Dversion=9 -Dpackaging=jar -DgeneratePom=true
     
-    *Oracle:*
+**Oracle:**
 
-       -DartifactId=oracle-driver -Dversion=11 -Dpackaging=jar
--DgeneratePom=true{noformat}
+    $ mvn install:install-file -Dfile=ojdbc5.jar -DgroupId=com.oracle \
+           -DartifactId=oracle-driver -Dversion=11 -Dpackaging=jar -DgeneratePom=true
 
-*SQLite:*
+**SQLite:**
 
-           -DartifactId=sqlite-driver -Dversion=0.56 -Dpackaging=jar
--DgeneratePom=true{noformat}
+    $ mvn install:install-file -Dfile=sqlitejdbc-v056.jar -DgroupId=org.sqlite \
+           -DartifactId=sqlite-driver -Dversion=0.56 -Dpackaging=jar -DgeneratePom=true
     
-    *SQLServer:*
-
-       -DartifactId=sqlserver-driver -Dversion=2.0 -Dpackaging=jar
--DgeneratePom=true{noformat}
+**SQLServer:**
 
+    $ mvn install:install-file -Dfile=sqljdbc.jar -DgroupId=com.microsoft \
+           -DartifactId=sqlserver-driver -Dversion=2.0 -Dpackaging=jar -DgeneratePom=true
 
-*Sybase:*
+**Sybase:**
 
-           -DartifactId=sybase-driver -Dversion=12 -Dpackaging=jar
--DgeneratePom=true{noformat}
+    $ mvn install:install-file -Dfile=jconn3.jar -DgroupId=com.sybase \
+           -DartifactId=sybase-driver -Dversion=12 -Dpackaging=jar -DgeneratePom=true
     
-    h4. Step 2. Run Tests Against Configured Data Source
+#### Step 2. Run Tests Against Configured Data Source
     
-    Database type and connection information can be specified either on the
+Database type and connection information can be specified either on the
 command line or via a configuration file. First let's look at the command
 line options:
     
-
-   -DcayenneAdapter=org.apache.cayenne.dba.mysql.MySQLAdapter \
-   -DcayenneJdbcUsername=myuser \
-   -DcayenneJdbcPassword=mypassword \
-   -DcayenneJdbcUrl=jdbc:mysql://localhost/cayenne \
-   -DcayenneJdbcDriver=com.mysql.jdbc.Driver{noformat}
+    $ mvn test -DcayenneTestConnection=<profile_name> \
+       -DcayenneAdapter=org.apache.cayenne.dba.mysql.MySQLAdapter \
+       -DcayenneJdbcUsername=myuser \
+       -DcayenneJdbcPassword=mypassword \
+       -DcayenneJdbcUrl=jdbc:mysql://localhost/cayenne \
+       -DcayenneJdbcDriver=com.mysql.jdbc.Driver
 
 *cayenneTestConnection* is a property activating a DB-specific Maven
 profile. *<profile_name>* can be one of:
@@ -97,7 +96,7 @@ create a directory *$HOME/.cayenne/* and
 *connection.properties* in this directory. File contents should be
 similar to this example:
 
-
+    mysql.cayenne.adapter = org.apache.cayenne.dba.mysql.MySQLAdapter
     mysql.jdbc.username = someuser
     mysql.jdbc.password = somepasswd
     mysql.jdbc.url = jdbc:someurl1
@@ -107,18 +106,18 @@ similar to this example:
     oracle.jdbc.username = someuser
     oracle.jdbc.password = somepasswd
     oracle.jdbc.url = jdbc:someurl2
-    oracle.jdbc.driver = com.xyz.MyDriverClass{noformat}
+    oracle.jdbc.driver = com.xyz.MyDriverClass
     
-    Each property starts with the Maven profile name ("mysql" and "oracle" in
+Each property starts with the Maven profile name ("mysql" and "oracle" in
 the example above). Note that in this case you should still use
-{{cayenneTestConnection}}. E.g.:
+*cayenneTestConnection*. E.g.:
     
+    $ mvn test -DcayenneTestConnection=derby
 
-
-{note}If you are testing Cayenne 3.0, use -Dcayenne.test.connection instead
+> **Note.** _If you are testing Cayenne 3.0, use -Dcayenne.test.connection instead
 of -DcayenneTestConnection. Also it is only possible to pass the DB
 properties via "connection.properties" file, and not possible to pass them
-on command line{note} 
+on command line_
 
 <a name="RunningUnitTests-Lookattestresults"></a>
 ## Look at test results

Modified: cayenne/site/cms/trunk/content/submit-patch.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/submit-patch.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/submit-patch.mdtext (original)
+++ cayenne/site/cms/trunk/content/submit-patch.mdtext Wed Oct 19 14:16:27 2011
@@ -1,17 +1,21 @@
 Title: Submit Patch
 A normal procedure for accepting contributions from non-committers is via
-*patches* submitted through Cayenne [bug tracker](http://issues.apache.org/jira/browse/CAY)
-. "Patch" is a text file in a standard format generated by the UNIX {{"diff
--u"}} command and applied using UNIX *"patch"* command. Subversion, CVS,
+**patches** submitted through Cayenne [bug tracker](http://issues.apache.org/jira/browse/CAY)
+. "Patch" is a text file in a standard format generated by the UNIX *"diff
+-u"* command and applied using UNIX *"patch"* command. Subversion, CVS,
 Eclipse and many other tools support this format (in Eclipse you can both
 generate and apply standard patches). A general procedure as applied to
 Cayenne can look as follows:
 
 1. [Check out the code from Subversion](code-repository.html)
-1. Make your changes
-1. Generate a patch (make sure that it includes all new files, e.g. by doing
+
+2. Make your changes
+
+3. Generate a patch (make sure that it includes all new files, e.g. by doing
 "svn status" and adding all new files via "svn add") :
 
-    $ svn diff > patch.txt{noformat} 
-    # Open a Jira issue and attach the patch file (patch.txt in this example)
+        $ cd cayenne
+        $ svn diff > patch.txt
+
+4. Open a Jira issue and attach the patch file (patch.txt in this example)
 to it.

Modified: cayenne/site/cms/trunk/content/success-stories.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/success-stories.mdtext?rev=1186237&r1=1186236&r2=1186237&view=diff
==============================================================================
--- cayenne/site/cms/trunk/content/success-stories.mdtext (original)
+++ cayenne/site/cms/trunk/content/success-stories.mdtext Wed Oct 19 14:16:27 2011
@@ -8,7 +8,7 @@ please drop a note to cayenne-user list 
 objectstyle.org".
 
 <a name="Successstories-AccessPointInc.(http://www.accesspointinc.com/)"></a>
-### AccessPoint Inc. (http://www.accesspointinc.com/)
+### AccessPoint Inc. (<http://www.accesspointinc.com/>)
 
 A story submitted by Bret Gregory: "I work for AccessPoint Inc., a
 privately-held CLEC offering integrated communications services to small-
@@ -20,7 +20,7 @@ These applications and thus Cayenne are 
 the company."
 
 <a name="Successstories-GlobalLegalInformationNetwork(GLIN)(http://www.glin.gov/)"></a>
-### Global Legal Information Network (GLIN) (http://www.glin.gov/)
+### Global Legal Information Network (GLIN) (<http://www.glin.gov/>)
 
 GLIN is a legal repository for the Law Library of Congress. It has been
 around for 30 years, and in digital form since the early 90s. However, it
@@ -34,7 +34,7 @@ becoming the most internationalized site
 the IRS.
 
 <a name="Successstories-ishonCourse(http://www.ish.com.au/oncourse)"></a>
-### ish onCourse (http://www.ish.com.au/oncourse)
+### ish onCourse (<http://www.ish.com.au/oncourse>)
 
 A story submitted by Aristedes Maniatis, ish owner: "Written for the
 education sector, ish onCourse is a student and enrolment tracking system
@@ -46,7 +46,7 @@ and paging in Cayenne for the applicatio
 links."
 
 <a name="Successstories-NationalHockeyLeague(http://www.nhl.com/)"></a>
-### National Hockey League (http://www.nhl.com/)
+### National Hockey League (<http://www.nhl.com/>)
 
 NHL was one of the first large-scale Cayenne deployments. After the initial
 trial of Cayenne in 2002, NHL switched all their web applications to
@@ -67,7 +67,7 @@ Architecture. ObjectVisualizer has a Cay
 mapping projects.
 
 <a name="Successstories-PixxuresInc.(http://www.pixxures.ca/)"></a>
-### Pixxures Inc. (http://www.pixxures.ca/)
+### Pixxures Inc. (<http://www.pixxures.ca/>)
 
 Pixxures Inc. is the world's largest provider of digital mapping products,
 services, and online delivery capabilities. Pixxures used Cayenne to create
@@ -82,12 +82,12 @@ methods.
 
 Two leading local search sites for Croatia and Bosnia and Herzegovina are
 using Cayenne to store and retrieve indexed data for blog search engine:
-http://www.pogodak.hr/index.jsp?tab=blog and
-http://www.pogodak.ba/index.jsp?tab=blog. There are plans to switch to
+<http://www.pogodak.hr/index.jsp?tab=blog> and
+<http://www.pogodak.ba/index.jsp?tab=blog>. There are plans to switch to
 Cayenne similar sites for Slovenia, Serbia and Macedonia.
 
 <a name="Successstories-ProvestaWonen(http://www.provesta.nl/)"></a>
-### Provesta Wonen (http://www.provesta.nl/)
+### Provesta Wonen (<http://www.provesta.nl/>)
 
 Provesta Wonen is a semi-government housing company. It rents houses to
 people who need them. Cayenne is a part of the engine for using and reusing
@@ -96,15 +96,15 @@ on that information can appoint the imag
 complexes (collection of addresses).
 
 <a name="Successstories-RossoAlice(http://www.rossoalice.it/)"></a>
-### RossoAlice (http://www.rossoalice.it/)
+### RossoAlice (<http://www.rossoalice.it/>)
 
 RossoAlice is an Italian media portal. This is a site where users can
 download music, watch films, download games, watch television news and
 more. The Java database layer for the authentication / authorization
 component is developed with Cayenne.
 
-h3. Unilever (http://www.unilever-bilddatenbank.de/), Ascensys
-(http://www.ascensys.de/)
+<a name="Successstories-Unilever(http://www.rossoalice.it/)"></a>
+### Unilever (<http://www.unilever-bilddatenbank.de/>), Ascensys (<http://www.ascensys.de/>)
 
 Ascensys developed a new media management system for Unilever Germany using
 Cayenne. The software supports internal planning processes, provides the

Added: cayenne/site/cms/trunk/content/why-cayenne.mdtext
URL: http://svn.apache.org/viewvc/cayenne/site/cms/trunk/content/why-cayenne.mdtext?rev=1186237&view=auto
==============================================================================
--- cayenne/site/cms/trunk/content/why-cayenne.mdtext (added)
+++ cayenne/site/cms/trunk/content/why-cayenne.mdtext Wed Oct 19 14:16:27 2011
@@ -0,0 +1,55 @@
+Title: Why Cayenne?
+Cayenne is a Java _object relational mapping (ORM) framework_.	In other
+words, it is a tool for Java developers who need to talk to a database (or
+many databases).  Rather than hardcoding SQL statements through Java code,
+Cayenne allows a programmer to work only with Java objects abstracted from
+the database.  Here are just a few benefits of the Cayenne approach to
+persistence:
+
+* Portability between almost any [database](caydoc:database-support.html)
+ that has a JDBC driver without changing a single line of code in your
+application.
+* No knowledge of SQL is required (while it still can be helpful).
+* Code which validates any data committed to the database is easy to write
+and foolproof in operation.  This might be as simple as ensuring passwords
+have enough characters, or a complex check on the validity of a set of
+accounting operations in a general ledger transaction.	This allows you to
+move common error checking code out of the GUI layer and provides valuable
+protection against programming mistakes.
+* Caching in order to make your application faster and avoid repeated hits
+on the database for the same data.
+* Automatic faulting (lazy loading) of relationships, but easily supports
+prefetching of related data for improved performance when needed.
+* Pagination which reduces bandwidth and query times by only loading the
+contents of objects when they are actually needed.  The classic example of
+paging, which differs from faulting, is when a query returns 97 records,
+and you want to display 10 at-a-time to the user.  With paging, only the
+first 10 records are fully loaded.  Cayenne will automatically load only
+the page of records as they are requested.
+* Configurable optimistic locking to ensure data integrity and prevent
+unexpected data issues when another tool has changed the database behind
+the scenes (such as a maintainer updating a record in the database while a
+Cayenne-based application had the same record loaded to make changes).
+* A GUI-based database/schema modeler to simplify learning Cayenne.  The
+modeler saves to XML-based files, which can be hand-edited if needed.
+
+Also here are a few things that set Cayenne apart from other ORM products:
+
+* Cayenne can also work in three tier (ROP) mode where multiple clients
+connect to the data source not via JDBC but through a remote Cayenne
+controlled service.  This gives much greater control over centralized
+validation, caching and a seamless persistence of objects from the server
+through to the clients.  The clients might themselves be web servers
+delivering a distributed load balancing web farm or a rich GUI client such
+as a desktop Swing/SWT application.
+
+* A persistent object doesn't have to be of a class known at compile time.
+Instead Cayenne can use a generic class with mapping defined dynamically in
+runtime (all without any bytecode manipulation).
+
+* Cayenne supports "nested contexts" allowing an arbitrary number of
+nesting levels for commit/rollback operations. This way a user can create
+"scratch contexts" for working with objects, with the ability to discard
+(or save) those changes without affecting an overall larger set of
+uncommitted changes.
+



Mime
View raw message