You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@flink.apache.org by al...@apache.org on 2017/08/08 09:24:29 UTC
flink git commit: [hotfix] Clarify checkstyle setup instructions for
IntelliJ
Repository: flink
Updated Branches:
refs/heads/master 14bcac7b9 -> f471888ec
[hotfix] Clarify checkstyle setup instructions for IntelliJ
We have to specifically set the Checkstyle Version to 6.19, otherwise
we'll get errors when trying to import the checkstyle file.
Project: http://git-wip-us.apache.org/repos/asf/flink/repo
Commit: http://git-wip-us.apache.org/repos/asf/flink/commit/f471888e
Tree: http://git-wip-us.apache.org/repos/asf/flink/tree/f471888e
Diff: http://git-wip-us.apache.org/repos/asf/flink/diff/f471888e
Branch: refs/heads/master
Commit: f471888ec7ea4bf7f584892cf1f774bd058908c6
Parents: 14bcac7
Author: Aljoscha Krettek <al...@gmail.com>
Authored: Tue Aug 8 11:20:44 2017 +0200
Committer: Aljoscha Krettek <al...@gmail.com>
Committed: Tue Aug 8 11:21:38 2017 +0200
----------------------------------------------------------------------
docs/internals/ide_setup.md | 18 ++++++++++--------
1 file changed, 10 insertions(+), 8 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/flink/blob/f471888e/docs/internals/ide_setup.md
----------------------------------------------------------------------
diff --git a/docs/internals/ide_setup.md b/docs/internals/ide_setup.md
index 6781f44..31ad6b8 100644
--- a/docs/internals/ide_setup.md
+++ b/docs/internals/ide_setup.md
@@ -85,20 +85,22 @@ to enable support for Scala projects and files:
IntelliJ supports checkstyle within the IDE using the Checkstyle-IDEA plugin.
1. Install the "Checkstyle-IDEA" plugin from the IntelliJ plugin repository.
-1. Configure the plugin by going to Settings -> Other Settings -> Checkstyle.
-1. Set the "Scan Scope" to "Only Java sources (including tests)".
-1. In the "Configuration File" pane, add a new configuration using the plus icon:
+2. Configure the plugin by going to Settings -> Other Settings -> Checkstyle.
+3. Set the "Scan Scope" to "Only Java sources (including tests)".
+4. Select _6.19_ in the "Checkstyle Version" dropdown and click apply. **This step is important,
+ don't skip it!**
+5. In the "Configuration File" pane, add a new configuration using the plus icon:
1. Set the "Description" to "Flink".
- 1. Select "Use a local Checkstyle file", and point it to
+ 2. Select "Use a local Checkstyle file", and point it to
`"tools/maven/checkstyle.xml"` within
your repository.
- 1. Check the box for "Store relative to project location", and click
+ 3. Check the box for "Store relative to project location", and click
"Next".
- 1. Configure the "checkstyle.suppressions.file" property value to
+ 4. Configure the "checkstyle.suppressions.file" property value to
`"suppressions.xml"`, and click "Next", then "Finish".
-1. Select "Flink" as the only active configuration file, and click "Apply" and
+6. Select "Flink" as the only active configuration file, and click "Apply" and
"OK".
-1. Checkstyle will now give warnings in the editor for any Checkstyle
+7. Checkstyle will now give warnings in the editor for any Checkstyle
violations.
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.