You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kylin.apache.org by sh...@apache.org on 2017/11/05 08:19:15 UTC
kylin git commit: Add document on using submit-patch.py
Repository: kylin
Updated Branches:
refs/heads/document e399435f8 -> 0c4b618e1
Add document on using submit-patch.py
Project: http://git-wip-us.apache.org/repos/asf/kylin/repo
Commit: http://git-wip-us.apache.org/repos/asf/kylin/commit/0c4b618e
Tree: http://git-wip-us.apache.org/repos/asf/kylin/tree/0c4b618e
Diff: http://git-wip-us.apache.org/repos/asf/kylin/diff/0c4b618e
Branch: refs/heads/document
Commit: 0c4b618e1d4521e18179b504a96484e67f00cc4a
Parents: e399435
Author: shaofengshi <sh...@apache.org>
Authored: Sun Nov 5 16:19:17 2017 +0800
Committer: shaofengshi <sh...@apache.org>
Committed: Sun Nov 5 16:19:17 2017 +0800
----------------------------------------------------------------------
website/_dev/howto_contribute.md | 24 ++++++++++++++++++++----
website/_docs21/howto/howto_upgrade.md | 3 ++-
2 files changed, 22 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/kylin/blob/0c4b618e/website/_dev/howto_contribute.md
----------------------------------------------------------------------
diff --git a/website/_dev/howto_contribute.md b/website/_dev/howto_contribute.md
index 9b0e14c..9b8af29 100644
--- a/website/_dev/howto_contribute.md
+++ b/website/_dev/howto_contribute.md
@@ -32,10 +32,26 @@ Do not forget to discuss in [mailing list](/community/index.html) before working
* Discuss with others in mailing list or issue comments, make sure the proposed changes fit in with what others are doing and have planned for the project
* Make changes in your fork
* 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.
- * Sufficient unit test and integration test is a mandatory part of code change.
-* [Run tests](/development/howto_test.html) to ensure your change is in good quality and does not break anything
-* Generate Pull Request or Patch and attach it to relative JIRA.
- * Please use `git format-patch` command to generate the patch, for a detail guide you can refer to [How to create and apply a patch with Git](https://ariejan.net/2009/10/26/how-to-create-and-apply-a-patch-with-git/)
+ * Add unit test for your code change as much as possible.
+ * Make sure "mvn clean package" and "mvn test" can get success.
+ * Sufficient unit test and integration test is a mandatory part of code change.
+* [Run tests](/development/howto_test.html) 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.
+* Generate a patch and attach it to relative JIRA.
+
+## Generate Patch
+* Using `submit-patch.py` (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.
+
+```
+$ ./dev-support/submit-patch.py -jid KYLIN-xxxxx
+```
+
+* Use -h flag for this script to know detailed usage information. Most useful options are:
+ * -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.
+ * -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.
+* 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.
+* To install required python dependencies, execute `pip install -r dev-support/python-requirements.txt` from the master branch.
+
+* Alternatively, you can also manually generate a patch. Please use `git rebase -i` first, to combine (squash) smaller commits into a single larger one. Then use `git format-patch` command to generate the patch, for a detail guide you can refer to [How to create and apply a patch with Git](https://ariejan.net/2009/10/26/how-to-create-and-apply-a-patch-with-git/)
## Apply Patch
http://git-wip-us.apache.org/repos/asf/kylin/blob/0c4b618e/website/_docs21/howto/howto_upgrade.md
----------------------------------------------------------------------
diff --git a/website/_docs21/howto/howto_upgrade.md b/website/_docs21/howto/howto_upgrade.md
index 6ee95cf..a45abf1 100644
--- a/website/_docs21/howto/howto_upgrade.md
+++ b/website/_docs21/howto/howto_upgrade.md
@@ -45,8 +45,9 @@ After the migration finished, you can delete the legacy "kylin_metadata_user" an
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 [Spark documentation](https://spark.apache.org/docs/2.1.0/).
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.
+
```
-hadoop distcp hdfs://compute-cluster:8020/kylin/kylin_default_instance/resources hdfs://query-cluster:8020/kylin/kylin_default_instance/resources
+hadoop distcp hdfs://compute-cluster:8020/kylin/kylin_metadata/resources hdfs://query-cluster:8020/kylin/kylin_metadata/resources
```