Github user erikdw commented on the issue:
https://github.com/apache/storm/pull/2109
@revans2 : agree that we should be careful in making changes away from the
base "google_checks.xml", and I did already [argue
above](https://github.com/apache/storm/pull/2109#discussion_r116677826) that we
should be using `taskId` for the variable (that was implied when I said we
should rename that *really* badly named `taskId()` method to `taskPrefix()`).
So that should unblock Srishty for now.
But let me make a few points:
* The "standard" we are using here is just the *Google* standard, it's not
some industry-wide thing that everyone strictly follows. I'm not sure whether
we should be trying to follow it strictly, or just using it as a jumping off
point for our own standard.
* I'm pretty sure most would agree that `ignoreFinal` *should* be `false`
(unlike the google default), because otherwise your constants won't be be
allowed to be named `FOO_BAR`, they'd be named `Foo_Bar` or `FooBar`, neither
of which stand out as being a constant. So that's at least one more deviation
I strongly believe we should be making. And I'm sure there are more, the
Google "standard" seems to be a bit wacky IMHO.
* If your statement about "documentation" and "HBase" (I'm not familiar
with that issue) is about how we're obscuring what we've changed from the
Google defaults, I do have sympathy for that view. But that's because it's
also going to be harder to upgrade our version of checkstyle later, since we'll
need our changes to be applied to a newer google_checks.xml file. Though I will
note that it's quite easy to craft a command to show the changes we've made so
far:
```
% diff <(curl -s
https://raw.githubusercontent.com/checkstyle/checkstyle/checkstyle-7.7/src/main/resources/google_checks.xml)
<(curl -s
https://raw.githubusercontent.com/apache/storm/master/storm-buildtools/storm_checkstyle.xml)
1a2,19
>
> <!--
> Licensed to the Apache Software Foundation (ASF) under one or more
> contributor license agreements. See the NOTICE file distributed with
> this work for additional information regarding copyright ownership.
> The ASF licenses this file to You under the Apache License, Version
2.0
> (the "License"); you may not use this file except in compliance with
> the License. You may obtain a copy of the License at
>
> http://www.apache.org/licenses/LICENSE-2.0
>
> Unless required by applicable law or agreed to in writing, software
> distributed under the License is distributed on an "AS IS" BASIS,
> WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.
> See the License for the specific language governing permissions and
> limitations under the License.
> -->
>
6a25,36
> The original file came from here:
>
https://raw.githubusercontent.com/checkstyle/checkstyle/checkstyle-7.7/src/main/resources/google_checks.xml
> It has been slightly modified for use in Apache Storm, as follows:
> * 4 space indents instead of 2
> * line-length limit is 140 instead of 100
> Once checkstyle has the ability to override selected
configuration elements from within the Maven
> pom.xml file, then we can remove this file in favor of overriding
the provided google_checks.xml file.
> See this issue to track that functionality:
> https://github.com/checkstyle/checkstyle/issues/2873
> -->
>
> <!--
43c73
< <property name="max" value="100"/>
---
> <property name="max" value="140"/>
55c85
< <property name="maxLineLength" value="100"/>
---
> <property name="maxLineLength" value="140"/>
158c188
< <property name="basicOffset" value="2"/>
---
> <property name="basicOffset" value="4"/>
160c190
< <property name="caseIndent" value="2"/>
---
> <property name="caseIndent" value="4"/>
163c193
< <property name="arrayInitIndent" value="2"/>
---
> <property name="arrayInitIndent" value="4"/>
```
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
