You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by ch...@apache.org on 2017/07/13 09:59:09 UTC

flink git commit: [FLINK-6865] Update checkstyle documentation

Repository: flink
Updated Branches:
  refs/heads/master bf0846fc6 -> 05beca703


[FLINK-6865] Update checkstyle documentation


Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/05beca70
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/05beca70
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/05beca70

Branch: refs/heads/master
Commit: 05beca703d005e2d9db0c441a6d01fa6aa3993b7
Parents: bf0846f
Author: zentol <ch...@apache.org>
Authored: Wed Jun 7 16:29:15 2017 +0200
Committer: zentol <ch...@apache.org>
Committed: Thu Jul 13 11:58:54 2017 +0200

----------------------------------------------------------------------
 docs/internals/ide_setup.md | 16 ++++++----------
 1 file changed, 6 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/flink/blob/05beca70/docs/internals/ide_setup.md
----------------------------------------------------------------------
diff --git a/docs/internals/ide_setup.md b/docs/internals/ide_setup.md
index 33abf61..9b27c45 100644
--- a/docs/internals/ide_setup.md
+++ b/docs/internals/ide_setup.md
@@ -101,18 +101,14 @@ IntelliJ supports checkstyle within the IDE using the Checkstyle-IDEA plugin.
 1. Checkstyle will now give warnings in the editor for any Checkstyle
    violations.
 
-You can also scan an entire module by opening the Checkstyle tools window and
-clicking the "Check Module" button. The scan should report no errors.
+Once the plugin is installed you can directly import `"tools/maven/checkstyle.xml"` by going to Settings -> Editor -> Code Style -> Java -> Gear Icon next to Scheme dropbox. This will for example automatically adjust the imports layout.
 
-<span class="label label-info">Note</span> Selecting "Check Project" may report some errors from the archetype
-modules as they are not configured for Checkstyle validation.
+You can scan an entire module by opening the Checkstyle tools window and
+clicking the "Check Module" button. The scan should report no errors.
 
-<span class="label label-info">Note</span> Some modules use a more strict `checkstyle.xml` file called
-`strict-checkstyle.xml`. You should setup an additional configuration by following the above
-steps for this file as well and activate it on a per-module basis. To set a per-module checkstyle
-configuration go to File -> Project Structure. Then select the module for which you want to change
-the checkstyle configuration in the modules list and change the checkstyle configuration in the
-Checkstyle tab.
+<span class="label label-info">Note</span> Some modules are not fully covered by checkstyle,
+which include `flink-core`, `flink-java`, `flink-optimizer`, and `flink-runtime`.
+Nevertheless please make sure that code you add/modify in these modules still conforms to the checkstyle rules.
 
 ## Eclipse