Author: lidong
Date: Sun Nov 5 14:01:06 2017
New Revision: 1814356
URL: http://svn.apache.org/viewvc?rev=1814356&view=rev
Log:
update sample for submit-patch.py
Modified:
kylin/site/development/howto_contribute.html
kylin/site/docs21/howto/howto_upgrade.html
kylin/site/feed.xml
Modified: kylin/site/development/howto_contribute.html
URL:
http://svn.apache.org/viewvc/kylin/site/development/howto_contribute.html?rev=1814356&r1=1814355&r2=1814356&view=diff
==============================================================================
--- kylin/site/development/howto_contribute.html (original)
+++ kylin/site/development/howto_contribute.html Sun Nov 5 14:01:06 2017
@@ -593,15 +593,36 @@
<li>Make changes in your fork
<ul>
<li>No strict code style at the moment, but the general rule is keep
consistent with existing files. E.g. use 4-space indent for java files.</li>
+ <li>Add unit test for your code change as much as possible.</li>
+ <li>Make sure âmvn clean packageâ and âmvn testâ can get
success.</li>
<li>Sufficient unit test and integration test is a mandatory part of
code change.</li>
</ul>
</li>
- <li><a href="/development/howto_test.html">Run tests</a> to ensure your
change is in good quality and does not break anything</li>
- <li>Generate Pull Request or Patch and attach it to relative JIRA.
+ <li><a href="/development/howto_test.html">Run tests</a> to ensure your
change is in good quality and does not break anything. If your patch was
generated incorrectly or your code does not adhere to the code guidelines, you
may be asked to redo some work.</li>
+ <li>Generate a patch and attach it to relative JIRA.</li>
+</ul>
+
+<h2 id="generate-patch">Generate Patch</h2>
+<ul>
+ <li>Using <code class="highlighter-rouge">submit-patch.py</code>
(recommended) to create patches, upload to jira and optionally create/update
reviews on Review Board. Patch name is automatically formatted as
(JIRA).(branch name).(patch number).patch to follow Yetusâ naming rules.</li>
+</ul>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>$
./dev-support/submit-patch.py -jid KYLIN-xxxxx -b master -srb
+</code></pre>
+</div>
+
+<ul>
+ <li>Use -h flag for this script to know detailed usage information. Most
useful options are:
<ul>
- <li>Please use <code class="highlighter-rouge">git format-patch</code>
command to generate the patch, for a detail guide you can refer to <a
href="https://ariejan.net/2009/10/26/how-to-create-and-apply-a-patch-with-git/";>How
to create and apply a patch with Git</a></li>
+ <li>-b BRANCH, âbranch BRANCH : Specify base branch for generating the
diff. If not specified, tracking branch is used. If there is no tracking
branch, error will be thrown.</li>
+ <li>-jid JIRA_ID, âjira-id JIRA_ID : If used, deduces next patch
version from attachments in the jira and uploads the new patch. Script will ask
for jira username/password for authentication. If not set, patch is named
<branch>.patch.</branch></li>
</ul>
</li>
+ <li>By default, itâll also create/update review board. To skip that
action, use -srb option. It uses âIssue Linksâ in the jira to figure out if
a review request already exists. If no review request is present, then creates
a new one and populates all required fields using jira summary, patch
description, etc. Also adds this reviewâs link to the jira.</li>
+ <li>
+ <p>To install required python dependencies, execute <code
class="highlighter-rouge">pip install -r
dev-support/python-requirements.txt</code> from the master branch.</p>
+ </li>
+ <li>Alternatively, you can also manually generate a patch. Please use <code
class="highlighter-rouge">git rebase -i</code> first, to combine (squash)
smaller commits into a single larger one. Then use <code
class="highlighter-rouge">git format-patch</code> command to generate the
patch, for a detail guide you can refer to <a
href="https://ariejan.net/2009/10/26/how-to-create-and-apply-a-patch-with-git/";>How
to create and apply a patch with Git</a></li>
</ul>
<h2 id="apply-patch">Apply Patch</h2>
Modified: kylin/site/docs21/howto/howto_upgrade.html
URL:
http://svn.apache.org/viewvc/kylin/site/docs21/howto/howto_upgrade.html?rev=1814356&r1=1814355&r2=1814356&view=diff
==============================================================================
--- kylin/site/docs21/howto/howto_upgrade.html (original)
+++ kylin/site/docs21/howto/howto_upgrade.html Sun Nov 5 14:01:06 2017
@@ -3088,10 +3088,11 @@
<p>3) Spark is upgraded from v1.6.3 to v2.1.1, if you customized Spark
configurations in kylin.properties, please upgrade them as well by referring to
<a href="https://spark.apache.org/docs/2.1.0/";>Spark documentation</a>.</p>
-<p>4) If you are running Kylin with two clusters (compute/query separated),
need copy the big metadata files (which are persisted in HDFS instead of HBase)
from the Hadoop cluster to HBase cluster.<br />
-<code class="highlighter-rouge">
-hadoop distcp
hdfs://compute-cluster:8020/kylin/kylin_default_instance/resources
hdfs://query-cluster:8020/kylin/kylin_default_instance/resources
-</code></p>
+<p>4) If you are running Kylin with two clusters (compute/query separated),
need copy the big metadata files (which are persisted in HDFS instead of HBase)
from the Hadoop cluster to HBase cluster.</p>
+
+<div class="highlighter-rouge"><pre class="highlight"><code>hadoop distcp
hdfs://compute-cluster:8020/kylin/kylin_metadata/resources
hdfs://query-cluster:8020/kylin/kylin_metadata/resources
+</code></pre>
+</div>
<h2 id="upgrade-from-v160-to-v200">Upgrade from v1.6.0 to v2.0.0</h2>
Modified: kylin/site/feed.xml
URL:
http://svn.apache.org/viewvc/kylin/site/feed.xml?rev=1814356&r1=1814355&r2=1814356&view=diff
==============================================================================
--- kylin/site/feed.xml (original)
+++ kylin/site/feed.xml Sun Nov 5 14:01:06 2017
@@ -19,8 +19,8 @@
<description>Apache Kylin Home</description>
<link>http://kylin.apache.org/</link>
<atom:link href="http://kylin.apache.org/feed.xml"; rel="self"
type="application/rss+xml"/>
- <pubDate>Sat, 04 Nov 2017 06:59:23 -0700</pubDate>
- <lastBuildDate>Sat, 04 Nov 2017 06:59:23 -0700</lastBuildDate>
+ <pubDate>Sun, 05 Nov 2017 05:59:18 -0800</pubDate>
+ <lastBuildDate>Sun, 05 Nov 2017 05:59:18 -0800</lastBuildDate>
<generator>Jekyll v2.5.3</generator>
<item>
