xmlgraphics-general mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Vincent Hennebert <vhenneb...@gmail.com>
Subject Checkstyle, Epilogue
Date Wed, 27 Feb 2013 21:38:49 GMT
Hi All,

An extremely long time ago I proposed on this list [1] a new set of
Checkstyle rules that we would all agree to follow, so that we can
enforce a no warning policy. Glenn expressed disagreements with some of
the rules.

[1] http://markmail.org/thread/wnevlowocmlcm6xa

A very long time ago I had a Skype discussion with Glenn in order to try
and find a common ground; We agreed that, pending some action from my
part, we would settle on a compromise.

A long time ago I undertook that action and submitted my results to
Glenn, who was ok to proceed with the compromise we had found.

So, today, I’d like to propose this compromise to the rest of the
community and ask if everybody is ok with it. Mainly, we keep the rules
about whitespace that I suggested last year, but we introduce an
exception regarding line length: files originally authored by Glenn are
allowed to disable that rule.

The differences with the Checkstyle file currently in FOP are the
following (see [2] for rule descriptions):
• remove SuppressWithNearbyCommentFilter
• remove EqualsHashCode
• remove NoWhiteSpaceAfter for ARRAY_INIT
• add LineLength
• add MethodParamPad
• add ParenPad
• WhiteSpaceAfter: add TYPECAST
• WhiteSpaceAround: remove DIV and STAR

[2] http://checkstyle.sourceforge.net/availablechecks.html

I would also like to add ExplicitInitialization eventually, once I’ve
figured out an automatic way of removing the existing ones.

Some source files (e.g. o.a.f.complexscripts.bidi.BidiClass) were
automatically generated and are not meant to be human-readable,
therefore I will exclude them from the checks.

I’ll apply lazy consensus and, if nobody objects within 3 working days,
I will start to progressively apply the new rules and enable them in
Checkstyle. Then we can modify Gump to automatically run Checkstyle for
us after every commit.


View raw message