You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by GitBox <gi...@apache.org> on 2020/02/14 08:14:04 UTC
[GitHub] [spark] cloud-fan opened a new pull request #27577: [DOC] add
config naming policy
cloud-fan opened a new pull request #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
Add docs to describe the config naming policy.
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
To encourage contributors to name configs more consistently.
### Does this PR introduce any user-facing change?
<!--
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If no, write 'No'.
-->
no
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
-->
N/A
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586213487
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586613987
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586589263
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] maropu commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
maropu commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586833416
>> btw, if we want to remind developers to follow the naming rule, how about adding a link to this >> guideline in the PR template, too?
> Yea this is a good idea!
ok, I'll make a pr for the update now.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586213500
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/118404/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586314820
Merged build finished. Test FAILed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
SparkQA commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586314776
**[Test build #118433 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118433/testReport)** for PR 27577 at commit [`7464295`](https://github.com/apache/spark/commit/7464295046e81c28a6d879af81baaa308eea37c6).
* This patch **fails to generate documentation**.
* This patch merges cleanly.
* This patch adds no public classes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586305758
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586305758
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586589265
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/23234/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586282678
Merged build finished. Test FAILed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
SparkQA commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586613798
**[Test build #118477 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118477/testReport)** for PR 27577 at commit [`422730d`](https://github.com/apache/spark/commit/422730d86964c247f088419c55c8142227c41342).
* This patch passes all tests.
* This patch merges cleanly.
* This patch adds no public classes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming policy
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586151733
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA removed a comment on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
SparkQA removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586192550
**[Test build #118416 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118416/testReport)** for PR 27577 at commit [`7464295`](https://github.com/apache/spark/commit/7464295046e81c28a6d879af81baaa308eea37c6).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming policy
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586187991
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/23172/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a change in pull request #27577:
[DOC] add config naming policy
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on a change in pull request #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#discussion_r379324116
##########
File path: core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala
##########
@@ -17,6 +17,34 @@
package org.apache.spark.internal.config
+// ======================================================================================
+// The naming policy of configurations
Review comment:
Also no big deal but "policy" sounds too strong to me. Wonder if we have a better and softer term such as "The guideline for naming configurations"
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a change in pull request #27577:
[DOC] add config naming policy
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on a change in pull request #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#discussion_r379324116
##########
File path: core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala
##########
@@ -17,6 +17,34 @@
package org.apache.spark.internal.config
+// ======================================================================================
+// The naming policy of configurations
Review comment:
Also no big deal but "policy" sounds too strong and aggressive to me. Wonder if we have a better and softer term such as "The guideline for naming configurations"
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586589263
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] kiszk commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
kiszk commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586671458
Beyond this PR, can we create a sanity checker?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming policy
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586187982
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586305767
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/23190/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
SparkQA commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586588932
**[Test build #118477 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118477/testReport)** for PR 27577 at commit [`422730d`](https://github.com/apache/spark/commit/422730d86964c247f088419c55c8142227c41342).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] kiszk commented on a change in pull request #27577: [DOC]
add config naming guideline
Posted by GitBox <gi...@apache.org>.
kiszk commented on a change in pull request #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#discussion_r379821398
##########
File path: core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala
##########
@@ -17,6 +17,35 @@
package org.apache.spark.internal.config
+// ====================================================================================
+// The guideline for naming configurations
+// ====================================================================================
+/*
+In general, the config name should be a noun that describes its basic purpose. It's
+recommended to add prefix to the config name to make the scope clearer. For example,
+`spark.scheduler.mode` clearly indicates that this config is for the scheduler.
+
+A config name can have multiple prefixes that are structured, which is similar to a
+qualified Java class name. Each prefix behaves like a namespace. We should only create
+a namespace if it's meaningful and can be shared by multiple configs. For example,
+`buffer.inMemoryThreshold` is preferred over `buffer.in.memory.threshold`.
+
+The followings are some best practices of naming configs for some common cases:
Review comment:
Do we need ` for some common cases`? Otherwise, how about `for common cases`. This is because there are two `some` in one sentence.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586613990
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/118477/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on issue #27577: [DOC] add config
naming policy
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586149200
I pick this place over https://spark.apache.org/contributing.html, because this place is more visible to the developers. Ideally all configs should be defined with `ConfigEntry` so this looks like a logical place to put the naming policy.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA removed a comment on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
SparkQA removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586150981
**[Test build #118404 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118404/testReport)** for PR 27577 at commit [`63e4dc5`](https://github.com/apache/spark/commit/63e4dc554f1ccb39c1217037760c1cd7a8e39d27).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] dongjoon-hyun commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
dongjoon-hyun commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-587087687
+1, late LGTM. Thank you!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586613990
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/118477/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586282687
Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/118416/
Test FAILed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586314820
Merged build finished. Test FAILed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA removed a comment on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
SparkQA removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586304988
**[Test build #118433 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118433/testReport)** for PR 27577 at commit [`7464295`](https://github.com/apache/spark/commit/7464295046e81c28a6d879af81baaa308eea37c6).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586809954
> btw, if we want to remind developers to follow the naming rule, how about adding a link to this guideline in the PR template, too?
Yea this is a good idea!
> Beyond this PR, can we create a sanity checker?
This is hard. e.g. how to decide if a name is clear or not? We may be able to check if a boolean config is ended with `.enabled` or a verb, but not sure how to simply check verb.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586282687
Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/118416/
Test FAILed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming policy
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586151733
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586282678
Merged build finished. Test FAILed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586213500
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/118404/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] kiszk commented on issue #27577: [DOC] add config naming
policy
Posted by GitBox <gi...@apache.org>.
kiszk commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586189702
Looks good
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
SparkQA commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586282085
**[Test build #118416 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118416/testReport)** for PR 27577 at commit [`7464295`](https://github.com/apache/spark/commit/7464295046e81c28a6d879af81baaa308eea37c6).
* This patch **fails Spark unit tests**.
* This patch merges cleanly.
* This patch adds no public classes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586314830
Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/118433/
Test FAILed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586213487
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming policy
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586187991
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/23172/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA commented on issue #27577: [DOC] add config naming
policy
Posted by GitBox <gi...@apache.org>.
SparkQA commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586192550
**[Test build #118416 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118416/testReport)** for PR 27577 at commit [`7464295`](https://github.com/apache/spark/commit/7464295046e81c28a6d879af81baaa308eea37c6).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
SparkQA commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586304988
**[Test build #118433 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118433/testReport)** for PR 27577 at commit [`7464295`](https://github.com/apache/spark/commit/7464295046e81c28a6d879af81baaa308eea37c6).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586298096
retest this please
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan closed pull request #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
cloud-fan closed pull request #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA removed a comment on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
SparkQA removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586588932
**[Test build #118477 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118477/testReport)** for PR 27577 at commit [`422730d`](https://github.com/apache/spark/commit/422730d86964c247f088419c55c8142227c41342).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HeartSaVioR commented on a change in pull request #27577:
[DOC] add config naming guideline
Posted by GitBox <gi...@apache.org>.
HeartSaVioR commented on a change in pull request #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#discussion_r379828530
##########
File path: core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala
##########
@@ -17,6 +17,35 @@
package org.apache.spark.internal.config
+// ====================================================================================
+// The guideline for naming configurations
+// ====================================================================================
+/*
+In general, the config name should be a noun that describes its basic purpose. It's
+recommended to add prefix to the config name to make the scope clearer. For example,
+`spark.scheduler.mode` clearly indicates that this config is for the scheduler.
+
+A config name can have multiple prefixes that are structured, which is similar to a
+qualified Java class name. Each prefix behaves like a namespace. We should only create
+a namespace if it's meaningful and can be shared by multiple configs. For example,
+`buffer.inMemoryThreshold` is preferred over `buffer.in.memory.threshold`.
+
+The followings are some best practices of naming configs for some common cases:
Review comment:
Agreed. Given we agreed upon the suggestion, it seems to just say `the best practices` or `some of the best practices`, and remove `some` in `some common cases` like @kiszk commented.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA commented on issue #27577: [DOC] add config naming
policy
Posted by GitBox <gi...@apache.org>.
SparkQA commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586150981
**[Test build #118404 has started](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118404/testReport)** for PR 27577 at commit [`63e4dc5`](https://github.com/apache/spark/commit/63e4dc554f1ccb39c1217037760c1cd7a8e39d27).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] maropu commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
maropu commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586654021
btw, if we want to remind developers to follow the naming rule, how about adding a link to this guildeline in the PR template, too?
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586589265
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/23234/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] SparkQA commented on issue #27577: [DOC] add config naming
guideline
Posted by GitBox <gi...@apache.org>.
SparkQA commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586212290
**[Test build #118404 has finished](https://amplab.cs.berkeley.edu/jenkins/job/SparkPullRequestBuilder/118404/testReport)** for PR 27577 at commit [`63e4dc5`](https://github.com/apache/spark/commit/63e4dc554f1ccb39c1217037760c1cd7a8e39d27).
* This patch passes all tests.
* This patch merges cleanly.
* This patch adds no public classes.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586613987
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming policy
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586151741
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/23163/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on a change in pull request #27577:
[DOC] add config naming policy
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on a change in pull request #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#discussion_r379322859
##########
File path: core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala
##########
@@ -17,6 +17,34 @@
package org.apache.spark.internal.config
+// ======================================================================================
+// The naming policy of configurations
+// ======================================================================================
+// In general, the config name should be a noun that describes its basic purpose. It's
+// recommended to add prefix to the config name to make the scope clearer. For example,
+// `spark.scheduler.mode` clearly indicates that this config is for the scheduler.
+//
+// A config name can have multiple prefixes that are structured, which is similar to a
+// qualified Java class name. Each prefix behaves like a namespace. We should only create
+// a namespace if it's meaningful and can be shared by multiple configs. For example,
+// `buffer.inMemoryThreshold` is preferred over `buffer.in.memory.threshold`.
+//
+// The followings are some best practices of naming configs for some common cases:
+// 1. When adding configs for a big feature, it's better to create an umbrella config that
+// can turn the feature on/off, with a name like `featureName.enabled`. The other configs
+// of this feature should be put under the `featureName` namespace. For example:
+// - spark.sql.cbo.enabled
+// - spark.sql.cbo.starSchemaDetection
+// - spark.sql.cbo.joinReorder.enabled
+// - spark.sql.cbo.joinReorder.dp.threshold
+// 2. When adding a boolean config, the name should be a verb that describes what
+// happens if this config is set to true, e.g. `spark.shuffle.sort.useRadixSort`.
+// 3. When adding a config to specify a time duration, it's better to put the time unit
+// in the config name. For example, `featureName.timeoutMs`, which clearly indicates
+// that the time unit is millisecond. The config entry should be created with
+// `ConfigBuilder#timeConf`, to support time strings like `2 minutes`.
+
Review comment:
No big deal but we better to use multiline comment style: `/* ... */`.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] HyukjinKwon commented on issue #27577: [DOC] add config
naming policy
Posted by GitBox <gi...@apache.org>.
HyukjinKwon commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586172677
I am good with it.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586314830
Test FAILed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder/118433/
Test FAILed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on issue #27577: [DOC] add config
naming policy
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586148318
cc @dongjoon-hyun @rxin @HyukjinKwon @HeartSaVioR @maropu @kiszk
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming policy
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586151741
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/23163/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming policy
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming policy
URL: https://github.com/apache/spark/pull/27577#issuecomment-586187982
Merged build finished. Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] AmplabJenkins removed a comment on issue #27577: [DOC] add
config naming guideline
Posted by GitBox <gi...@apache.org>.
AmplabJenkins removed a comment on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586305767
Test PASSed.
Refer to this link for build results (access rights to CI server needed):
https://amplab.cs.berkeley.edu/jenkins//job/SparkPullRequestBuilder-K8s/23190/
Test PASSed.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] cloud-fan commented on issue #27577: [DOC] add config
naming guideline
Posted by GitBox <gi...@apache.org>.
cloud-fan commented on issue #27577: [DOC] add config naming guideline
URL: https://github.com/apache/spark/pull/27577#issuecomment-586814410
thanks for the review, merging to master!
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org