Re[2]: checkstyle tool to enforce Sun/Oracle code standard on openJdk
Roman Ivanov
ivanov-jr at mail.ru
Fri Jan 2 06:07:23 UTC 2015
Hi Martijn and others,
It completely clear and very reasonable to have different style's (or slightly different) between projects.
It will be good to star with smth basic or with project that is interested.
All I need from OpenJdk are :
- Provide me link to project code.
- Provide me link to style guide(s) for that prjoect.
- Clearly state that some team would benefit from that work and will use it during some build rutine, and would like to have Checkstyle configuration.
"Code Standard" is a document that written to be followed and not just to have it an show it as smb asked for it.
We need to be sure that we will do smth that will be used and useful.
Code standard should be enforced or do not exists at all. Checkstyle could help to enforce it.
thanks,
Roman Ivanov
Wed, 31 Dec 2014 11:36:22 +0000 от Martijn Verburg <martijnverburg at gmail.com>:
>
> Hi Roman,
>
> I for one would welcome this. A bit of extra information from someone fairly new themselves (I've only ever submitted a few doc patches). Each OpenJDK project (project ~= a part of the source tree) has it's own unofficial style idioms or official style guide. So you may find that for example AWT /2D/Swing has a different set of guidelines than core-libs.
>
> That said I think there's generally a feeling that having something check for style within a project would be welcome and perhaps then there could also be some cross project collaboration. Of course this sort of thing can lead to somewhat frivolous "whitespace changes" type of patches coming in which I think each project will have an opinion on.
>
> Perhaps the best thing to do is to start with one project (e.g. Core libs) and go from there....
>
> CCing in the Adoption group as this sort of style check is something we'd happily host as part of the Betterrev workflow .
>
>
>
>
> Cheers,
> Martijn
> On 30 December 2014 at 01:07, Roman Ivanov < ivanov-jr at mail.ru > wrote:
> >Hi OpenJdk engineers,
> >
> >I am owner of Checkstyle project - http://checkstyle.sourceforge.net/index.html .
> >
> >We had Sun code standard configuration that allow developers
> >write code in the same approach as authors of Java do.
> >But a lot of time passed from time that configuration is
> >introduced, and I am not completely sure that we do complete
> >and accurate in coverage of Sun Java Standard.
> >
> >This year we did complete code coverage for Google's style -
> >http://checkstyle.sourceforge.net/google_style.html
> >
> >Guava team already agreed on fixing problems
> >and updating style guide to be more precise in some requirements -
> >https://github.com/google/guava/issues/1891
> >
> >I have an idea to create similar page for Sun/Oracle style -
> >http://checkstyle.sourceforge.net/sun_style.html
> >
> >Checkstyle already detected a lot of problem in javadoc on openjdk9 (base on change set: 11061:9ade71a206f9 ) -
> >http://checkstyle.sourceforge.net/reports/javadoc/openjdk9/
> >That report contains only problems of Javadoc but it could be as full as report over Guava - http://checkstyle.sourceforge.net/reports/google-style/guava/ .
> >
> >Are you interested in such automatic validation of Sun/Oracle Code Standard ?
> >To let openJDK comply their own code standard :), let automatically validate any contributions to project .
> >
> >thanks,
> >Roman Ivanov
>
Roman Ivanov
More information about the discuss
mailing list