You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@phoenix.apache.org by gr...@apache.org on 2014/06/04 08:19:07 UTC
svn commit: r1599945 - in /phoenix: phoenix-docs/src/main/org/h2/
phoenix-docs/src/main/org/h2/jdbc/ phoenix-docs/src/main/org/h2/jdbcx/
phoenix-docs/src/main/org/h2/tools/ site/publish/
site/source/src/site/markdown/
Author: greid
Date: Wed Jun 4 06:19:06 2014
New Revision: 1599945
URL: http://svn.apache.org/r1599945
Log:
PHOENIX-963 Remove duplicate paste copy of contributing
Apparently due to a re-applied doc patch, the full contributing
content was present twice in the same page. This commit removes
the duplication.
Modified:
phoenix/phoenix-docs/src/main/org/h2/Driver.java
phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java
phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java
phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java
phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java
phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java
phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java
phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java
phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java
phoenix/site/publish/contributing.html
phoenix/site/source/src/site/markdown/contributing.md
Modified: phoenix/phoenix-docs/src/main/org/h2/Driver.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/Driver.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/Driver.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/Driver.java Wed Jun 4 06:19:06 2014
@@ -17,7 +17,7 @@ import org.h2.message.DbException;
import org.h2.message.TraceSystem;
import org.h2.upgrade.DbUpgrade;
-/*## Java 1.7 ##
+//## Java 1.7 ##
import java.util.logging.Logger;
//*/
@@ -138,7 +138,7 @@ public class Driver implements java.sql.
/**
* [Not supported]
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public Logger getParentLogger() {
return null;
}
Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcCallableStatement.java Wed Jun 4 06:19:06 2014
@@ -1440,7 +1440,7 @@ public class JdbcCallableStatement exten
* @param parameterIndex the parameter index (1, 2, ...)
* @param type the class of the returned value
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public <T> T getObject(int parameterIndex, Class<T> type) {
return null;
}
@@ -1452,7 +1452,7 @@ public class JdbcCallableStatement exten
* @param parameterName the parameter name
* @param type the class of the returned value
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public <T> T getObject(String parameterName, Class<T> type) {
return null;
}
Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcConnection.java Wed Jun 4 06:19:06 2014
@@ -49,7 +49,7 @@ import java.sql.SQLXML;
import java.sql.SQLClientInfoException;
//*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
import java.util.concurrent.Executor;
//*/
@@ -1678,7 +1678,7 @@ public class JdbcConnection extends Trac
*
* @param schema the schema
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public void setSchema(String schema) {
// not supported
}
@@ -1687,7 +1687,7 @@ public class JdbcConnection extends Trac
/**
* [Not supported]
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public String getSchema() {
return null;
}
@@ -1698,7 +1698,7 @@ public class JdbcConnection extends Trac
*
* @param executor the executor used by this method
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public void abort(Executor executor) {
// not supported
}
@@ -1710,7 +1710,7 @@ public class JdbcConnection extends Trac
* @param executor the executor used by this method
* @param milliseconds the TCP connection timeout
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public void setNetworkTimeout(Executor executor, int milliseconds) {
// not supported
}
@@ -1719,7 +1719,7 @@ public class JdbcConnection extends Trac
/**
* [Not supported]
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public int getNetworkTimeout() {
return 0;
}
Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcDatabaseMetaData.java Wed Jun 4 06:19:06 2014
@@ -2885,7 +2885,7 @@ public class JdbcDatabaseMetaData extend
/**
* [Not supported]
*/
- /*## Java 1.7 ##
+ //## Java 1.7 ##
public boolean generatedKeyAlwaysReturned() {
return true;
}
@@ -2902,7 +2902,7 @@ public class JdbcDatabaseMetaData extend
* @param columnNamePattern null (to get all objects) or a column name
* (uppercase for unquoted names)
*/
- /*## Java 1.7 ##
+ //## Java 1.7 ##
public ResultSet getPseudoColumns(String catalog, String schemaPattern,
String tableNamePattern, String columnNamePattern) {
return null;
Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcResultSet.java Wed Jun 4 06:19:06 2014
@@ -3431,7 +3431,7 @@ public class JdbcResultSet extends Trace
* @param columnIndex the column index (1, 2, ...)
* @param type the class of the returned value
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public <T> T getObject(int columnIndex, Class<T> type) {
return null;
}
@@ -3443,7 +3443,7 @@ public class JdbcResultSet extends Trace
* @param columnName the column name
* @param type the class of the returned value
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public <T> T getObject(String columnName, Class<T> type) {
return null;
}
Modified: phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbc/JdbcStatement.java Wed Jun 4 06:19:06 2014
@@ -876,7 +876,7 @@ public class JdbcStatement extends Trace
/**
* [Not supported]
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public void closeOnCompletion() {
// not supported
}
@@ -885,7 +885,7 @@ public class JdbcStatement extends Trace
/**
* [Not supported]
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public boolean isCloseOnCompletion() {
return true;
}
Modified: phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcConnectionPool.java Wed Jun 4 06:19:06 2014
@@ -35,7 +35,7 @@ import org.h2.util.New;
import org.h2.message.DbException;
//*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
import java.util.logging.Logger;
//*/
@@ -330,7 +330,7 @@ public class JdbcConnectionPool implemen
/**
* [Not supported]
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public Logger getParentLogger() {
return null;
}
Modified: phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/jdbcx/JdbcDataSource.java Wed Jun 4 06:19:06 2014
@@ -26,7 +26,7 @@ import org.h2.jdbc.JdbcConnection;
import org.h2.message.TraceObject;
import org.h2.util.StringUtils;
-/*## Java 1.7 ##
+//## Java 1.7 ##
import java.util.logging.Logger;
//*/
@@ -381,7 +381,7 @@ public class JdbcDataSource extends Trac
/**
* [Not supported]
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public Logger getParentLogger() {
return null;
}
Modified: phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java
URL: http://svn.apache.org/viewvc/phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java (original)
+++ phoenix/phoenix-docs/src/main/org/h2/tools/SimpleResultSet.java Wed Jun 4 06:19:06 2014
@@ -853,7 +853,7 @@ public class SimpleResultSet implements
* @param columnIndex the column index (1, 2, ...)
* @param type the class of the returned value
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public <T> T getObject(int columnIndex, Class<T> type) {
return null;
}
@@ -865,7 +865,7 @@ public class SimpleResultSet implements
* @param columnName the column name
* @param type the class of the returned value
*/
-/*## Java 1.7 ##
+//## Java 1.7 ##
public <T> T getObject(String columnName, Class<T> type) {
return null;
}
Modified: phoenix/site/publish/contributing.html
URL: http://svn.apache.org/viewvc/phoenix/site/publish/contributing.html?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/site/publish/contributing.html (original)
+++ phoenix/site/publish/contributing.html Wed Jun 4 06:19:06 2014
@@ -1,7 +1,7 @@
<!DOCTYPE html>
<!--
- Generated by Apache Maven Doxia at 2014-06-03
+ Generated by Apache Maven Doxia at 2014-06-04
Rendered using Reflow Maven Skin 1.1.0 (http://andriusvelykis.github.io/reflow-maven-skin)
-->
<html xml:lang="en" lang="en">
@@ -176,61 +176,6 @@
<p>A patch file can be downloaded from a GitHub pull request by adding â.patchâ to the end of the pull request url, e.g. <a class="externalLink" href="https://github.com/apache/incubator-phoenix/pull/35.patch">https://github.com/apache/incubator-phoenix/pull/35.patch</a></p>
<p>When applying a patch contributed from a user, please use the âgit amâ command if a fully-formatted patch file is available, as this preserves the contributorâs contact information. Otherwise, the contributorâs name should be added to the commit messge.</p>
<p>If a single ticket consists of a patch with multiple commits, the commits can be squashed into a single commit using <tt>git rebase</tt>.</p>
- <h1>Contributing</h1>
-</div>
-<div class="section">
- <h2 id="General_process">General process</h2>
- <p>The general process for contributing code to Phoenix works as follows:</p>
- <ol style="list-style-type: decimal">
- <li>Discuss your changes on the dev mailing list</li>
- <li>Create a JIRA issue unless there already is one</li>
- <li>Prepare a patch containing your changes</li>
- <li>Submit the patch</li>
- </ol>
- <p>These steps are explained in greater detail below.</p>
- <div class="section">
- <h3 id="Discuss_on_the_mailing_list">Discuss on the mailing list</h3>
- <p>Itâs often best to discuss a change on the public mailing lists before creating and sumbitting a patch.</p>
- <p>If youâre unsure whether certain behavior in Phoenix is a bug, please send a mail to the <a href="mailing_list.html">user mailing list</a> to check.</p>
- <p>If youâre considering adding major new functionality to Phoenix, itâs a good idea to first discuss the idea on the <a href="mailing_list.html">developer mailing list</a> to make sure that your plans are in line with others in the Phoenix community.</p>
- </div>
- <div class="section">
- <h3 id="Log_a_JIRA_ticket">Log a JIRA ticket</h3>
- <p>The first step is to create a ticket on the <a class="externalLink" href="http://issues.apache.org/jira/browse/PHOENIX">Phoenix JIRA</a>. </p>
- </div>
- <div class="section">
- <h3 id="Generate_a_patch">Generate a patch</h3>
- <p>There are two general approaches that can be used for creating and submitting a patch: GitHub pull requests, or manually creating a patch with Git. Both of these are explained below.</p>
- <p>Regardless of which approach is taken, please make sure to follow the Phoenix code conventions (more information below). Whenever possible, unit tests or integration tests should be included with patches.</p>
- <p>The commit message should reference the jira ticket issue (which has the format <tt>PHOENIX-{NUMBER}</tt>).</p>
- <div class="section">
- <h4 id="GitHub_workflow">GitHub workflow</h4>
- <ol style="list-style-type: decimal">
- <li>Create a pull request in GitHub for the <a class="externalLink" href="https://github.com/apache/incubator-phoenix">mirror of the Phoenix Git repository</a>.</li>
- <li>Add a comment in the Jira issue with a link to the pull request. This makes it clear that the patch is ready for review.</li>
- </ol>
- </div>
- <div class="section">
- <h4 id="Local_Git_workflow">Local Git workflow</h4>
- <ol style="list-style-type: decimal">
- <li>Create a local branch <tt>git checkout -b <branch name></tt></li>
- <li>Make and commit changes</li>
- <li> <p>Generate a patch based on the name of the JIRA issue, as follows:</p> <p><tt>git format-patch --stdout master > PHOENIX-{NUMBER}.patch</tt></p></li>
- <li> <p>Attach the created patch file to the jira ticket</p></li>
- </ol>
- </div>
- </div>
-</div>
-<div class="section">
- <h2 id="Code_conventions">Code conventions</h2>
- <p>The Phoenix code conventions are similar to the <a class="externalLink" href="http://www.oracle.com/technetwork/java/index-135089.html">Sun/Oracle Java Code Convention</a>. We use 4 spaces (no tabs) for indentation, and limit lines to 100 characters.</p>
- <p>Eclipse code formatting settings and import order settings (which can also be imported into Intellij IDEA) are available in the dev directory of the Phoenix codebase.</p>
- <p>All new source files should include the Apache license header.</p>
- <h1>Committer workflow</h1>
- <p>In general, the ârebaseâ workflow should be used with the Phoenix codebase (see <a class="externalLink" href="http://randyfay.com/content/rebase-workflow-git">this blog post</a> for more information on the difference between the âmergeâ and ârebaseâ workflows in Git).</p>
- <p>A patch file can be downloaded from a GitHub pull request by adding â.patchâ to the end of the pull request url, e.g. <a class="externalLink" href="https://github.com/apache/incubator-phoenix/pull/35.patch">https://github.com/apache/incubator-phoenix/pull/35.patch</a></p>
- <p>When applying a patch contributed from a user, please use the âgit amâ command if a fully-formatted patch file is available, as this preserves the contributorâs contact information. Otherwise, the contributorâs name should be added to the commit messge.</p>
- <p>If a single ticket consists of a patch with multiple commits, the commits can be squashed into a single commit using <tt>git rebase</tt>.</p>
</div>
</div>
</div>
Modified: phoenix/site/source/src/site/markdown/contributing.md
URL: http://svn.apache.org/viewvc/phoenix/site/source/src/site/markdown/contributing.md?rev=1599945&r1=1599944&r2=1599945&view=diff
==============================================================================
--- phoenix/site/source/src/site/markdown/contributing.md (original)
+++ phoenix/site/source/src/site/markdown/contributing.md Wed Jun 4 06:19:06 2014
@@ -67,72 +67,3 @@ When applying a patch contributed from a
If a single ticket consists of a patch with multiple commits, the commits can be squashed into a single commit using `git rebase`.
-# Contributing
-
-## General process
-
-The general process for contributing code to Phoenix works as follows:
-
-1. Discuss your changes on the dev mailing list
-2. Create a JIRA issue unless there already is one
-3. Prepare a patch containing your changes
-4. Submit the patch
-
-These steps are explained in greater detail below.
-
-### Discuss on the mailing list
-
-It's often best to discuss a change on the public mailing lists before creating and sumbitting a patch.
-
-If you're unsure whether certain behavior in Phoenix is a bug, please send a mail to the [user mailing list](mailing_list.html) to check.
-
-If you're considering adding major new functionality to Phoenix, it's a good idea to first discuss the idea on the [developer mailing list](mailing_list.html) to make sure that your plans are in line with others in the Phoenix community.
-
-### Log a JIRA ticket
-
-The first step is to create a ticket on the [Phoenix JIRA](http://issues.apache.org/jira/browse/PHOENIX).
-
-### Generate a patch
-
-There are two general approaches that can be used for creating and submitting a patch: GitHub pull requests, or manually creating a patch with Git. Both of these are explained below.
-
-Regardless of which approach is taken, please make sure to follow the Phoenix code conventions (more information below). Whenever possible, unit tests or integration tests should be included with patches.
-
-The commit message should reference the jira ticket issue (which has the format
-`PHOENIX-{NUMBER}`).
-
-
-#### GitHub workflow
-
-1. Create a pull request in GitHub for the [mirror of the Phoenix Git repository](https://github.com/apache/incubator-phoenix).
-2. Add a comment in the Jira issue with a link to the pull request. This makes it clear that the patch is ready for review.
-
-#### Local Git workflow
-
-1. Create a local branch `git checkout -b <branch name>`
-2. Make and commit changes
-3. Generate a patch based on the name of the JIRA issue, as follows:
-
- `git format-patch --stdout master > PHOENIX-{NUMBER}.patch`
-
-4. Attach the created patch file to the jira ticket
-
-## Code conventions
-
-The Phoenix code conventions are similar to the [Sun/Oracle Java Code Convention](http://www.oracle.com/technetwork/java/index-135089.html). We use 4 spaces (no tabs) for indentation, and limit lines to 100 characters.
-
-Eclipse code formatting settings and import order settings (which can also be imported into Intellij IDEA) are available in the dev directory of the Phoenix codebase.
-
-All new source files should include the Apache license header.
-
-
-# Committer workflow
-
-In general, the "rebase" workflow should be used with the Phoenix codebase (see [this blog post](http://randyfay.com/content/rebase-workflow-git) for more information on the difference between the "merge" and "rebase" workflows in Git).
-
-A patch file can be downloaded from a GitHub pull request by adding ".patch" to the end of the pull request url, e.g. https://github.com/apache/incubator-phoenix/pull/35.patch
-
-When applying a patch contributed from a user, please use the "git am" command if a fully-formatted patch file is available, as this preserves the contributor's contact information. Otherwise, the contributor's name should be added to the commit messge.
-
-If a single ticket consists of a patch with multiple commits, the commits can be squashed into a single commit using `git rebase`.
-